GenDropRanks

class GenDropRanks

Functor to implement the recency-proportional resolution stratum retention policy, for use with HereditaryStratigraphicColumn.

This functor enacts the recency-proportional resolution policy by specifying the set of strata ranks that should be purged from a hereditary stratigraphic column when the nth stratum is deposited.

__init__(policy_spec: PolicySpec | None) → None

Methods

__call__(policy: PolicyCouplerBase, num_stratum_depositions_completed: int, retained_ranks: Iterable[int] | None) → Iterator[int]

Decide which strata within the stratagraphic column should be purged.

Every time a new stratum is deposited, this method is called to determine which strata should be purged. All strata at ranks yielded from this functor are immediately purged from the column, meaning that for a stratum to persist it must not be yielded by this functor each and every time a new stratum is deposited.

Parameters

policy: Policy

Policy this functor enacts.

num_stratum_depositions_completedint

The number of strata that have already been deposited, not including the latest stratum being deposited which prompted the current purge operation.

retained_ranksiterator over int

An iterator over ranks of strata currently retained within the hereditary stratigraphic column. Not used in this functor.

Returns

iterator over int

The ranks of strata that should be purged from the hereditary stratigraphic column at this deposition step.

See Also

recency_proportional_resolution_curbed_algo:

For details on the rationale, implementation, and guarantees of the recency-proportional resolution stratum retention policy.

__init__(policy_spec: PolicySpec | None) → None