Merge pull request #92 from HyperCodec/dev

Update v0.6.0

Author: HyperCodec

Cargo.lock

@@ -3,7 +3,7 @@ members = ["genetic-rs", "genetic-rs-common", "genetic-rs-macros"]
 resolver = "2"
 
 [workspace.package]
-version = "0.5.4"
+version = "0.6.0"
 authors = ["HyperCodec"]
 homepage = "https://github.com/hypercodec/genetic-rs"
 repository = "https://github.com/hypercodec/genetic-rs"

Cargo.toml

@@ -22,14 +22,14 @@ struct MyGenome {
 
 // required in all of the builtin functions as requirements of `DivsionReproduction` and `CrossoverReproduction`
 impl RandomlyMutable for MyGenome {
-    fn mutate(&mut self, rate: f32, rng: &mut impl rand::Rng) {
+    fn mutate(&mut self, rate: f32, rng: &mut impl Rng) {
         self.field1 += rng.gen::<f32>() * rate;
     }
 }
 
 // required for `division_pruning_nextgen`.
 impl DivsionReproduction for MyGenome {
-    fn divide(&self, rng: &mut impl rand::Rng) -> Self {
+    fn divide(&self, rng: &mut impl ng) -> Self {
         let mut child = self.clone();
         child.mutate(0.25, rng); // use a constant mutation rate when spawning children in pruning algorithms.
         child
@@ -44,7 +44,7 @@ impl Prunable for MyGenome {
     }
 }
 
-// helper trait that allows us to use `Vec::gen_random` for the initial population.
+// allows us to use `Vec::gen_random` for the initial population.
 impl GenerateRandom for MyGenome {
     fn gen_random(rng: &mut impl rand::Rng) -> Self {
         Self { field1: rng.gen() }
@@ -66,11 +66,11 @@ Once you have your reward function, you can create a `GeneticSim` object to mana
 
 ```rust
 fn main() {
-    let mut rng = rand::thread_rng();
+    let mut rng = rand::rng();
     let mut sim = GeneticSim::new(
         // you must provide a random starting population. 
         // size will be preserved in builtin nextgen fns, but it is not required to keep a constant size if you were to build your own nextgen function.
-        // in this case, you do not need to specify a type for `Vec::gen_random` because of the input of `my_fitness_fn`.
+        // in this case, the compiler can infer the type of `Vec::gen_random` because of the input of `my_fitness_fn`.
         Vec::gen_random(&mut rng, 100),
         my_fitness_fn,
         division_pruning_nextgen,

README.md

@@ -18,6 +18,7 @@ crossover = ["builtin"]
 speciation = ["crossover"]
 genrand = []
 rayon = ["dep:rayon"]
+tracing = ["dep:tracing"]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
@@ -27,5 +28,6 @@ rustdoc-args = ["--cfg", "docsrs"]
 
 [dependencies]
 replace_with = "0.1.7"
-rand = "0.8.5"
-rayon = { version = "1.8.0", optional = true }
+rand = "0.9.0"
+rayon = { version = "1.10.0", optional = true }
+tracing = { version = "0.1.41", optional = true }