stk.RemoveBatches

class stk.RemoveBatches(remover, selector)

Bases: Selector[T]

Prevents a Selector from selecting some batches.

Examples

Removing Batches From Selection

You want to use Roulette selection on all but the 5 Worst batches

import stk

selector = stk.RemoveBatches(
    remover=stk.Worst(5),
    selector=stk.Roulette(20),
)
population = {
    stk.MoleculeRecord(
        topology_graph=stk.polymer.Linear(
            building_blocks=[
                stk.BuildingBlock('BrCCBr', stk.BromoFactory()),
            ],
            repeating_unit='A',
            num_repeating_units=2,
        ),
    ): i
    for i in range(100)
}
for batch in selector.select(population):
    # Do stuff with batch. It was selected with roulette
    # selection and is not one of the worst 5 batches.
    pass

Parameters:

• remover (Selector[T]) – Selector Selects batches of molecules, which cannot be yielded by selector.

• selector (Selector[T]) – Selector Selects batches of molecules, except those selected by remover.

Methods

select

Yield batches of molecule records from population.

select(population, included_batches=None, excluded_batches=None)

Yield batches of molecule records from population.

Parameters:

• population (dict[T, float]) – A collection of molecules from which batches are selected.

• included_batches (set[BatchKey] | None) – The identity keys of batches which are allowed to be yielded, if None all batches can be yielded. If not None only batches included_batches will be yielded.

• excluded_batches (set[BatchKey] | None) – The identity keys of batches which are not allowed to be yielded. If None, no batch is forbidden from being yielded.

Yields:

A batch of selected molecule records.

Return type:

Iterator[Batch[T]]