Add seed_genes cycling in Genotype population_constructor

Author: basvanwesting

src/genotype.rs

@@ -149,15 +149,27 @@ pub trait EvolveGenotype: Genotype {
         population_size: usize,
         rng: &mut R,
     ) -> Population<Self::Chromosome> {
-        Population::new(
-            (0..population_size)
-                .map(|_| {
-                    let mut chromosome = self.chromosome_constructor_random(rng);
-                    chromosome.taint(self.calculate_genes_hash(&chromosome));
-                    chromosome
-                })
-                .collect::<Vec<_>>(),
-        )
+        if self.seed_genes_list().is_empty() {
+            Population::new(
+                (0..population_size)
+                    .map(|_| {
+                        let mut chromosome = self.chromosome_constructor_random(rng);
+                        chromosome.taint(self.calculate_genes_hash(&chromosome));
+                        chromosome
+                    })
+                    .collect::<Vec<_>>(),
+            )
+        } else {
+            Population::new(
+                self.seed_genes_list()
+                    .clone()
+                    .iter()
+                    .cycle()
+                    .take(population_size)
+                    .map(|genes| self.chromosome_constructor_genes(genes))
+                    .collect::<Vec<_>>(),
+            )
+        }
     }
 
     /// Crossover genes between a pair of chromosomes.

src/genotype/builder.rs

@@ -6,9 +6,11 @@ use std::ops::RangeInclusive;
 /// See specfic [Genotype] for used options.
 ///
 /// Shared initialization options for all Genotypes:
-/// * Builder `with_seed_genes_list(Vec<Genotype::Genes>)`, optional, list of start genes of all chromosomes
-///   which are distributed randomly in the population (instead of the default random genes).
-///   Sometimes it is efficient to start with a certain population
+/// * Builder `with_seed_genes_list(Vec<Genotype::Genes>)`, optional, list of start genes for
+///   chromosomes which are cycled into the starting population until the target_population_size is
+///   met (instead of the default random genes). Sometimes it is efficient to start with a certain
+///   population in the Evolve strategy. For the HillClimb strategy a single random seed genes is
+///   taken as the starting point (not cycling through them).
 ///
 /// * Builder `with_genes_hashing(true)`, optional, store a genes_hash on the chromomose (in
 ///   Evolve). This is needed when using `with_fitness_cache` on the strategy as key for the cache.

tests/genotype/binary_test.rs

@@ -387,6 +387,54 @@ fn chromosome_constructor_with_seed_genes_list() {
     );
 }
 
+#[test]
+fn population_constructor_random() {
+    let mut rng = SmallRng::seed_from_u64(0);
+    let mut genotype = BinaryGenotype::builder()
+        .with_genes_size(4)
+        .build()
+        .unwrap();
+    genotype.chromosomes_setup();
+    let population = genotype.population_constructor(5, &mut rng);
+    println!("{:#?}", population.chromosomes);
+    assert_eq!(
+        inspect::population(&population),
+        vec![
+            vec![false, false, true, false],
+            vec![true, true, true, false],
+            vec![false, true, false, true],
+            vec![true, false, true, false],
+            vec![false, false, true, true],
+        ]
+    )
+}
+
+#[test]
+fn population_constructor_with_seed_genes_list() {
+    let mut rng = SmallRng::seed_from_u64(0);
+    let mut genotype = BinaryGenotype::builder()
+        .with_genes_size(4)
+        .with_seed_genes_list(vec![
+            vec![true, true, false, false],
+            vec![false, false, true, true],
+        ])
+        .build()
+        .unwrap();
+    genotype.chromosomes_setup();
+    let population = genotype.population_constructor(5, &mut rng);
+    println!("{:#?}", population.chromosomes);
+    assert_eq!(
+        inspect::population(&population),
+        vec![
+            vec![true, true, false, false],
+            vec![false, false, true, true],
+            vec![true, true, false, false],
+            vec![false, false, true, true],
+            vec![true, true, false, false],
+        ]
+    )
+}
+
 #[test]
 fn chromosome_manager() {
     let rng = &mut SmallRng::seed_from_u64(0);

tests/genotype/dynamic_matrix_test.rs

@@ -468,6 +468,63 @@ fn chromosome_constructor_with_seed_genes_list() {
     ));
 }
 
