stepan
/
dynare
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: even though long_name was removed as an explicit option in c9ca46f228, reintroduce the doc related to it so as not to confuse the issue

time-shift
Houtan Bastani 2016-02-26 17:00:24 +01:00
parent c9ca46f228
commit b303819254
1 changed files with 24 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
doc/dynare.texi
View File

@ -1100,9 +1100,9 @@ number @var{i} and the index in many loops. Rather, name investment @var{invest}
Declarations of variables and parameters are made with the following commands:
@deffn Command var @var{VARIABLE_NAME} [$@var{LATEX_NAME}$] [(NAME=@var{QUOTED_STRING})]@dots{};
@deffnx Command var (deflator = @var{MODEL_EXPRESSION}) @var{VARIABLE_NAME} [$@var{LATEX_NAME}$] [(NAME=@var{QUOTED_STRING})]@dots{};
@deffnx Command var (log_deflator = @var{MODEL_EXPRESSION}) @var{VARIABLE_NAME} [$@var{LATEX_NAME}$] [(NAME=@var{QUOTED_STRING})]@dots{};
@deffn Command var @var{VARIABLE_NAME} [$@var{LATEX_NAME}$] [(long_name=@var{QUOTED_STRING})] [(NAME=@var{QUOTED_STRING})]@dots{};
@deffnx Command var (deflator = @var{MODEL_EXPRESSION}) @var{VARIABLE_NAME} [$@var{LATEX_NAME}$] [(long_name=@var{QUOTED_STRING})] [(NAME=@var{QUOTED_STRING})]@dots{};
@deffnx Command var (log_deflator = @var{MODEL_EXPRESSION}) @var{VARIABLE_NAME} [$@var{LATEX_NAME}$] [(long_name=@var{QUOTED_STRING})] [(NAME=@var{QUOTED_STRING})]@dots{};
@descriptionhead
@ -1139,14 +1139,16 @@ additive instead of multiplicative (or, to put it otherwise, the
declared variable is equal to the log of a variable with a
multiplicative trend).
@anchor{long_name}
@item long_name = @var{QUOTED_STRING}
This is the long version of the variable name. Its value is stored in
@code{M_.endo_names_long}. Default: @var{VARIABLE_NAME}
@anchor{partitioning}
@item NAME = @var{QUOTED_STRING}
This is used to create a partitioning of variables. It results in the direct
output in the @file{.m} file analogous to: @code{M_.endo_}@var{NAME}@code{ =
}@var{QUOTED_STRING}@code{;}. If @var{NAME} is equal to @code{long_name}, the
@var{QUOTED_STRING} will overwrite the value in @code{M_.endo_names_long}. If
@var{NAME} is equal to @code{long_name}, the default is
@var{VARIABLE_NAME}. Otherwise, no default value.
}@var{QUOTED_STRING}@code{;}.
@end table
@examplehead
@ -1159,7 +1161,7 @@ var c $C$ (long_name=`Consumption');
@end deffn
@deffn Command varexo @var{VARIABLE_NAME} [$@var{LATEX_NAME}$] [(NAME=@var{QUOTED_STRING})]@dots{};
@deffn Command varexo @var{VARIABLE_NAME} [$@var{LATEX_NAME}$] [(long_name=@var{QUOTED_STRING})] [(NAME=@var{QUOTED_STRING})]@dots{};
@descriptionhead
@ -1175,8 +1177,11 @@ will concatenate them.
@optionshead
@table @code
@item long_name = @var{QUOTED_STRING}
Like @ref{long_name} but value stored in @code{M_.exo_names_long}.
@item NAME = @var{QUOTED_STRING}
Like @ref{partitioning} but value stored in @code{M_.exo_}@var{NAME}.
Like @ref{partitioning} but @var{QUOTED_STRING} stored in @code{M_.exo_}@var{NAME}.
@end table
@examplehead
@ -1187,7 +1192,7 @@ varexo m gov;
@end deffn
@deffn Command varexo_det @var{VARIABLE_NAME} [$@var{LATEX_NAME}$] [(NAME=@var{QUOTED_STRING})]@dots{};
@deffn Command varexo_det @var{VARIABLE_NAME} [$@var{LATEX_NAME}$] [(long_name=@var{QUOTED_STRING})] [(NAME=@var{QUOTED_STRING})]@dots{};
@descriptionhead
@ -1209,8 +1214,11 @@ Dynare will concatenate them.
@optionshead
@table @code
@item long_name = @var{QUOTED_STRING}
Like @ref{long_name} but value stored in @code{M_.exo_det_names_long}.
@item NAME = @var{QUOTED_STRING}
Like @ref{partitioning} but value stored in @code{M_.exo_det_}@var{NAME}.
Like @ref{partitioning} but @var{QUOTED_STRING} stored in @code{M_.exo_det_}@var{NAME}.
@end table
@examplehead
@ -1224,7 +1232,7 @@ varexo_det tau;
@end deffn
@deffn Command parameters @var{PARAMETER_NAME} [$@var{LATEX_NAME}$] [(NAME=@var{QUOTED_STRING})]@dots{};
@deffn Command parameters @var{PARAMETER_NAME} [$@var{LATEX_NAME}$] [(long_name=@var{QUOTED_STRING})] [(NAME=@var{QUOTED_STRING})]@dots{};
@descriptionhead
@ -1241,8 +1249,11 @@ Dynare will concatenate them.
@optionshead
@table @code
@item long_name = @var{QUOTED_STRING}
Like @ref{long_name} but value stored in @code{M_.param_names_long}.
@item NAME = @var{QUOTED_STRING}
Like @ref{partitioning} but value stored in @code{M_.param_}@var{NAME}.
Like @ref{partitioning} but @var{QUOTED_STRING} stored in @code{M_.param_}@var{NAME}.
@end table
@examplehead