File: isauxiliary.m

package info (click to toggle)
dynare 6.4-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 67,648 kB
  • sloc: cpp: 79,109; ansic: 28,917; objc: 12,430; yacc: 4,528; pascal: 1,993; lex: 1,441; sh: 1,129; python: 634; makefile: 626; lisp: 163; xml: 18
file content (69 lines) | stat: -rw-r--r-- 1,999 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
function b = isauxiliary(var, types)

% Returns true if var is an auxiliary variable.
%
% INPUTS
% - var       [string]    Name of the variable.
% - types     [integer]  vector of type of auxiliary variables.
%
% OUTPUTS
% - b         [logical]
%
% REMARKS
%
% Types for auxiliary variables are as follows:
%
%   -  0,    Lead on endogenous variable (substitute for endo leads >= 2)
%   -  1,    Lag on endogenous variable (ubstitute for endo lags >= 2)
%   -  2,    Lead on exogenous variable  (ubstitute for exo leads >= 1)
%   -  3,    Lag on exogenous variable (substitute for exo lags >= 1)
%   -  4     Expectation (substitute for Expectation Operator)
%   -  5,    Diff forward (substitute for the differentiate of a forward variable)
%   -  6,    Multipliers for FOC of Ramsey Problem
%   -  7,    currently not used, see SymbolTable.hh
%   -  8,    Variable for Diff operator
%   -  9,    Lag on Diff
%   - 10,    Variable created when diff was taken of unary operator (log, exp)
%   - 11,    Lead on Diff

% Copyright © 2018-2021 Dynare Team
%
% This file is part of Dynare.
%
% Dynare is free software: you can redistribute it and/or modify
% it under the terms of the GNU General Public License as published by
% the Free Software Foundation, either version 3 of the License, or
% (at your option) any later version.
%
% Dynare is distributed in the hope that it will be useful,
% but WITHOUT ANY WARRANTY; without even the implied warranty of
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
% GNU General Public License for more details.
%
% You should have received a copy of the GNU General Public License
% along with Dynare.  If not, see <https://www.gnu.org/licenses/>.

global M_

b = false;

id = find(strcmp(var, M_.endo_names));

if isempty(id)
    return
end

if id<=M_.orig_endo_nbr
    return
else
    b = true;
    if nargin<2
        return
    end
end

auxinfo = M_.aux_vars(get_aux_variable_id(id));

if ~ismember(auxinfo.type, types)
    b = false;
end