+#[test]
+fn population_constructor_random() {
+    let mut rng = SmallRng::seed_from_u64(0);
+    let mut genotype = DynamicMatrixGenotype::builder()
+        .with_genes_size(4)
+        .with_allele_range(0.0..=1.0)
+        .build()
+        .unwrap();
+    genotype.chromosomes_setup();
+    let population = genotype.population_constructor(5, &mut rng);
+    println!("{:#?}", population.chromosomes);
+    assert!(relative_population_eq(
+        population
+            .chromosomes
+            .iter()
+            .map(|c| genotype.genes_slice(c).to_vec())
+            .collect(),
+        vec![
+            vec![0.447, 0.439, 0.979, 0.462],
+            vec![0.897, 0.942, 0.588, 0.456],
+            vec![0.395, 0.818, 0.240, 0.976],
+            vec![0.644, 0.054, 0.921, 0.225],
+            vec![0.232, 0.296, 0.787, 0.724],
+        ],
+        0.001
+    ));
+}
+
+#[test]
+fn population_constructor_with_seed_genes_list() {
+    let mut rng = SmallRng::seed_from_u64(0);
+    let mut genotype = DynamicMatrixGenotype::builder()
+        .with_genes_size(4)
+        .with_allele_range(0.0..=1.0)
+        .with_seed_genes_list(vec![vec![0.0, 0.1, 0.2, 0.3], vec![0.4, 0.5, 0.6, 0.7]])
+        .build()
+        .unwrap();
+    genotype.chromosomes_setup();
+    let population = genotype.population_constructor(5, &mut rng);
+    println!("{:#?}", population.chromosomes);
+    assert!(relative_population_eq(
+        population
+            .chromosomes
+            .iter()
+            .map(|c| genotype.genes_slice(c).to_vec())
+            .collect(),
+        vec![
+            vec![0.0, 0.1, 0.2, 0.3],
+            vec![0.4, 0.5, 0.6, 0.7],
+            vec![0.0, 0.1, 0.2, 0.3],
+            vec![0.4, 0.5, 0.6, 0.7],
+            vec![0.0, 0.1, 0.2, 0.3],
+        ],
+        0.001
+    ));
+}
+
 #[test]
 fn chromosome_manager() {
     let rng = &mut SmallRng::seed_from_u64(0);

tests/genotype/static_matrix_test.rs

@@ -473,6 +473,66 @@ fn chromosome_constructor_with_seed_genes_list() {
     ));
 }
 
+#[test]
+fn population_constructor_random() {
+    let mut rng = SmallRng::seed_from_u64(0);
+    let mut genotype = StaticMatrixGenotype::<f32, 4, 5>::builder()
+        .with_genes_size(4)
+        .with_allele_range(0.0..=1.0)
+        .build()
+        .unwrap();
+    genotype.chromosomes_setup();
+    let population = genotype.population_constructor(5, &mut rng);
+    println!("{:#?}", population.chromosomes);
+    assert!(relative_population_eq(
+        population
+            .chromosomes
+            .iter()
+            .map(|c| genotype.genes_slice(c).to_vec())
+            .collect(),
+        vec![
+            vec![0.447, 0.439, 0.979, 0.462],
+            vec![0.897, 0.942, 0.588, 0.456],
+            vec![0.395, 0.818, 0.240, 0.976],
+            vec![0.644, 0.054, 0.921, 0.225],
+            vec![0.232, 0.296, 0.787, 0.724],
+        ],
+        0.001
+    ));
+}
+
+#[test]
+fn population_constructor_with_seed_genes_list() {
+    let mut rng = SmallRng::seed_from_u64(0);
+    let mut genotype = StaticMatrixGenotype::<f32, 4, 5>::builder()
+        .with_genes_size(4)
+        .with_allele_range(0.0..=1.0)
+        .with_seed_genes_list(vec![
+            Box::new([0.0, 0.1, 0.2, 0.3]),
+            Box::new([0.4, 0.5, 0.6, 0.7]),
+        ])
+        .build()
+        .unwrap();
+    genotype.chromosomes_setup();
+    let population = genotype.population_constructor(5, &mut rng);
+    println!("{:#?}", population.chromosomes);
+    assert!(relative_population_eq(
+        population
+            .chromosomes
+            .iter()
+            .map(|c| genotype.genes_slice(c).to_vec())
+            .collect(),
+        vec![
+            vec![0.0, 0.1, 0.2, 0.3],
+            vec![0.4, 0.5, 0.6, 0.7],
+            vec![0.0, 0.1, 0.2, 0.3],
+            vec![0.4, 0.5, 0.6, 0.7],
+            vec![0.0, 0.1, 0.2, 0.3],
+        ],
+        0.001
+    ));
+}
+
 #[test]
 fn chromosome_manager() {
     let rng = &mut SmallRng::seed_from_u64(0);