radiate-alters 1.2.22

use radiate_core::{
    AlterContext, AlterResult, BoundedGene, Chromosome, Crossover, Gene, Rate, Valid,
    random_provider,
};
use radiate_utils::{Float, Primitive};

/// The [BlendCrossover] is a crossover operator that blends [FloatGene] alleles from two parent chromosomes to create offspring.
/// The blending is controlled by the `alpha` parameter, which determines the extent of blending between the two alleles.
/// The formula used for blending is:
///
/// ```text
/// new_allele_one = allele_one - (alpha * (allele_two - allele_one))
/// new_allele_two = allele_two - (alpha * (allele_one - allele_two))
/// ```
#[derive(Debug, Clone, PartialEq)]
pub struct BlendCrossover {
    rate: Rate,
    alpha: f32,
}

impl BlendCrossover {
    /// Create a new instance of the [BlendCrossover] with the given rate and alpha.
    /// The rate must be between 0.0 and 1.0, and the alpha must be between 0.0 and 1.0.
    pub fn new(rate: impl Into<Rate>, alpha: f32) -> Self {
        let rate = rate.into();
        if !rate.is_valid() {
            panic!("Rate is not valid");
        }

        if !(0.0..=1.0).contains(&alpha) {
            panic!("Alpha must be between 0 and 1");
        }

        BlendCrossover { rate, alpha }
    }
}

impl<A, G, C> Crossover<C> for BlendCrossover
where
    A: Primitive + Float,
    G: Gene<Allele = A> + BoundedGene,
    C: Chromosome<Gene = G>,
{
    fn rate(&self) -> Rate {
        self.rate.clone()
    }

    #[inline]
    fn cross_chromosomes(
        &self,
        chrom_one: &mut C,
        chrom_two: &mut C,
        ctx: &mut AlterContext,
    ) -> AlterResult {
        let mut cross_count = 0;
        let alpha = A::from(self.alpha).unwrap();

        random_provider::with_rng(|rand| {
            for (one, two) in chrom_one.zip_mut(chrom_two) {
                if rand.bool(ctx.rate()) {
                    let allele_one = one.allele().clone();
                    let allele_two = two.allele().clone();

                    let new_allele_one = allele_one - (alpha * (allele_two - allele_one));
                    let new_allele_two = allele_two - (alpha * (allele_one - allele_two));

                    let (one_min, one_max) = one.bounds();
                    let (two_min, two_max) = two.bounds();

                    *one.allele_mut() = new_allele_one.clamp(*one_min, *one_max);
                    *two.allele_mut() = new_allele_two.clamp(*two_min, *two_max);

                    cross_count += 1;
                }
            }
        });

        cross_count.into()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use radiate_core::{FloatChromosome, FloatGene, MetricSet};

    #[test]
    fn test_cross_chromosomes_basic() {
        let crossover = BlendCrossover::new(1.0, 0.5);

        let genes1 = vec![
            FloatGene::new(1.0, 0.0..10.0, -10.0..10.0),
            FloatGene::new(2.0, 0.0..10.0, -10.0..10.0),
            FloatGene::new(3.0, 0.0..10.0, -10.0..10.0),
        ];
        let genes2 = vec![
            FloatGene::new(4.0, 0.0..10.0, -10.0..10.0),
            FloatGene::new(5.0, 0.0..10.0, -10.0..10.0),
            FloatGene::new(6.0, 0.0..10.0, -10.0..10.0),
        ];

        let mut chrom_one = FloatChromosome::new(genes1);
        let mut chrom_two = FloatChromosome::new(genes2);

        let original_one: Vec<f32> = chrom_one.iter().map(|g| *g.allele()).collect();
        let original_two: Vec<f32> = chrom_two.iter().map(|g| *g.allele()).collect();

        let mut metrics = MetricSet::default();
        let mut lineage = radiate_core::lineage::Lineage::default();
        let mut ctx = AlterContext::new("TestOperation", &mut metrics, &mut lineage, 0, 1.0);

        let result = crossover.cross_chromosomes(&mut chrom_one, &mut chrom_two, &mut ctx);

        assert_eq!(result.count(), 3);

        // Check that values have been blended according to the formula
        // new_allele_one = allele_one - (alpha * (allele_two - allele_one))
        // new_allele_two = allele_two - (alpha * (allele_one - allele_two))
        let alpha = 0.5;

        for i in 0..chrom_one.len() {
            let expected_one = original_one[i] - (alpha * (original_two[i] - original_one[i]));
            let expected_two = original_two[i] - (alpha * (original_one[i] - original_two[i]));

            assert!((chrom_one.get(i).allele() - expected_one).abs() < 1e-6);
            assert!((chrom_two.get(i).allele() - expected_two).abs() < 1e-6);
        }
    }

    #[test]
    fn test_cross_chromosomes_zero_rate() {
        let crossover = BlendCrossover::new(0.0, 0.5);

        let genes1 = vec![
            FloatGene::new(1.0, 0.0..10.0, 0.0..10.0),
            FloatGene::new(2.0, 0.0..10.0, 0.0..10.0),
        ];
        let genes2 = vec![
            FloatGene::new(4.0, 0.0..10.0, 0.0..10.0),
            FloatGene::new(5.0, 0.0..10.0, 0.0..10.0),
        ];

        let mut chrom_one = FloatChromosome::new(genes1);
        let mut chrom_two = FloatChromosome::new(genes2);

        let original_one: Vec<f32> = chrom_one.iter().map(|g| *g.allele()).collect();
        let original_two: Vec<f32> = chrom_two.iter().map(|g| *g.allele()).collect();

        let mut metrics = MetricSet::default();
        let mut lineage = radiate_core::lineage::Lineage::default();
        let mut ctx = AlterContext::new("TestOperation", &mut metrics, &mut lineage, 0, 0.0);

        let result = crossover.cross_chromosomes(&mut chrom_one, &mut chrom_two, &mut ctx);

        assert_eq!(result.count(), 0);

        // Values should remain unchanged
        for i in 0..chrom_one.len() {
            assert_eq!(*chrom_one.get(i).allele(), original_one[i]);
            assert_eq!(*chrom_two.get(i).allele(), original_two[i]);
        }
    }

    #[test]
    fn test_cross_chromosomes_different_lengths() {
        let crossover = BlendCrossover::new(1.0, 0.3);

        let genes1 = vec![
            FloatGene::new(1.0, 0.0..10.0, 0.0..10.0),
            FloatGene::new(2.0, 0.0..10.0, 0.0..10.0),
            FloatGene::new(3.0, 0.0..10.0, 0.0..10.0),
        ];
        let genes2 = vec![
            FloatGene::new(4.0, 0.0..10.0, 0.0..10.0),
            FloatGene::new(5.0, 0.0..10.0, 0.0..10.0),
        ];

        let mut chrom_one = FloatChromosome::new(genes1);
        let mut chrom_two = FloatChromosome::new(genes2);

        let mut metrics = MetricSet::default();
        let mut lineage = radiate_core::lineage::Lineage::default();
        let mut ctx = AlterContext::new("TestOperation", &mut metrics, &mut lineage, 0, 1.0);

        let result = crossover.cross_chromosomes(&mut chrom_one, &mut chrom_two, &mut ctx);

        assert_eq!(result.count(), 2);

        let alpha = 0.3;
        let expected_one_0 = 1.0 - (alpha * (4.0 - 1.0));
        let expected_two_0 = 4.0 - (alpha * (1.0 - 4.0));
        let expected_one_1 = 2.0 - (alpha * (5.0 - 2.0));
        let expected_two_1 = 5.0 - (alpha * (2.0 - 5.0));

        assert!(
            (chrom_one.get(0).allele().extract::<f32>().unwrap() - expected_one_0).abs() < 1e-6
        );
        assert!(
            (chrom_two.get(0).allele().extract::<f32>().unwrap() - expected_two_0).abs() < 1e-6
        );
        assert!(
            (chrom_one.get(1).allele().extract::<f32>().unwrap() - expected_one_1).abs() < 1e-6
        );
        assert!(
            (chrom_two.get(1).allele().extract::<f32>().unwrap() - expected_two_1).abs() < 1e-6
        );

        assert_eq!(*chrom_one.get(2).allele(), 3.0);
    }

    #[test]
    fn test_cross_chromosomes_alpha_zero() {
        let crossover = BlendCrossover::new(1.0, 0.0);

        let genes1 = vec![
            FloatGene::new(1.0, 0.0..10.0, 0.0..10.0),
            FloatGene::new(2.0, 0.0..10.0, 0.0..10.0),
        ];
        let genes2 = vec![
            FloatGene::new(4.0, 0.0..10.0, 0.0..10.0),
            FloatGene::new(5.0, 0.0..10.0, 0.0..10.0),
        ];

        let mut chrom_one = FloatChromosome::new(genes1);
        let mut chrom_two = FloatChromosome::new(genes2);

        let original_one: Vec<f32> = chrom_one.iter().map(|g| *g.allele()).collect();
        let original_two: Vec<f32> = chrom_two.iter().map(|g| *g.allele()).collect();

        let mut metrics = MetricSet::default();
        let mut lineage = radiate_core::lineage::Lineage::default();
        let mut ctx = AlterContext::new("TestOperation", &mut metrics, &mut lineage, 0, 1.0);

        let result = crossover.cross_chromosomes(&mut chrom_one, &mut chrom_two, &mut ctx);

        assert_eq!(result.count(), 2);

        // With alpha = 0, values should remain unchanged
        for i in 0..chrom_one.len() {
            assert_eq!(*chrom_one.get(i).allele(), original_one[i]);
            assert_eq!(*chrom_two.get(i).allele(), original_two[i]);
        }
    }

    #[test]
    fn test_cross_chromosomes_alpha_one() {
        let crossover = BlendCrossover::new(1.0, 1.0);

        let genes1 = vec![
            FloatGene::new(1.0, 0.0..10.0, -10.0..10.0),
            FloatGene::new(2.0, 0.0..10.0, -10.0..10.0),
        ];
        let genes2 = vec![
            FloatGene::new(4.0, 0.0..10.0, -10.0..10.0),
            FloatGene::new(5.0, 0.0..10.0, -10.0..10.0),
        ];

        let mut chrom_one = FloatChromosome::new(genes1);
        let mut chrom_two = FloatChromosome::new(genes2);

        let mut metrics = MetricSet::default();
        let mut lineage = radiate_core::lineage::Lineage::default();
        let mut ctx = AlterContext::new("TestOperation", &mut metrics, &mut lineage, 0, 1.0);

        let result = crossover.cross_chromosomes(&mut chrom_one, &mut chrom_two, &mut ctx);

        assert_eq!(result.count(), 2);

        // With alpha = 1, values should be swapped
        assert_eq!(*chrom_one.get(0).allele(), -2.0);
        assert_eq!(*chrom_two.get(0).allele(), 7.0);
        assert_eq!(*chrom_one.get(1).allele(), -1.0);
        assert_eq!(*chrom_two.get(1).allele(), 8.0);
    }

    #[test]
    fn test_cross_chromosomes_identical_parents() {
        let crossover = BlendCrossover::new(1.0, 0.5);

        let genes = vec![
            FloatGene::new(1.0, 0.0..10.0, 0.0..10.0),
            FloatGene::new(2.0, 0.0..10.0, 0.0..10.0),
        ];

        let mut chrom_one = FloatChromosome::new(genes.clone());
        let mut chrom_two = FloatChromosome::new(genes);

        let mut metrics = MetricSet::default();
        let mut lineage = radiate_core::lineage::Lineage::default();
        let mut ctx = AlterContext::new("TestOperation", &mut metrics, &mut lineage, 0, 1.0);

        let result = crossover.cross_chromosomes(&mut chrom_one, &mut chrom_two, &mut ctx);

        assert_eq!(result.count(), 2);

        // With identical parents, values should remain the same
        for i in 0..chrom_one.len() {
            assert_eq!(*chrom_one.get(i).allele(), *chrom_two.get(i).allele());
        }
    }

    #[test]
    fn test_cross_chromosomes_property_based() {
        let crossover = BlendCrossover::new(1.0, 0.5);

        for _ in 0..50 {
            let genes1: Vec<FloatGene<f32>> = (0..5)
                .map(|_| {
                    FloatGene::new(
                        random_provider::random::<f32>() * 10.0,
                        0.0..10.0,
                        -10.0..10.0,
                    )
                })
                .collect();
            let genes2: Vec<FloatGene<f32>> = (0..5)
                .map(|_| {
                    FloatGene::new(
                        random_provider::random::<f32>() * 10.0,
                        0.0..10.0,
                        -10.0..10.0,
                    )
                })
                .collect();

            let mut chrom_one = FloatChromosome::new(genes1);
            let mut chrom_two = FloatChromosome::new(genes2);

            let original_one: Vec<f32> = chrom_one.iter().map(|g| *g.allele()).collect();
            let original_two: Vec<f32> = chrom_two.iter().map(|g| *g.allele()).collect();

            let mut metrics = MetricSet::default();
            let mut lineage = radiate_core::lineage::Lineage::default();
            let mut ctx = AlterContext::new("TestOperation", &mut metrics, &mut lineage, 0, 1.0);

            let result = crossover.cross_chromosomes(&mut chrom_one, &mut chrom_two, &mut ctx);

            assert_eq!(result.count(), 5);

            let alpha = 0.5;
            for i in 0..chrom_one.len() {
                let expected_one = original_one[i] - (alpha * (original_two[i] - original_one[i]));
                let expected_two = original_two[i] - (alpha * (original_one[i] - original_two[i]));

                let gene_one = chrom_one.get(i);
                let gene_two = chrom_two.get(i);

                if expected_one < *gene_one.bounds().0 || expected_one > *gene_one.bounds().1 {
                    assert!(*gene_one.allele() >= *gene_one.bounds().0);
                    assert!(*gene_one.allele() <= *gene_one.bounds().1);
                } else {
                    assert!((gene_one.allele() - expected_one).abs() < 1e-6);
                }

                if expected_two < *gene_two.bounds().0 || expected_two > *gene_two.bounds().1 {
                    assert!(*gene_two.allele() >= *gene_two.bounds().0);
                    assert!(*gene_two.allele() <= *gene_two.bounds().1);
                } else {
                    assert!((gene_two.allele() - expected_two).abs() < 1e-6);
                }
            }
        }
    }

    #[test]
    fn test_cross_chromosomes_edge_cases() {
        let crossover = BlendCrossover::new(1.0, 0.5);

        // Test with single gene chromosomes
        let genes1 = vec![FloatGene::new(1.0, 0.0..10.0, 0.0..10.0)];
        let genes2 = vec![FloatGene::new(4.0, 0.0..10.0, 0.0..10.0)];

        let mut chrom_one = FloatChromosome::new(genes1);
        let mut chrom_two = FloatChromosome::new(genes2);

        let mut metrics = MetricSet::default();
        let mut lineage = radiate_core::lineage::Lineage::default();
        let mut ctx = AlterContext::new("TestOperation", &mut metrics, &mut lineage, 0, 1.0);

        let result = crossover.cross_chromosomes(&mut chrom_one, &mut chrom_two, &mut ctx);

        assert_eq!(result.count(), 1);

        // Test with empty chromosomes (should not panic)
        let mut empty_one = FloatChromosome::<f32>::new(vec![]);
        let mut empty_two = FloatChromosome::<f32>::new(vec![]);

        let result = crossover.cross_chromosomes(&mut empty_one, &mut empty_two, &mut ctx);
        assert_eq!(result.count(), 0);
    }

    #[test]
    fn test_blend_formula_verification() {
        let crossover = BlendCrossover::new(1.0, 0.3);
        let alpha = 0.3;

        // Test specific values to verify the blending formula
        let genes1 = vec![FloatGene::new(2.0, 0.0..10.0, 0.0..10.0)];
        let genes2 = vec![FloatGene::new(8.0, 0.0..10.0, 0.0..10.0)];

        let mut chrom_one = FloatChromosome::<f32>::new(genes1);
        let mut chrom_two = FloatChromosome::<f32>::new(genes2);

        let mut metrics = MetricSet::default();
        let mut lineage = radiate_core::lineage::Lineage::default();
        let mut ctx = AlterContext::new("TestOperation", &mut metrics, &mut lineage, 0, 1.0);

        crossover.cross_chromosomes(&mut chrom_one, &mut chrom_two, &mut ctx);

        // Manual calculation: allele_one = 2.0, allele_two = 8.0, alpha = 0.3
        // new_allele_one = 2.0 - (0.3 * (8.0 - 2.0)) = 2.0 - (0.3 * 6.0) = 2.0 - 1.8 = 0.2
        // new_allele_two = 8.0 - (0.3 * (2.0 - 8.0)) = 8.0 - (0.3 * -6.0) = 8.0 + 1.8 = 9.8
        let expected_one = 2.0 - (alpha * (8.0 - 2.0));
        let expected_two = 8.0 - (alpha * (2.0 - 8.0));

        assert!((chrom_one.get(0).allele() - expected_one).abs() < 1e-6);
        assert!((chrom_two.get(0).allele() - expected_two).abs() < 1e-6);
    }
}