stk.MutationRecord

class stk.MutationRecord(molecule_record, mutator_name)[source]

Bases: Generic[T]

Abstract base class for a record of a mutation operation.

Notes

You might notice that the public methods of this abstract base class are implemented. This is just a default implementation, which can be used directly by users and subclasses, but can also be freely replaced during subclass implementation, if need be.

Parameters:

molecule_record (T) – The molecule produced by the mutation operation.
mutator_name (str) – The name of the mutator which carried out the mutator.

Methods

`get_molecule_record`	Get the molecule record produced by the mutation.
`get_mutator_name`	Get the name of the mutator which carried out the mutation.

get_molecule_record()[source]

Get the molecule record produced by the mutation.

Returns:: The molecule record.
Return type:: T

get_mutator_name()[source]

Get the name of the mutator which carried out the mutation.

Returns:: The name of the mutator.
Return type:: str