chore: update changelog, bump versions (#63)

* chore: bump workspace version

* chore: bump dependencies version

updating rand to 0.9 alpha to fix incompatibility issue sonner rather
than later

* fix: update code using rand to accomodate for breaking changes

* chore: complete changelog

* chore: update examples to match the new rand version

* doc: update current objective

Author: imrn99

CHANGELOG.md

@@ -4,7 +4,75 @@
 
 ## To be released
 
-content from PR #49 / commit ce3948d2e7ccda4e58395ff9e715c946e9b8f744 onward
+...
+
+---
+
+## 0.2.1
+
+### Workspace
+
+- bump `rand` version from `0.8.5` to `0.9.0-alpha.1` & update code accordingly (#63)
+
+### New features
+
+#### honeycomb-core
+
+<sup>core definitions and tools for combinatorial map implementation</sup>
+
+- expand on tests of the core crate (#49)
+- implement the `GridBuilder` struct as a better, more versatile way to generate grid maps (#60)
+
+#### honeycomb-examples
+
+<sup>project examples</sup>
+
+- add the following examples:
+    - `render_squaremap_parameterized` (#60)
+    - `render_squaremap_shift`, based on benchmarking code (#52)
+    - `render_squaremap_split_diff`, based on benchmarking code (#52)
+    - `render_squaremap_split_some`, based on benchmarking code (#52)
+
+#### honeycomb-guide
+
+<sup>**mdbook**-based user guide with information regarding usage & non-code-related
+aspects of the project</sup>
+
+- update usage instructions (#50)
+- add a **References** section to the index (#61)
+
+#### honeycomb-render
+
+<sup>visualization tool for combinatorial maps</sup>
+
+- add code to properly render faces instead of using implicit coloring (#54)
+    - this implied creating new internal structures for efficiency purposes
+- add a cap on the number of frames rendered per second to fix speed disparity induced by machine performance (#56)
+
+### Refactor
+
+#### honeycomb-core
+
+- mark as deprecated:
+    - `AttrSparseVec::get_mut`, `AttrCompactVec::get_mut` (#49)
+    - `utils::square_cmap2`, `utils::splitsquare_cmap2` (#60)
+- fix various `clippy::pedantic` lints that were temporarily left as allowed (#51)
+- fix some unwanted behaviors:
+    - attribute re-insertion in `CMap2::two_unsew` (#55)
+    - not-panicking execution paths of `CMap2::one_sew` & `CMap2::two_sew` (#59)
+
+#### honeycomb-examples
+
+- fix `memory_usage` Rust code and associated script (#55)
+
+#### honeycomb-render
+
+- update render code to:
+    - skip darts and faces that have only one or less vertex defined (#59)
+    - draw proper arrows instead of triangles (#62)
+    - draw beta2 function as diamonds (#62)
+- edit the shader to color triangles according to the entity they form (#62)
+- add a key binding (F1) to close the render window (#62)
 
 ---
 

Cargo.toml

@@ -11,7 +11,7 @@ members = [
 [workspace.package]
 edition = "2021"
 license = "MIT OR Apache-2.0"
-version = "0.2.0"
+version = "0.2.1"
 homepage = "https://lihpc-computational-geometry.github.io/honeycomb/"
 repository = "https://github.com/LIHPC-Computational-Geometry/honeycomb"
 readme = "README.md"
@@ -22,10 +22,10 @@ authors = ["Isaie Muron <[email protected]>", "Cedric Chevalier <cedric.chevali
 
 [workspace.dependencies]
 # members
-honeycomb-benches = { version = "0.2.0", path = "./honeycomb-benches" }
-honeycomb-core = { version = "0.2.0", path = "./honeycomb-core" }
-honeycomb-examples = { version = "0.2.0", path = "./honeycomb-examples" }
-honeycomb-render = { version = "0.2.0", path = "./honeycomb-render" }
+honeycomb-benches = { version = "0.2.1", path = "./honeycomb-benches" }
+honeycomb-core = { version = "0.2.1", path = "./honeycomb-core" }
+honeycomb-examples = { version = "0.2.1", path = "./honeycomb-examples" }
+honeycomb-render = { version = "0.2.1", path = "./honeycomb-render" }
 
 # common
 cfg-if = "1"
@@ -36,7 +36,7 @@ num = "0.4.2"
 # benchmarks
 criterion = "0.5.1"
 iai-callgrind = "0.10.2"
-rand = "0.8.5"
+rand = "0.9.0-alpha.1"
 
 # render
 bytemuck = "1.15.0"

README.md

@@ -11,9 +11,8 @@ combinatorial maps for meshing applications. More specifically, the goal is
 to converge towards a (or multiple) structure(s) adapted to algorithms
 exploiting GPU and many-core architectures.
 
-The current objective is to ~write a first implementation in Rust, to then~
-improve the structure without having to deal with data races and similar
-issues, thanks to the Rust's guarantees.
+The current objective is to implement basic meshing algorithms to evaluate the viability of the implementation & improve
+our structure using Rust's framework to streamline the refactoring and parallelization process.
 
 ## Usage
 

honeycomb-benches/benches/splitsquaremap/shift.rs

@@ -20,7 +20,6 @@ use criterion::{black_box, criterion_group, criterion_main, BenchmarkId, Criteri
 use rand::{
     distributions::{Distribution, Uniform},
     rngs::SmallRng,
-    SeedableRng,
 };
 
 use honeycomb_core::{
@@ -72,7 +71,8 @@ pub fn criterion_benchmark(c: &mut Criterion) {
     let seed: u64 = 9817498146784;
     let mut rngx = SmallRng::seed_from_u64(seed);
     let mut rngy = SmallRng::seed_from_u64(seed);
-    let range: Uniform<FloatType> = Uniform::new(-0.5, 0.5);
+    let range: Uniform<FloatType> =
+        Uniform::new(-0.5, 0.5).expect("Could not initialize the uniform distribution");
     let xs = (0..(N_SQUARE + 1).pow(2)).map(|_| range.sample(&mut rngx));
     let ys = (0..(N_SQUARE + 1).pow(2)).map(|_| range.sample(&mut rngy));
 

honeycomb-benches/benches/squaremap/shift.rs

@@ -20,7 +20,6 @@ use criterion::{black_box, criterion_group, criterion_main, BenchmarkId, Criteri
 use rand::{
     distributions::{Distribution, Uniform},
     rngs::SmallRng,
-    SeedableRng,
 };
 
 use honeycomb_core::{
@@ -72,7 +71,8 @@ pub fn criterion_benchmark(c: &mut Criterion) {
     let seed: u64 = 9817498146784;
     let mut rngx = SmallRng::seed_from_u64(seed);
     let mut rngy = SmallRng::seed_from_u64(seed);
-    let range: Uniform<FloatType> = Uniform::new(-0.5, 0.5);
+    let range: Uniform<FloatType> =
+        Uniform::new(-0.5, 0.5).expect("Could not initialize the uniform distribution");
     let xs = (0..(N_SQUARE + 1).pow(2)).map(|_| range.sample(&mut rngx));
     let ys = (0..(N_SQUARE + 1).pow(2)).map(|_| range.sample(&mut rngy));
 

honeycomb-benches/benches/squaremap/split.rs

@@ -23,7 +23,6 @@ use honeycomb_core::{utils::GridBuilder, CMap2, DartIdentifier, FloatType};
 use rand::{
     distributions::{Bernoulli, Distribution},
     rngs::SmallRng,
-    SeedableRng,
 };
 
 // ------ CONTENT

honeycomb-examples/examples/render/squaremap_shift.rs

@@ -3,7 +3,6 @@ use honeycomb_render::*;
 use rand::{
     distributions::{Distribution, Uniform},
     rngs::SmallRng,
-    SeedableRng,
 };
 use std::time::Instant;
 
@@ -26,7 +25,8 @@ fn main() {
     let seed: u64 = 9817498146784;
     let mut rngx = SmallRng::seed_from_u64(seed);
     let mut rngy = SmallRng::seed_from_u64(seed);
-    let range: Uniform<FloatType> = Uniform::new(-0.5, 0.5);
+    let range: Uniform<FloatType> =
+        Uniform::new(-0.5, 0.5).expect("Could not initialize the uniform distribution");
     let xs = (0..(N_SQUARE + 1).pow(2)).map(|_| range.sample(&mut rngx));
     let ys = (0..(N_SQUARE + 1).pow(2)).map(|_| range.sample(&mut rngy));
     let offsets: Vec<Vector2<FloatType>> = xs.zip(ys).map(|(x, y)| (x, y).into()).collect();

honeycomb-examples/examples/render/squaremap_split_diff.rs

@@ -1,7 +1,7 @@
 use honeycomb_core::{utils::GridBuilder, CMap2, DartIdentifier, FloatType};
 use honeycomb_render::*;
 use rand::distributions::Bernoulli;
-use rand::{distributions::Distribution, rngs::SmallRng, SeedableRng};
+use rand::{distributions::Distribution, rngs::SmallRng};
 use std::time::Instant;
 
 fn main() {

honeycomb-examples/examples/render/squaremap_split_some.rs

@@ -1,7 +1,7 @@
 use honeycomb_core::{utils::GridBuilder, CMap2, DartIdentifier, FloatType};
 use honeycomb_render::*;
 use rand::distributions::Bernoulli;
-use rand::{distributions::Distribution, rngs::SmallRng, SeedableRng};
+use rand::{distributions::Distribution, rngs::SmallRng};
 use std::time::Instant;
 
 fn main() {

honeycomb-guide/src/index.md

@@ -14,8 +14,12 @@ Honeycomb aims to provide a safe, efficient and scalable implementation of combi
 More specifically, the goal is to converge towards a (or multiple) structure(s) adapted to algorithms exploiting GPUs
 and many-core architectures.
 
-The current objective is to ~write a first implementation in Rust, to then~ improve the structure without having to
-deal with data races and similar issues, thanks to the language's guarantees.
+The current objective is to
+
+- ~write a first implementation in Rust~
+- ~improve the structure without having to deal with data races and similar issues, thanks to the Rust's guarantees~
+- implement basic meshing algorithms to evaluate the viability of the implementation & improve our structure using
+  Rust's framework to streamline the refactoring and parallelization process
 
 ### Core Requirements