gcubed.projections.baseline_projections

This module contains the BaselineProjections class, used for doing baseline projections.

class BaselineProjections(gcubed.projections.projections.Projections):

Overview

Compute the baseline model projections over the projection horizon from the first projection year (a year with available data to be matched by the projections) through to the last projection year.

BaselineProjections( solved_model: gcubed.linearisation.solved_model.SolvedModel, previous_projections: gcubed.projections.projections.Projections | None = None)

Arguments

solved_model: The solved model that provides access to all of the information required to produce projections.

previous_projections: The projections that this baseline builds upon. The first baseline has previous projections equal to None. Defaults to None.

first_year_projections_of_variables_adjusted_by_intertemporal_constants: numpy.ndarray

An column vector of first year projection values for those variables that are adjusted by intertemporal constants.

The vector is populated from the vectors of first year projections for each of x1l, j1l, zel, and z1l.

first_projection_year_x1r: numpy.ndarray

The x1r vector populated with database values from the year after the first projection year.

These values are not adjusted by any constants and are never altered after they are set.

first_projection_year_j1r: numpy.ndarray

The j1r vector populated with database values from the year after the first projection year.

These values are not adjusted by any constants and are never altered after they are set.

first_projection_year_zer: numpy.ndarray

The zer vector populated with database values from the first projection year.

These values are not adjusted by any constants and are never altered after they are set.

first_projection_year_z1r: numpy.ndarray

The z1r vector populated with database values from the first projection year.

These values are not adjusted by any constants and are never altered after they are set.

first_projection_year_yxr: numpy.ndarray

The yxr vector populated with database values from the first projection year.

These values are not adjusted by any constants and are never altered after they are set.

first_projection_year_yjr: numpy.ndarray

The yjr vector populated with database values from the first projection year.

These values are not adjusted by any constants and are never altered after they are set.

first_projection_year_exz: numpy.ndarray

The exz vector populated with database values from the year after the first projection year.

These values are not adjusted by any constants and are never altered after they are set.

first_projection_year_exo: numpy.ndarray

The exo vector populated with database values from the first projection year.

These values are not adjusted by any constants and are never altered after they are set.

x1r_difference_from_ssf: numpy.ndarray

The difference between the database values of x1r and the raw baseline projections of those values, without making any constant adjustments at all.

These differences are added to the constants that are used in the baseline projections to ensure that the projections in the first projection year match the database values in that year.

j1r_difference_from_ssf: numpy.ndarray

The difference between the database values of j1r and the raw baseline projections of those values, without making any constant adjustments at all.

These differences are added to the constants that are used in the baseline projections to ensure that the projections in the first projection year match the database values in that year.

zer_difference_from_ssf: numpy.ndarray

The difference between the database values of zer and the raw baseline projections of those values, without making any constant adjustments at all.

These differences are added to the constants that are used in the baseline projections to ensure that the projections in the first projection year match the database values in that year.

z1r_difference_from_ssf: numpy.ndarray

The difference between the database values of z1r and the raw baseline projections of those values, without making any constant adjustments at all.

These differences are added to the constants that are used in the baseline projections to ensure that the projections in the first projection year match the database values in that year.

x1_intertemporal_constants: numpy.ndarray

Returns the intertemporal constants to apply to the x1 vector as an N by 1 column vector. where N is the number of x1 variables.

j1_intertemporal_constants: numpy.ndarray

Returns the intertemporal constants to apply to the j1 vector as an N by 1 column vector. where N is the number of j1 variables.

ze_intertemporal_constants: numpy.ndarray

Returns the intertemporal constants to apply to the ze vector as an N by 1 column vector. where N is the number of ze variables.

z1_intertemporal_constants: numpy.ndarray

Returns the intertemporal constants to apply to the z1 vector as an N by 1 column vector. where N is the number of z1 variables.

yxr_first_year_projections: numpy.ndarray

Projections of X1_t (yxr) in the first projection year

yjr_first_year_projections: numpy.ndarray

Projections of J1_t (yjr) in the first projection year

exz_first_year_projections: numpy.ndarray

Projections of ZE_t (exz) in the first projection year

z1l_first_year_projections: numpy.ndarray

Projections of Z1_t (z1l=z1r) in the first projection year

exo_first_year_projections: numpy.ndarray

Projections of EXO_t in the first projection year

first_year_original_projections_of_variables_adjusted_by_intertemporal_constants: numpy.ndarray

The first year projected values for the variables that are being adjusted by the intertemporal constants.

The values are those for the projection that is not adjusted by intertemporal constants.

It is used in the calculation of the intertemporal constants but it is only preserved as a property to facilitate benchmarking against Ox.

first_year_observed_values_of_variables_adjusted_by_intertemporal_constants: numpy.ndarray

Returns the observed values, in the first projection year, of the variables that are adjusted by intertemporal constants.

The values are not adjusted after they are initially set so they can be relied up and reused by the constant calculation process in this baseline projections and in any later relinearisation projections.

The constant parameter inputs to G-Cubed functions - none of these change across projection layers.