Merge pull request #75 from HyperCodec/dev

Update 0.5.4

Cargo.toml

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

README.md

@@ -77,10 +77,7 @@ fn main() {
     );
 
     // perform evolution (100 gens)
-    for _ in 0..100 {
-        // there might be some cases where you want to do something between calls.
-        sim.next_generation();
-    }
+    sim.perform_generations(100);
 
     dbg!(sim.genomes);
 }

genetic-rs-common/src/builtin.rs

@@ -392,9 +392,7 @@ mod tests {
             scrambling_nextgen,
         );
 
-        for _ in 0..100 {
-            sim.next_generation();
-        }
+        sim.perform_generations(100);
 
         dbg!(sim.genomes);
     }
@@ -403,9 +401,7 @@ mod tests {
     fn r_scramble() {
         let mut sim = GeneticSim::new(Vec::gen_random(1000), my_fitness_fn, scrambling_nextgen);
 
-        for _ in 0..100 {
-            sim.next_generation();
-        }
+        sim.perform_generations(100);
 
         dbg!(sim.genomes);
     }
@@ -420,9 +416,7 @@ mod tests {
             division_pruning_nextgen,
         );
 
-        for _ in 0..100 {
-            sim.next_generation();
-        }
+        sim.perform_generations(100);
 
         dbg!(sim.genomes);
     }
@@ -438,9 +432,7 @@ mod tests {
             crossover_pruning_nextgen,
         );
 
-        for _ in 0..100 {
-            sim.next_generation();
-        }
+        sim.perform_generations(100);
 
         dbg!(sim.genomes);
     }
@@ -454,9 +446,7 @@ mod tests {
             crossover_pruning_nextgen,
         );
 
-        for _ in 0..100 {
-            sim.next_generation();
-        }
+        sim.perform_generations(100);
 
         dbg!(sim.genomes);
     }
@@ -472,9 +462,7 @@ mod tests {
             speciated_crossover_pruning_nextgen,
         );
 
-        for _ in 0..100 {
-            sim.next_generation();
-        }
+        sim.perform_generations(100);
 
         dbg!(sim.genomes);
     }
@@ -488,9 +476,7 @@ mod tests {
             speciated_crossover_pruning_nextgen,
         );
 
-        for _ in 0..100 {
-            sim.next_generation();
-        }
+        sim.perform_generations(100);
 
         dbg!(sim.genomes);
     }

genetic-rs-common/src/lib.rs

@@ -158,6 +158,13 @@ where
             self.next_gen.next_gen(rewards)
         });
     }
+
+    /// Calls [`next_generation`][GeneticSim::next_generation] `count` number of times.
+    pub fn perform_generations(&mut self, count: usize) {
+        for _ in 0..count {
+            self.next_generation();
+        }
+    }
 }
 
 #[cfg(feature = "rayon")]
@@ -191,6 +198,13 @@ where
             self.next_gen.next_gen(rewards)
         });
     }
+
+    /// Calls [`next_generation`][GeneticSim::next_generation] `count` number of times.
+    pub fn perform_generations(&mut self, count: usize) {
+        for _ in 0..count {
+            self.next_generation();
+        }
+    }
 }
 
 #[cfg(feature = "genrand")]

genetic-rs/examples/crossover.rs

@@ -45,9 +45,7 @@ fn main() {
         crossover_pruning_nextgen,
     );
 
-    for _ in 0..100 {
-        sim.next_generation();
-    }
+    sim.perform_generations(100);
 
     dbg!(sim.genomes, magic_number);
 }

genetic-rs/examples/readme_ex.rs

@@ -57,9 +57,7 @@ fn main() {
     );
 
     // perform evolution (100 gens)
-    for _ in 0..100 {
-        sim.next_generation(); // in a genetic algorithm with state, such as a physics simulation, you'd want to do things with `sim.genomes` in between these calls
-    }
+    sim.perform_generations(100);
 
     dbg!(sim.genomes);
 }

genetic-rs/examples/speciation.rs

@@ -66,9 +66,7 @@ fn main() {
     );
 
     // speciation tends to take more generations (not needed to this extent, but the crate is fast enough to where it isn't much of a compromise)
-    for _ in 0..1000 {
-        sim.next_generation();
-    }
+    sim.perform_generations(100);
 
     dbg!(sim.genomes);
 }