leaspy.io.realizations.collection_realization.CollectionRealization

class CollectionRealization

Bases: object

Realizations of population and individual parameters.

Methods

clone_realizations()	Deep-copy of self instance.
initialize(n_individuals, model, *[, ...])	Initialize the Collection Realization with a model.
items()	Return all pairs of variable name / realization object.
keys()	Return all variable names.
values()	Return all realization objects.

clone_realizations() → CollectionRealization

Deep-copy of self instance.

In particular the underlying realizations are cloned and detached.

Returns

CollectionRealization

initialize(n_individuals: int, model: AbstractModel, *, skip_variable: Callable[[dict], bool] = None, **realization_init_kws)

Initialize the Collection Realization with a model.

Parameters

n_individualsint

Number of individuals modelled

modelAbstractModel

Model we initialize from

skip_variableNone or function info_variable: dict -> to_skip: bool

An optional function used to skip some of the model variables. e.g. lambda info_var: info_var[‘type’] == ‘population’ will enable to skip all population variables.

**realization_init_kws

Additional keyword arguments passed to Realization.initialize().

items()

Return all pairs of variable name / realization object.

keys()

Return all variable names.

values()

Return all realization objects.