Add remark about RangeGenotype being able to permutate when scaled

Author: basvanwesting

src/genotype.rs

@@ -227,7 +227,7 @@ pub trait HillClimbGenotype: Genotype {
 }
 
 /// Genotype suitable for [Permutate](crate::strategy::permutate::Permutate).
-/// Not all genotypes are permutable, only countable ones (e.g. range genotypes cannot be permutated).
+/// Not all genotypes are permutable, only countable ones (e.g. range genotypes cannot be permutated, unless scaled).
 pub trait PermutateGenotype: Genotype {
     /// chromosome iterator for the all possible gene combinations for [Permutate](crate::strategy::permutate::Permutate)
     fn chromosome_permutations_into_iter<'a>(

src/genotype/dynamic_matrix.rs

@@ -33,7 +33,7 @@ pub type DefaultAllele = f32;
 /// This is a simple heap based example implementation. The size doesn't need to be known up front,
 /// as de storage extend if needed.
 ///
-/// The rest is like [RangeGenotype](super::RangeGenotype):
+/// The rest is like [RangeGenotype](super::RangeGenotype), but it cannot be permutated:
 ///
 /// The values are taken from the allele range. On random initialization, each gene gets a value
 /// from the allele_range with a uniform probability. Each gene has an equal probability of

src/genotype/static_matrix.rs

@@ -29,7 +29,7 @@ use std::ops::{Bound, Range, RangeBounds, RangeInclusive};
 /// [calculate_for_population](crate::fitness::Fitness::calculate_for_population) instead of
 /// [calculate_for_chromosome](crate::fitness::Fitness::calculate_for_chromosome).
 ///
-/// The rest is like [RangeGenotype](super::RangeGenotype):
+/// The rest is like [RangeGenotype](super::RangeGenotype), but it cannot be permutated:
 ///
 /// The values are taken from the allele range. On random initialization, each gene gets a value
 /// from the allele_range with a uniform probability. Each gene has an equal probability of

src/strategy.rs

@@ -23,7 +23,7 @@
 //!   * fallback to `call_par_repeatedly(usize)` for HillClimb
 //!
 //! *Note: Only Genotypes which implement all strategies are eligable for the superset builder.*
-//! *RangeGenotype and other floating point range based genotypes currently do not support Permutation*
+//! *RangeGenotype and other floating point range based genotypes currently do not support Permutation unless scaled*
 //!
 //! Example:
 //! ```

src/strategy/builder.rs

@@ -13,7 +13,7 @@ use crate::strategy::{Strategy, StrategyReporter, StrategyReporterNoop, Strategy
 /// The superset builder for all strategies.
 ///
 /// *Note: Only Genotypes which implement all strategies are eligable for the superset builder.*
-/// *RangeGenotype and other floating point range based genotypes currently do not support Permutation*
+/// *RangeGenotype and other floating point range based genotypes currently do not support Permutation unless scaled*
 #[derive(Clone, Debug)]
 pub struct Builder<
     G: EvolveGenotype + HillClimbGenotype + PermutateGenotype,