iode.Simulation.convergence_threshold

property Simulation.convergence_threshold: float

Indicates the convergence threshold below which the simulation ends positively for the current period. In other words, for a given period, when the relative differences between two successive iterations (k and k-1)

\[\frac{\|Y[k] - Y[k-1]\|}{\|Y[k]\|}\]

are below this threshold for all endogenous variables, the model is considered to have converged. Default value is 0.001.

Parameters:

value: float

New convergence threshold value.

Examples

>>> from iode import Simulation
>>> simu = Simulation()
>>> simu.convergence_threshold
0.001
>>> simu.convergence_threshold = 1e-6
>>> simu.convergence_threshold
1e-06