

    \filetitle{get}{Query model object properties}{model/get}

	\paragraph{Syntax}
 
 \begin{verbatim}
 ANS = get(M,QUERY)
 [ANS,ANS,...] = get(M,QUERY,QUERY,...)
 \end{verbatim}
 \paragraph{Input arguments}
 
 \begin{itemize}
 \item
   \texttt{M} {[} model {]} - Model object.
 \item
   \texttt{QUERY} {[} char {]} - Query string.
 \end{itemize}
 \paragraph{Output arguments}
 
 \begin{itemize}
 \item
   \texttt{ANS} {[} \ldots{} {]} - Answer to the query.
 \end{itemize}
 \paragraph{Valid queries on model objects}
 
 Below is the categorised list of model properties and attributes that
 can be queried/accessed by the \texttt{get} function. Note that letter
 \texttt{'y'} is used in various contexts to denote measurement variables
 or equations, \texttt{'x'} transition variables or equations,
 \texttt{'e'} shocks, \texttt{'p'} parameters, \texttt{'d'} deterministic
 trend equations, \texttt{'l'} dynamic links, and \texttt{'r'} reporting
 equations. The property names are case insensitive.
 
 \subparagraph{Steady state}
 
 \begin{itemize}
 \item
   \texttt{'sstate'} --- Returns {[} struct {]} a database with the
   steady states for all model variables. The steady states are described
   by complex numbers in which the real part is the level and the
   imaginary part is the growth rate.
 \item
   \texttt{'sstateLevel'} --- Returns {[} struct {]} a database with the
   steady-state levels for all model variables.
 \item
   \texttt{'sstateGrowth'} --- Returns {[} struct {]} a database with
   steady-state growth (first difference for linearised variables, gross
   rate of growth for log-linearised variables) for all model variables.
 \item
   \texttt{'dtrends'} --- Returns {[} struct {]} a database with the
   effect of the deterministic trends on the measurement variables. The
   effect is described by complex numbers the same way as the steady
   state.
 \item
   \texttt{'dtrendsLevel'} --- Returns {[} struct {]} a database with the
   effect of the deterministic trends on the steady-state levels of the
   measurement variables.
 \item
   \texttt{'dtrendsGrowth'} --- Returns {[} struct {]} a database with
   the effect of deterministic trends on steady-state growth of the
   measurement variables.
 \item
   \texttt{'sstate+dtrends'} --- Returns {[} struct {]} the same as
   `sstate' except that the measurement variables are corrected for the
   effect of the deterministic trends.
 \item
   \texttt{'sstateLevel+dtrendsLevel'} --- Returns {[} struct {]} the
   same as `sstateLevel' except that the measurement variables are
   corrected for the effect of the deterministic trends.
 \item
   \texttt{'sstateGrowth+dtrendsGrowth'} --- Returns {[} struct {]} the
   same as \texttt{'sstateGrowth'} except that the measurement variables
   are corrected for the effect of the deterministic trends.
 \end{itemize}
 \subparagraph{Variables, parameters and equations}
 
 \begin{itemize}
 \item
   \texttt{'yList'} --- Returns {[} cellstr {]} the list of measurement
   variables in order of their appearance in the model code declarations.
 \item
   \texttt{'xList'} --- Returns {[} cellstr {]} the list of transition
   variables in order of their appearance in the model code declarations.
 \item
   \texttt{'eList'} --- Returns {[} cellstr {]} the list of shocks in
   order of their appearance in the model code declarations.
 \item
   \texttt{'eyList'} --- Returns {[} cellstr {]} the list of measurement
   shocks in order of their appearance in the model code declarations;
   only those shocks that actually occur in at least one measurement
   equation are returned.
 \item
   \texttt{'exList'} --- Returns {[} cellstr {]} the list of transition
   shocks in order of their appearance in the model code declarations;
   only those shocks that actually occur in at least one transition
   equation are returned.
 \item
   \texttt{'pList'} --- Returns {[} cellstr {]} the list of the parameter
   names in order of their appearance in the model code. The list does
   not include the names of std deviations and cross-correlations.
 \item
   \texttt{'stdList'} --- Returns {[} cellstr {]} the list of the names
   of the standard deviations for the shocks in order of the appearance
   of the corresponding shocks in the model code.
 \item
   \texttt{'corrList'} --- Returns {[} cellstr {]} the list of the names
   of cross-correlation coefficients for the shocks in order of the
   appearance of the corresponding shocks in the model code.
 \item
   \texttt{'stdCorrList'} --- Returns {[} cellstr {]} the list of the
   names of std deviations and cross-correlation coefficients for the
   shocks in order of the appearance of the corresponding shocks in the
   model code.
 \item
   \texttt{'yEqtn'} --- Returns {[} cellstr {]} the list of the
   measurement equations in order of their appearance in the model code.
 \item
   \texttt{'xEqtn'} --- Returns {[} cellstr {]} the list of the
   transition equations in order of their appearance in the model code.
 \item
   \texttt{'dEqtn'} --- Returns {[} cellstr {]} the list of the
   deterministic-trend equations in order of the appearance of the
   respective measurement variables in the model code declarations.
 \item
   \texttt{'lEqtn'} --- Returns {[} cellstr {]} the list of the dynamic
   links in order of the appearance in the model code.
 \item
   \texttt{'rEqtn'} --- Returns {[} cellstr {]} the list of the reporting
   equations in order of their appearance in the model code.
 \end{itemize}
 \subparagraph{First-order Taylor expansion of equations}
 
 \begin{itemize}
 \item
   \texttt{'derivatives'} --- Returns {[} cellstr {]} the
   symbolic/automatic derivatives for each model equation; in each
   equation, the derivatives w.r.t. all variables present in that
   equation are evaluated at once and returned as a vector of numbers;
   see also \texttt{'wrt'}.
 \item
   \texttt{'wrt'} - Returns {[} cellstr {]} the list of those variables
   (and their auxiliary lags or leads) with respect to which the
   corresponding equation is differentiated.
 \end{itemize}
 \subparagraph{Descriptions of variables, parameters, and shocks}
 
 \begin{itemize}
 \item
   \texttt{'description'} --- Returns {[} struct {]} a database with user
   descriptions of model variables, shocks, and parameters.
 \item
   \texttt{'yDescription'} --- Returns {[} cellstr {]} user descriptions
   of measurement variables.
 \item
   \texttt{'xDescription'} --- Returns {[} cellstr {]} user decriptions
   of transition variables.
 \item
   \texttt{'eDescription'} --- Returns {[} cellstr {]} user descriptions
   of shocks.
 \item
   \texttt{'pDescription'} --- Returns {[} cellstr {]} user descriptions
   parameters.
 \end{itemize}
 \subparagraph{Labels}
 
 \begin{itemize}
 \item
   \texttt{'yLabels'} --- Returns {[} cellstr {]} user labels added to
   measurement equations.
 \item
   \texttt{'xLabels'} --- Returns {[} cellstr {]} user labels added to
   transition equations.
 \item
   \texttt{'dLabels'} --- Returns {[} cellstr {]} user labels added to
   deterministic-trend equations.
 \item
   \texttt{'lLabels'} --- Returns {[} cellstr {]} user labels added to
   dynamic links.
 \item
   \texttt{'rLabels'} --- Returns {[} cellstr {]} user labels added to
   reporting equations.
 \end{itemize}
 \subparagraph{Parameter values}
 
 \begin{itemize}
 \item
   \texttt{'corr'} --- Returns {[} struct {]} a database with current
   cross-correlation coefficients of shocks.
 \item
   \texttt{'nonzeroCorr'} --- Returns {[} struct {]} a database with
   current nonzero cross-correlation coefficients of shocks.
 \item
   \texttt{'parameters'} --- Returns {[} struct {]} a database with
   current parameter values, including the std devs and non-zero corr
   coefficients.
 \item
   \texttt{'std'} --- Returns {[} struct {]} a database with current std
   deviations of shocks.
 \end{itemize}
 \subparagraph{Eigenvalues}
 
 \begin{itemize}
 \item
   \texttt{'stableRoots'} --- Returns {[} cell of numeric {]} a vector of
   the model eigenvalues that are smaller than one in magnitude (allowing
   for rounding errors around one).
 \item
   \texttt{'unitRoots'} --- Returns {[} cell of numeric {]} a vector of
   the model eigenvalues that equal one in magnitude (allowing for
   rounding errors around one).
 \item
   \texttt{'unstableRoots'} {[} cell of numeric {]} A vector of the model
   eigenvalues that are greater than one in magnitude (allowing for
   rounding errors around one).
 \end{itemize}
 \subparagraph{Model structure, solution, build}
 
 \begin{itemize}
 \item
   \texttt{'build'} --- Returns {[} numeric {]} IRIS version number under
   which the model object has been built.
 \item
   \texttt{'log'} --- Returns {[} struct {]} a database with
   \texttt{true} for each log-linearised variables, and \texttt{false}
   for each linearised variable.
 \item
   \texttt{'maxLag'} --- Returns {[} numeric {]} the maximum lag in the
   model.
 \item
   \texttt{'maxLead'} --- Returns {[} numeric {]} the maximum lead in the
   model.
 \item
   \texttt{'stationary'} --- Returns {[} struct {]} a database with
   \texttt{true} for each stationary variables, and \texttt{false} for
   each unit-root (non-stationary) variables (under current solution).
 \item
   \texttt{'nonStationary'} --- Returns {[} struct {]} a database with
   \texttt{true} for each unit-root (non-stationary) varible, and
   \texttt{false} for each stationary variable (under current solution).
 \item
   \texttt{'stationaryList'} --- Returns {[} cellstr {]} the list of
   stationary variables (under current solution).
 \item
   \texttt{'nonStationaryList'} --- Returns {[} cellstr {]} cell with the
   list of unit-root (non-stationary) variables (under current solution).
 \item
   \texttt{'initCond'} --- Returns {[} cellstr {]} the list of the lagged
   transition variables that need to be supplied as initial conditions in
   simulations and forecasts. The list of the initial conditions is
   solution-specific as the state-spece coefficients at some of the lags
   may evaluate to zero depending on the current parameters.
 \item
   \texttt{'yVector'} --- Returns {[} cellstr {]} the list of measurement
   variables in order of their appearance in the rows and columns of
   state-space matrices (effectively identical to \texttt{'yList'}) from
   the \url{model/sspace} function.
 \item
   \texttt{'xVector'} --- Returns {[} cellstr {]} the list of transition
   variables, and their auxiliary lags and leads, in order of their
   appearance in the rows and columns of state-space matrices from the
   \url{model/sspace} function.
 \item
   \texttt{'xfVector'} --- Returns {[} cellstr {]} the list of
   forward-looking (i.e.~non-predetermined) transition variables, and
   their auxiliary lags and leads, in order of their appearance in the
   rows and columns of state-space matrices from the \url{model/sspace}
   function.
 \item
   \texttt{'xbVector'} --- Returns {[} cellstr {]} the list of
   backward-looking (i.e.~predetermined) transition variables, and their
   auxiliary lags and leads, in order of their appearance in the rows and
   columns of state-space matrices from the \url{model/sspace} function.
 \item
   \texttt{'eVector'} --- Returns {[} cellstr {]} the list of the shocks
   in order of their appearance in the rows and columns of state-space
   matrices (effectively identical to \texttt{'eList'}) from the
   \url{model/sspace} function.
 \end{itemize}
 \paragraph{Description}
 
 \subparagraph{First-order Taylor expansion of equations}
 
 The expressions for symbolic/automatic derivatives of individual model
 equations returned by \texttt{'derivatives'} are expressions that
 evaluate the derivatives with respect to all variables present in that
 equation at once. The list of variables with respect to which each
 equation is differentiated is returned by \texttt{'wrt'}.
 
 The expressions returned by \texttt{'derivatives'} can, in general,
 refer to
 
 \begin{itemize}
 \item
   the names of model parameters, such as \texttt{alpha};
 \item
   the names of transition or measurement variables, such as \texttt{X};
 \item
   the lags or leads of variables, such as \texttt{X\{-1\}}.
 \end{itemize}
 Note that the lags and leads of variables must be, in general, preserved
 in the derivatives for non-stationary (unit-root) models. For stationary
 models, the lags and leads can be removed and replaced simply with the
 current date of the respective variable.
 
 \paragraph{Example}
 
 \begin{verbatim}
 d = get(m,'derivatives');
 w = get(m,'wrt');
 \end{verbatim}
 The 1-by-N cell array \texttt{d} (where N is the total number of
 equations in the model) will contain expressions that evaluate to the
 vector of derivatives of the individual equations w.r.t. to the
 variables present in that equation:
 
 \begin{verbatim}
 d{k}
 \end{verbatim}
 is an expression that returns, in general, a vector of M numbers. These
 M numbers are the derivatives of the k-th equation w.r.t to M variables
 whose list is in
 
 \begin{verbatim}
 w{k}
 \end{verbatim}


