note use of populations methods for chromosome recycling

Add API impact

Author: basvanwesting

CHANGELOG.md

@@ -48,6 +48,11 @@ these mainly work with the chromosome metadata and are not genotype specific.
 
 General usage by client has little impact, most is internal.
 
+### API Impact
+* Replace `BinaryChromosome` with `Chromosome<bool>`
+* Remove all other `Chromosome` struct genotype specific prefixes (e.g. `ListChromosome<..>` -> `Chromosome<..>`)
+* Use `genetic_algorithm::impl_allele!(CustomAllele);` to implement `Allele` for your CustomAllele
+
 ### Changed
 * Add associated type `Genotype` to `Mutate` and `Crossover` traits (following
   existing `Fitness` pattern).

examples/evolve_scrabble.rs

@@ -1,6 +1,6 @@
 use genetic_algorithm::strategy::evolve::prelude::*;
 use std::collections::{HashMap, HashSet};
-use std::hash::{Hash, Hasher};
+use std::hash::Hash;
 
 type Row = usize;
 type Column = usize;
@@ -13,12 +13,12 @@ pub enum Orientation {
 
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
 pub struct WordPosition(pub Row, pub Column, pub Orientation);
-impl Allele for WordPosition {
-    fn hash_slice(slice: &[Self], hasher: &mut impl Hasher) {
-        slice.hash(hasher);
-    }
-}
-// or genetic_algorithm::impl_allele!(WordPosition)
+genetic_algorithm::impl_allele!(WordPosition);
+// impl Allele for WordPosition {
+//     fn hash_slice(slice: &[Self], hasher: &mut impl Hasher) {
+//         slice.hash(hasher);
+//     }
+// }
 
 #[derive(Clone, Debug)]
 struct ScrabbleFitness {

examples/hill_climb_scrabble.rs

@@ -1,6 +1,6 @@
 use genetic_algorithm::strategy::hill_climb::prelude::*;
 use std::collections::{HashMap, HashSet};
-use std::hash::{Hash, Hasher};
+use std::hash::Hash;
 
 type Row = usize;
 type Column = usize;
@@ -13,12 +13,12 @@ pub enum Orientation {
 
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
 struct WordPosition(pub Row, pub Column, pub Orientation);
-impl Allele for WordPosition {
-    fn hash_slice(slice: &[Self], hasher: &mut impl Hasher) {
-        slice.hash(hasher);
-    }
-}
-// or genetic_algorithm::impl_allele!(WordPosition)
+genetic_algorithm::impl_allele!(WordPosition);
+// impl Allele for WordPosition {
+//     fn hash_slice(slice: &[Self], hasher: &mut impl Hasher) {
+//         slice.hash(hasher);
+//     }
+// }
 
 #[derive(Clone, Debug)]
 struct ScrabbleFitness {

examples/permutate_scrabble.rs

@@ -1,7 +1,7 @@
 use genetic_algorithm::strategy::permutate::prelude::*;
 use num::{BigUint, ToPrimitive};
 use std::collections::{HashMap, HashSet};
-use std::hash::{Hash, Hasher};
+use std::hash::Hash;
 
 type Row = usize;
 type Column = usize;
@@ -14,12 +14,12 @@ pub enum Orientation {
 
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
 pub struct WordPosition(pub Row, pub Column, pub Orientation);
-impl Allele for WordPosition {
-    fn hash_slice(slice: &[Self], hasher: &mut impl Hasher) {
-        slice.hash(hasher);
-    }
-}
-// or genetic_algorithm::impl_allele!(WordPosition)
+genetic_algorithm::impl_allele!(WordPosition);
+// impl Allele for WordPosition {
+//     fn hash_slice(slice: &[Self], hasher: &mut impl Hasher) {
+//         slice.hash(hasher);
+//     }
+// }
 
 #[derive(Clone, Debug)]
 struct ScrabbleFitness {

src/crossover.rs

@@ -78,6 +78,7 @@ pub type CrossoverEvolveState<C> = EvolveState<<C as Crossover>::Genotype>;
 ///             (existing_population_size as f32 * self.selection_rate).ceil() as usize;
 ///
 ///         // Important!!! Append offspring as recycled clones from parents (will crossover later)
+///         // Use population's methods for safe chromosome recycling
 ///         state.population.extend_from_within(selected_population_size);
 ///
 ///         // Skip the parents, iterate over the freshly appended offspring