Source code for stk.ea.generation

"""
Generation
==========

"""


[docs]class Generation: """ An abstract base class for EA generations. Notes ----- You might notice that the public methods of this abstract base class are implemented. This is just a default implementation, which you can ignore or override when implementing subclasses. """
[docs] def __init__( self, molecule_records, mutation_records, crossover_records, ): """ Initialize a :class:`.Generation` instance. Parameters ---------- molecule_records : :class:`tuple` of \ :class:`.MoleculeRecord` The records of molecules in the generation. mutation_records : :class:`tuple` of \ :class:`.MutationRecord` The records of mutations done during the generation. crossover_records : :class:`tuple` of \ :class:`.CrossoverRecord` The records of crossover operations done during the generation. """ self._molecule_records = molecule_records self._mutation_records = mutation_records self._crossover_records = crossover_records
[docs] def get_molecule_records(self): """ Yield the molecule records in the generation. Yields ------ :class:`.MoleculeRecord` A molecule record. """ yield from self._molecule_records
[docs] def get_mutation_records(self): """ Yield the mutation records in the generation. Yields ------ :class:`.MutationRecord` A mutation record. """ yield from self._mutation_records
[docs] def get_crossover_records(self): """ Yield the crossover records in the generation. Yields ------ :class:`.CrossoverRecord` A crossover record. """ yield from self._crossover_records