From 9fe2427122a597ac9707b172396935eae44d3de1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A9bastien=20Villemot?= <sebastien@dynare.org>
Date: Thu, 28 Nov 2024 17:00:59 +0100
Subject: [PATCH] Manual: document that oo_.{endo,exo}_simul can be created by
perfect_foresight_with_expectation_errors_solver
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
By the way, drop mention of “simul” in their description, since it is obsolete.
[skip ci]
(cherry picked from commit 62101ec4944aa520cb93dd833c1388edd995aa92)
---
doc/manual/source/the-model-file.rst | 35 ++++++++++++++--------------
1 file changed, 17 insertions(+), 18 deletions(-)
diff --git a/doc/manual/source/the-model-file.rst b/doc/manual/source/the-model-file.rst
index f529184180..fb9424fc51 100644
--- a/doc/manual/source/the-model-file.rst
+++ b/doc/manual/source/the-model-file.rst
@@ -4021,29 +4021,28 @@ speed-up on large models.
.. matvar:: oo_.endo_simul
|br| This variable stores the result of a deterministic simulation
- (computed by ``perfect_foresight_solver`` or ``simul``) or of a
- stochastic simulation (computed by ``stoch_simul`` with the
- periods option or by ``extended_path``). The variables are
- arranged row by row, in order of declaration (as in
- ``M_.endo_names``). Note that this variable also contains initial
- and terminal conditions, so it has more columns than the value of the
- ``periods`` option: the first simulation period is in
- column ``1+M_.maximum_lag``, and the total number of columns is
+ (computed by ``perfect_foresight_solver`` or
+ ``perfect_foresight_with_expectation_errors_solver``) or of a stochastic
+ simulation (computed by ``stoch_simul`` with the ``periods`` option or by
+ ``extended_path``). The variables are arranged row by row, in order of
+ declaration (as in ``M_.endo_names``). Note that this variable also
+ contains initial and terminal conditions, so it has more columns than the
+ value of the ``periods`` option: the first simulation period is in column
+ ``1+M_.maximum_lag``, and the total number of columns is
``M_.maximum_lag+periods+M_.maximum_lead``.
.. matvar:: oo_.exo_simul
|br| This variable stores the path of exogenous variables during a
- simulation (computed by ``perfect_foresight_solver``, ``simul``,
- ``stoch_simul`` or ``extended_path``). The variables are arranged
- in columns, in order of declaration (as in
- ``M_.exo_names``). Periods are in rows. Note that this convention
- regarding columns and rows is the opposite of the convention for
- ``oo_.endo_simul``! Also note that this variable also contains initial
- and terminal conditions, so it has more rows than the value of the
- ``periods`` option: the first simulation period is in row
- ``1+M_.maximum_lag``, and the total number of rows is
- ``M_.maximum_lag+periods+M_.maximum_lead``.
+ simulation (computed by ``perfect_foresight_solver``,
+ ``perfect_foresight_with_expectation_errors_solver``, ``stoch_simul`` or
+ ``extended_path``). The variables are arranged in columns, in order of
+ declaration (as in ``M_.exo_names``). Periods are in rows. Note that this
+ convention regarding columns and rows is the opposite of the convention for
+ ``oo_.endo_simul``! Also note that this variable also contains initial and
+ terminal conditions, so it has more rows than the value of the ``periods``
+ option: the first simulation period is in row ``1+M_.maximum_lag``, and the
+ total number of rows is ``M_.maximum_lag+periods+M_.maximum_lead``.
.. matvar:: oo_.initial_steady_state
--
GitLab