Add RangeGenotype permutation options in doc

Author: basvanwesting

src/genotype/range.rs

@@ -797,7 +797,16 @@ where
         writeln!(f, "genotype:")?;
         writeln!(f, "  genes_size: {}", self.genes_size)?;
         writeln!(f, "  mutation_type: {:?}", self.mutation_type)?;
-        writeln!(f, "  chromosome_permutations_size: uncountable")?;
+
+        if let Some(max_scale_index) = self.max_scale_index() {
+            let sizes: Vec<BigUint> = (0..max_scale_index)
+                .map(|scale_index| self.chromosome_permutations_size(Some(scale_index)))
+                .collect();
+            writeln!(f, "  chromosome_permutations_size (per scale): {:?}", sizes)?;
+        } else {
+            writeln!(f, "  chromosome_permutations_size: uncountable")?;
+        }
+
         writeln!(
             f,
             "  neighbouring_population_size: {}",

src/strategy/permutate.rs

@@ -41,6 +41,20 @@ pub enum PermutateVariant {
 /// issues, as the permutations are not instantiated at the same time, just iterated over. But it
 /// will take forever...
 ///
+/// There is a method to permutate
+/// [RangeGenotype](crate::genotype::RangeGenotype) and
+/// [MultiRangeGenotype](crate::genotype::MultiRangeGenotype) chromosomes. Listed in
+/// descending priority:
+/// * With allele_mutation_scaled_range(s) set on genotype:
+///     * First scale (index = 0) traverses the whole allele_range(s) with the upper bound of the
+///     first scale as step size.
+///     * Other scales (index > 0) center around the best chromomsome of the previous scale,
+///     traversing the previous scale bounds around the best chromosome with the upper bound of the
+///     current scale as step size.
+///     * Scale down after grid is full traversed
+/// * With allele_mutation_range(s) set on genotype: Permutation not supported
+/// * With only allele_range(s) set on genotype:  Permutation not supported
+///
 /// There are reporting hooks in the loop receiving the [PermutateState], which can by handled by an
 /// [StrategyReporter] (e.g. [PermutateReporterDuration], [PermutateReporterSimple]). But you are encouraged to
 /// roll your own, see [StrategyReporter].