refactor!: remove items marked as deprecated in 0.2.1 (#64)

* refactor: remove deprecated utils functions

* refactor: remove get_mut methods of the respective attribute storage

* refactor: update UG & add utils feature to the doc CI

* doc: clarify doc & remove mention of single_precision

Author: imrn99

.github/workflows/doc.yml

@@ -30,8 +30,8 @@ jobs:
       - name: Generate User Guide
         run: mdbook build -d ../target/doc/ honeycomb-guide/
       - name: Generate Rust Docs
-        run: cargo doc --all --no-deps
-        
+        run: cargo doc --all --no-deps --features utils
+
       - name: Deploy Docs
         uses: peaceiris/actions-gh-pages@v3
         with:

honeycomb-core/src/attributes/collections.rs

@@ -89,27 +89,6 @@ impl<T: AttributeBind + AttributeUpdate> AttrSparseVec<T> {
         &self.data[index.to_usize().unwrap()]
     }
 
-    /// Getter
-    ///
-    /// # Arguments
-    ///
-    /// - `index: T::IdentifierType` -- Cell index.
-    ///
-    /// # Return
-    ///
-    /// Return a mutable reference to the value indexed by `index`.
-    ///
-    /// # Panics
-    ///
-    /// The method may panic if:
-    /// - the index lands out of bounds
-    /// - the index cannot be converted to `usize`
-    ///
-    #[deprecated]
-    pub fn get_mut(&mut self, index: &T::IdentifierType) -> &mut Option<T> {
-        &mut self.data[index.to_usize().unwrap()]
-    }
-
     /// Setter
     ///
     /// Set the value of an element at a given index.
@@ -314,28 +293,6 @@ impl<T: AttributeBind + AttributeUpdate + Clone> AttrCompactVec<T> {
         self.index_map[index.to_usize().unwrap()].map(|idx| &self.data[idx])
     }
 
-    /// Getter
-    ///
-    /// # Arguments
-    ///
-    /// - `index: T::IdentifierType` -- Cell index.
-    ///
-    /// # Return
-    ///
-    /// Return an `Option` that may contain a mutable reference to the value associated to `index`,
-    /// if it exists.
-    ///
-    /// # Panics
-    ///
-    /// The method may panic if:
-    /// - the index lands out of bounds
-    /// - the index cannot be converted to `usize`
-    ///
-    #[deprecated]
-    pub fn get_mut(&mut self, index: &T::IdentifierType) -> Option<&mut T> {
-        self.index_map[index.to_usize().unwrap()].map(|idx| &mut self.data[idx])
-    }
-
     /// Setter
     ///
     /// Set the value of an element at a given index.

honeycomb-core/src/lib.rs

@@ -3,15 +3,17 @@
 //! This crate implements all basic structure and methods for
 //! 2D and 3D combinatorial map modeling.
 //!
-//! This documentation focus on the implementation side of things
-//! and API usage, for more formal information about combinatorial
-//! maps, refer to the **Definitions** section of the user guide.
+//! This documentation focus on the implementation side of things and API usage, for more
+//! formal information about combinatorial maps, refer to the **Definitions** section of
+//! the [user guide][UG].
+//!
+//! [UG]:https://lihpc-computational-geometry.github.io/honeycomb/
 //!
 //! ## Features
 //!
 //! Optional features can be enabled when compiling this crate:
 //!
-//! - `utils` -- provides additionnal methods for benchmarking and debugging
+//! - `utils` -- provides additionnal implementations for map generation, benchmarking & debugging
 //! - `single_precision` -- uses `f32` instead of `f64` for coordinates representation in tests
 
 // ------ CUSTOM LINTS

honeycomb-core/src/utils/generation.rs

@@ -513,38 +513,6 @@ impl<T: CoordsFloat> GridBuilder<T> {
     }
 }
 
-/// Generate a [`CMap2`] representing a mesh made up of squares.
-///
-/// <div class="warning">
-///
-/// **This function is deprecated, please use [`GridBuilder::unit_squares`] instead.**
-///
-/// </div>
-///
-/// This function builds and returns a 2-map representing a square mesh
-/// made of `n_square * n_square` square cells.
-#[deprecated(note = "please use the `GridBuilder::unit_squares` function instead")]
-#[must_use = "constructed object is not used, consider removing this function call"]
-pub fn square_cmap2<T: CoordsFloat>(n_square: usize) -> CMap2<T> {
-    build2_grid([n_square, n_square], [T::one(), T::one()])
-}
-
-/// Generate a [`CMap2`] representing a mesh made up of squares split diagonally.
-///
-/// <div class="warning">
-///
-/// **This function is deprecated, please use [`GridBuilder::unit_squares`] instead.**
-///
-/// </div>
-///
-/// This function builds and returns a 2-map representing a square mesh
-/// made of `n_square * n_square * 2` triangle cells.
-#[deprecated(note = "please use the `GridBuilder::split_unit_squares` function instead")]
-#[must_use = "constructed object is not used, consider removing this function call"]
-pub fn splitsquare_cmap2<T: CoordsFloat>(n_square: usize) -> CMap2<T> {
-    build2_splitgrid([n_square, n_square], [T::one(), T::one()])
-}
-
 // ------ TESTS
 
 #[cfg(test)]

honeycomb-core/src/utils/mod.rs

@@ -15,5 +15,4 @@ mod generation;
 
 // ------ PUBLIC RE-EXPORTS
 
-#[allow(deprecated)]
-pub use generation::{splitsquare_cmap2, square_cmap2, GridBuilder};
+pub use generation::GridBuilder;

honeycomb-guide/src/project-structure/honeycomb-core.md

@@ -14,6 +14,7 @@ A quickstart example encompassing most features is provided for the following st
 - [CMap2](../honeycomb_core/struct.CMap2.html#example)
 - [Vector2](../honeycomb_core/struct.Vector2.html#example)
 - [Vertex2](../honeycomb_core/struct.Vertex2.html#example)
+- [GridBuilder](../honeycomb_core/utils/struct.GridBuilder.html#example)
 
 ## Content
 
@@ -24,3 +25,7 @@ following:
 - **Orbit2**: Generic 2D implementation for orbit computation
 - **Vector2**: 2D vector representation
 - **Vertex2**: 2D vertex representation
+
+Note that optional features can be enabled when compiling this crate:
+
+- `utils` -- provides additionnal implementations for map generation, benchmarking & debugging