gecon_model: Create objects of 'gecon_model' class

Description Usage Arguments Value Note

View source: R/class_model.R

Description

The gecon_model function is a constructor of objects of gecon_model class.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
gecon_model(model_info, index_sets,
            variables, variables_tex,
            shocks, shocks_tex,
            parameters, parameters_tex,
            parameters_free, parameters_free_val,
            equations, calibr_equations,
            var_eq_map, shock_eq_map, var_ceq_map, cpar_eq_map,
            cpar_ceq_map, fpar_eq_map, fpar_ceq_map,
            ss_function, calibr_function, ss_calibr_jac_function,
            pert)

Arguments

model_info

a character vector of length 3, containing information about the model: the input file name, the input file path, and the date of creation.

index_sets

a list containing information about index sets. The names of its elements correspond to sets' names. Each element contains a character vector of the names of the relevant set's components.

variables

a character vector of variables' names.

variables_tex

a character vector of variables' LaTeX names.

shocks

a character vector of shocks' names.

shocks_tex

a character vector of shocks' LaTeX names.

parameters

a character vector of all parameters' names.

parameters_tex

a character vector of all parameters' LaTeX names.

parameters_free

a character vector of free parameters' names.

parameters_free_val

a vector of free parameters' values.

equations

a character vector of model equations.

calibr_equations

a character vector of calibrating equations.

var_eq_map

a sparse matrix (an object of Matrix class) representing the mapping of variables to equations.

shock_eq_map

a sparse matrix (an object of Matrix class) representing the mapping of shocks to equations.

var_ceq_map

a sparse matrix (an object of Matrix class) representing the mapping of variables to calibrating equations.

cpar_eq_map

a sparse matrix (an object of Matrix class) representing the mapping of calibrated parameters to equations.

cpar_ceq_map

a sparse matrix (an object of Matrix class) representing the mapping of calibrated parameters to calibrating equations.

fpar_eq_map

a sparse matrix (an object of Matrix class) representing the mapping of free parameters to equations.

fpar_ceq_map

a sparse matrix (an object of Matrix class) representing the mapping of free parameters to calibrating equations.

ss_function

a function returning the steady-state/equilibrium equations' residuals.

calibr_function

a function used for the calibration of parameters.

ss_calibr_jac_function

a function computing the Jacobian of both steady-state (equilibrium) and calibrating functions or NULL.

pert

a function returning matrices representing the first order perturbation of the model (in the canonical form).

Value

An object of gecon_model class.

Note

The gecon_model constructor is used in .R files created by gEcon. In general, users should not call this function explicitly.


gEcon documentation built on May 2, 2019, 6:52 p.m.

Related to gecon_model in gEcon...