gcubed.base_equations
This module contains the BaseEquations class.
Overview
All Python classes created by the SYM processor are subclasses of this class.
Provides functionality associated with all of the classes created by the SYM processor to implement the model equations.
Overview
Initialise with each of the left-hand and right-hand side vectors of variables used to express the model equations.
Arguments
x1l: The left-hand side vector of state variables used to express the model equations.
j1l: The left-hand side vector of costate variables used to express the model equations.
zel: The left-hand side vector of expected endogenous variables used to express the model equations.
z1l: The left-hand side vector of endogenous variables used to express the model equations.
x1r: The right-hand side vector of state variables used to express the model equations.
j1r: The right-hand side vector of costate variables used to express the model equations.
z1r: The right-hand side vector of endogenous variables used to express the model equations.
zer: The right-hand side vector of expected endogenous variables used to express the model equations.
yjr: The right-hand side vector of 1-period lagged costate variables used to express the model equations.
yxr: The right-hand side vector of 1-period lagged state variables used to express the model equations.
exo: The right-hand side vector of exogenous variables used to express the model equations.
exz: The right-hand side vector of 1-period lagged expected endogenous variables used to express the model equations.
par: The vector of parameters used to express the model equations.
The parameters and the right-hand side vectors of variables are all used to populate the equations that are evaluated to determine values of variables that are then stored in the left-hand side variable vectors.
These left-hand side variable vectors are then referenced by calling classes to determine the results of equation evaluations.
Overview
This is function you should use to access the functions implementing the model equations.
Returns
The equation function identified by the identifier. This equation function will have a name in the format 'vectorName_index'.
e.g. z1l_12 for equation of the 13th variable in the z1l vector, noting
that the vector indexing starts at 0.
Notes
The equation function will have been declared in the subclass generated by the SYM processor from the SYM model definition.
This placeholder function does nothing in the superclass.
The left-hand side vector of state variables used to express the model equations.
Use this property to get values of the state variables that have been computed using the model equations.
The left-hand side vector of costate variables.
Use this property to get values of the costate variables that have been computed using the model equations.
The left-hand side vector of expected endogenous variables.
Use this property to get values of the expected endogenous variables that have been computed using the model equations.
The left-hand side vector of endogenous variables.
Use this property to get values of the endogenous variables that have been computed using the model equations.
The right-hand side vector of state variables used to express the model equations.
The right-hand side vector of costate variables used to express the model equations.
The right-hand side vector of endogenous variables used to express the model equations.
The right-hand side vector of expected endogenous variables used to express the model equations.
The right-hand side vector of 1-period lagged costate variables used to express the model equations.
The right-hand side vector of 1-period lagged state variables used to express the model equations.
The right-hand side vector of exogenous variables used to express the model equations.
The right-hand side vector of 1-period lagged expected endogenous variables used to express the model equations.
Overview
Ensure that all of the variable vectors have been initialised to Numpy column vectors.