iode.Simulation.initialization_method

property Simulation.initialization_method: str

At the start of each period to be simulated, a starting value must be chosen for each endogenous variable. This value can be :

  • \(Y := Y[-1], if Y null or NA\) (TM1) : each null or NA endogen at the start takes the value of the previous period,

  • \(Y := Y[-1], always\) (TM1_A) : each endogen takes the value of the previous period at the start,

  • \(Y := extrapolation, if Y null or NA\) (EXTRA) : each null or NA endogen takes as value a linear extrapolation of the two previous periods,

  • \(Y := extrapolation, always\) (EXTRA_A) : each endogen takes as its value a linear extrapolation of the two preceding periods, whether or not it is zero at the start,

  • \(Y unchanged\) (ASIS): endogenous values are not initialized. They retain their value whether or not they are zero,

  • \(Y := Y[-1], if Y = NA\) (TM1_NA): each NA value takes the value of the previous period,

  • \(Y := extrapolation, if Y = NA\) (EXTRA_NA): each NA value takes the value of a linear extrapolation of the two previous periods.

Parameters:
value: SimulationInitialization or str
initialization method. Possible values are:

  • TM1: \(Y := Y[-1], if Y null or NA\)

  • TM1_A: \(Y := Y[-1], always\)

  • EXTRA: \(Y := extrapolation, if Y null or NA\)

  • EXTRA_A: \(Y := extrapolation, always\)

  • ASIS: \(Y unchanged\)

  • TM1_NA: \(Y := Y[-1], if Y = NA\)

  • EXTRA_NA: \(Y := extrapolation, if Y = NA\)

Examples

>>> from iode import Simulation, SimulationInitialization
>>> simu = Simulation()
>>> # default value
>>> simu.initialization_method
'TM1'

>>> simu.initialization_method = "TM1"
>>> simu.initialization_method
'TM1'
>>> simu.initialization_method = SimulationInitialization.TM1
>>> simu.initialization_method
'TM1'

>>> simu.initialization_method = "TM1_A"
>>> simu.initialization_method
'TM1_A'
>>> simu.initialization_method = SimulationInitialization.TM1_A
>>> simu.initialization_method
'TM1_A'

>>> simu.initialization_method = "EXTRA"
>>> simu.initialization_method
'EXTRA'
>>> simu.initialization_method = SimulationInitialization.EXTRA
>>> simu.initialization_method
'EXTRA'

>>> simu.initialization_method = "EXTRA_A"
>>> simu.initialization_method
'EXTRA_A'
>>> simu.initialization_method = SimulationInitialization.EXTRA_A
>>> simu.initialization_method
'EXTRA_A'

>>> simu.initialization_method = "ASIS"
>>> simu.initialization_method
'ASIS'
>>> simu.initialization_method = SimulationInitialization.ASIS
>>> simu.initialization_method
'ASIS'

>>> simu.initialization_method = "TM1_NA"
>>> simu.initialization_method
'TM1_NA'
>>> simu.initialization_method = SimulationInitialization.TM1_NA
>>> simu.initialization_method
'TM1_NA'

>>> simu.initialization_method = "EXTRA_NA"
>>> simu.initialization_method
'EXTRA_NA'
>>> simu.initialization_method = SimulationInitialization.EXTRA_NA
>>> simu.initialization_method
'EXTRA_NA'