diff --git a/matlab/simul_backward_nonlinear_model.m b/matlab/simul_backward_nonlinear_model.m index 99dd3932bea61fc96fdd5b678af9cbc870d6c571..1de354e7d5b30f75b2ef0e25402a4f47ceb38d8c 100644 --- a/matlab/simul_backward_nonlinear_model.m +++ b/matlab/simul_backward_nonlinear_model.m @@ -1,40 +1,27 @@ function DynareOutput = simul_backward_nonlinear_model(initial_conditions, sample_size, DynareOptions, DynareModel, DynareOutput, innovations) -%@info: -%! @deftypefn {Function File} {@var{DynareOutput} =} simul_backward_nonlinear_model (@var{sample_size},@var{DynareOptions}, @var{DynareModel}, @var{DynareOutput}) -%! @anchor{@simul_backward_nonlinear_model} -%! @sp 1 -%! Simulates a stochastic non linear backward looking model with arbitrary precision (a deterministic solver is used). -%! @sp 2 -%! @strong{Inputs} -%! @sp 1 -%! @table @ @var -%! @item sample_size -%! Scalar integer, size of the sample to be generated. -%! @item DynareOptions -%! Matlab/Octave structure (Options used by Dynare). -%! @item DynareDynareModel -%! Matlab/Octave structure (Description of the model). -%! @item DynareOutput -%! Matlab/Octave structure (Results reported by Dynare). -%! @end table -%! @sp 1 -%! @strong{Outputs} -%! @sp 1 -%! @table @ @var -%! @item DynareOutput -%! Matlab/Octave structure (Results reported by Dynare). -%! @end table -%! @sp 2 -%! @strong{This function is called by:} -%! @sp 2 -%! @strong{This function calls:} -%! @ref{dynTime} -%! -%! @end deftypefn -%@eod: +% Simulates a stochastic non linear backward looking model with arbitrary precision (a deterministic solver is used). +% +% INPUTS +% - initial_conditions [double] n*1 vector, initial conditions for the endogenous variables. +% - sample_size [integer] scalar, number of periods for the simulation. +% - DynareOptions [struct] Dynare's options_ global structure. +% - DynareModel [struct] Dynare's M_ global structure. +% - DynareOutput [struct] Dynare's oo_ global structure. +% - innovations [double] T*q matrix, innovations to be used for the simulation. +% +% OUTPUTS +% - DynareOutput [struct] Dynare's oo_ global structure. +% +% REMARKS +% [1] The innovations used for the simulation are saved in DynareOutput.exo_simul, and the resulting paths for the endogenous +% variables are saved in DynareOutput.endo_simul. +% [2] The last input argument is not mandatory. If absent we use random draws and rescale them with the informations provided +% through the shocks block. +% [3] If the first input argument is empty, the endogenous variables are initialized with 0, or if available with the informations +% provided thrtough the histval block. -% Copyright (C) 2012-2016 Dynare Team +% Copyright (C) 2012-2017 Dynare Team % % This file is part of Dynare. %