Source code for pygenalgo.operators.crossover.crossover_operator

from pygenalgo.genome.chromosome import Chromosome
from pygenalgo.operators.genetic_operator import GeneticOperator




class CrossoverOperator(GeneticOperator):
    """
    Description:

        Provides the base class (interface) for a Crossover Operator.
    """

    def __init__(self, crossover_probability: float) -> None:
        """
        Construct a 'CrossoverOperator' object with a
        given probability value.

        :param crossover_probability: (float).
        """

        # Call the super constructor with the provided
        # probability value.
        super().__init__(crossover_probability)
    # _end_def_



    def crossover(self, parent1: Chromosome, parent2: Chromosome) -> tuple[Chromosome, Chromosome]:
        """
        Abstract method that "reminds" the user that if they want to
        create a Crossover Class that inherits from here they should
        implement a crossover method.

        :param parent1: (Chromosome).

        :param parent2: (Chromosome).

        :return: Nothing but raising an error.
        """
        raise NotImplementedError(f"{self.__class__.__name__}: "
                                  f"You should implement this method!")

    # _end_def_

    def __call__(self, *args, **kwargs):
        """
        This is only a wrapper of the "crossover" method.
        """
        return self.crossover(*args, **kwargs)

    # _end_def_

# _end_class_