biogeme.latent_variables.normalization_plan module

class biogeme.latent_variables.normalization_plan.ConflictPolicy(*values)[source]

Bases: str, Enum

ERROR = 'error'
IGNORE_SAME = 'ignore_same'
OVERWRITE = 'overwrite'
class biogeme.latent_variables.normalization_plan.Fixing(target, value, note=None)[source]

Bases: object

One explicit parameter fixing.

Parameters:

  • target (ParameterRef) – Semantic parameter reference.

  • value (float) – Numeric value to impose.

  • note (str | None) – Optional human-readable note.

note: str | None
target: ParameterRef
value: float
class biogeme.latent_variables.normalization_plan.NormalizationPlan(fixings=None)[source]

Bases: object

Collection of explicit fixings.

The plan itself does not decide whether a fixing is meaningful for a given model. That responsibility belongs to validation.

Parameters:

fixings (Iterable[Fixing] | None)

add(fixing, *, on_conflict=ConflictPolicy.ERROR)[source]
Return type:

None

Parameters:
as_list()[source]
Return type:

list[Fixing]

get(target)[source]
Return type:

float | None

Parameters:

target (ParameterRef)

get_fixing(target)[source]
Return type:

Fixing | None

Parameters:

target (ParameterRef)

is_fixed(target)[source]
Return type:

bool

Parameters:

target (ParameterRef)