Fixed documentation header.

parent 35aaf24d
function imcforecast(constrained_paths, constrained_vars, options_cond_fcst) function imcforecast(constrained_paths, constrained_vars, options_cond_fcst)
% Computes conditional forecasts. % Computes conditional forecasts.
% %
% INPUTS % INPUTS
% o constrained_paths [double] m*p array, where m is the number of constrained endogenous variables and p is the number of constrained periods. % - consnstrained_paths [double] m*p array, where m is the number of constrained endogenous variables and p is the number of constrained periods.
% o constrained_vars [char] m*x array holding the names of the controlled endogenous variables. % - constrained_vars [integer] m*1 array, indices in M_.endo_names of the constrained variables.
% o options_cond_fcst [structure] containing the options. The fields are: % - options_cond_fcst [structure] containing the options. The fields are:
% + replic [integer] scalar, number of monte carlo simulations. %
% + parameter_set [char] values of the estimated parameters: % + replic [integer] scalar, number of monte carlo simulations.
% "posterior_mode", % + parameter_set [char] values of the estimated parameters:
% "posterior_mean", % 'posterior_mode',
% "posterior_median", % 'posterior_mean',
% "prior_mode" or % 'posterior_median',
% "prior mean". % 'prior_mode' or
% [double] np*1 array, values of the estimated parameters. % 'prior mean'.
% + controlled_varexo [char] m*x array, list of controlled exogenous variables. % [double] np*1 array, values of the estimated parameters.
% + conf_sig [double] scalar in [0,1], probability mass covered by the confidence bands. % + controlled_varexo [cell] m*1 cell of row char array, list of controlled exogenous variables.
% + conf_sig [double] scalar in [0,1], probability mass covered by the confidence bands.
% %
% OUTPUTS % OUTPUTS
% None. % None.
% %
% SPECIAL REQUIREMENTS % SPECIAL REQUIREMENTS
% This routine has to be called after an estimation statement or an estimated_params block. % This routine has to be called after an estimation statement or an estimated_params block.
% %
% REMARKS % REMARKS
% [1] Results are stored in a structure which is saved in a mat file called conditional_forecasts.mat. % [1] Results are stored in a structure which is saved in a mat file called conditional_forecasts.mat.
% [2] Use the function plot_icforecast to plot the results. % [2] Use the function plot_icforecast to plot the results.
% Copyright (C) 2006-2018 Dynare Team % Copyright (C) 2006-2018 Dynare Team
% %
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment