SymbolTable.cc 15.2 KB
Newer Older
sebastien's avatar
sebastien committed
1
/*
Sébastien Villemot's avatar
Sébastien Villemot committed
2
 * Copyright (C) 2003-2012 Dynare Team
sebastien's avatar
sebastien committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 *
 * 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 <http://www.gnu.org/licenses/>.
 */

20
#include <algorithm>
21
#include <sstream>
sebastien's avatar
sebastien committed
22
#include <iostream>
sebastien's avatar
sebastien committed
23
#include <cassert>
24

25
#include "SymbolTable.hh"
26

27
AuxVarInfo::AuxVarInfo(int symb_id_arg, aux_var_t type_arg, int orig_symb_id_arg, int orig_lead_lag_arg,
28
                       int equation_number_for_multiplier_arg) :
29
30
31
32
  symb_id(symb_id_arg),
  type(type_arg),
  orig_symb_id(orig_symb_id_arg),
  orig_lead_lag(orig_lead_lag_arg),
33
  equation_number_for_multiplier(equation_number_for_multiplier_arg)
34
35
36
{
}

sebastien's avatar
sebastien committed
37
SymbolTable::SymbolTable() : frozen(false), size(0)
38
39
40
{
}

sebastien's avatar
sebastien committed
41
int
sebastien's avatar
sebastien committed
42
SymbolTable::addSymbol(const string &name, SymbolType type, const string &tex_name) throw (AlreadyDeclaredException, FrozenException)
43
{
sebastien's avatar
sebastien committed
44
45
46
  if (frozen)
    throw FrozenException();

sebastien's avatar
sebastien committed
47
  if (exists(name))
48
    {
sebastien's avatar
sebastien committed
49
      if (type_table[getID(name)] == type)
50
51
52
53
        throw AlreadyDeclaredException(name, true);
      else
        throw AlreadyDeclaredException(name, false);
    }
sebastien's avatar
sebastien committed
54

sebastien's avatar
sebastien committed
55
56
57
58
59
60
  int id = size++;

  symbol_table[name] = id;
  type_table.push_back(type);
  name_table.push_back(name);
  tex_name_table.push_back(tex_name);
sebastien's avatar
sebastien committed
61
62

  return id;
sebastien's avatar
sebastien committed
63
64
}

sebastien's avatar
sebastien committed
65
int
66
67
68
69
70
SymbolTable::addSymbol(const string &name, SymbolType type) throw (AlreadyDeclaredException, FrozenException)
{
  // Construct "tex_name" by prepending an antislash to all underscores in "name"
  string tex_name = name;
  size_t pos = 0;
71
  while ((pos = tex_name.find('_', pos)) != string::npos)
72
73
74
75
    {
      tex_name.insert(pos, "\\");
      pos += 2;
    }
sebastien's avatar
sebastien committed
76
  return addSymbol(name, type, tex_name);
77
78
}

sebastien's avatar
sebastien committed
79
80
81
82
83
void
SymbolTable::freeze() throw (FrozenException)
{
  if (frozen)
    throw FrozenException();
84

sebastien's avatar
sebastien committed
85
86
  frozen = true;

87
  for (int i = 0; i < size; i++)
88
    {
sebastien's avatar
sebastien committed
89
      int tsi;
90
      switch (getType(i))
sebastien's avatar
sebastien committed
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
        {
        case eEndogenous:
          tsi = endo_ids.size();
          endo_ids.push_back(i);
          break;
        case eExogenous:
          tsi = exo_ids.size();
          exo_ids.push_back(i);
          break;
        case eExogenousDet:
          tsi = exo_det_ids.size();
          exo_det_ids.push_back(i);
          break;
        case eParameter:
          tsi = param_ids.size();
          param_ids.push_back(i);
          break;
        default:
          tsi = -1;
          break;
        }
      type_specific_ids.push_back(tsi);
    }
}

void
SymbolTable::changeType(int id, SymbolType newtype) throw (UnknownSymbolIDException, FrozenException)
{
  if (frozen)
    throw FrozenException();

  if (id < 0 || id >= size)
    throw UnknownSymbolIDException(id);

  type_table[id] = newtype;
}

int
SymbolTable::getID(SymbolType type, int tsid) const throw (UnknownTypeSpecificIDException, NotYetFrozenException)
{
  if (!frozen)
    throw NotYetFrozenException();

134
  switch (type)
sebastien's avatar
sebastien committed
135
136
137
138
139
140
    {
    case eEndogenous:
      if (tsid < 0 || tsid >= (int) endo_ids.size())
        throw UnknownTypeSpecificIDException(tsid, type);
      else
        return endo_ids[tsid];
141
    case eExogenous:
sebastien's avatar
sebastien committed
142
143
144
145
      if (tsid < 0 || tsid >= (int) exo_ids.size())
        throw UnknownTypeSpecificIDException(tsid, type);
      else
        return exo_ids[tsid];
146
    case eExogenousDet:
sebastien's avatar
sebastien committed
147
148
149
150
      if (tsid < 0 || tsid >= (int) exo_det_ids.size())
        throw UnknownTypeSpecificIDException(tsid, type);
      else
        return exo_det_ids[tsid];
151
    case eParameter:
sebastien's avatar
sebastien committed
152
153
154
155
156
157
      if (tsid < 0 || tsid >= (int) param_ids.size())
        throw UnknownTypeSpecificIDException(tsid, type);
      else
        return param_ids[tsid];
    default:
      throw UnknownTypeSpecificIDException(tsid, type);
158
159
160
    }
}

sebastien's avatar
sebastien committed
161
void
sebastien's avatar
sebastien committed
162
SymbolTable::writeOutput(ostream &output) const throw (NotYetFrozenException)
163
{
sebastien's avatar
sebastien committed
164
165
166
167
  if (!frozen)
    throw NotYetFrozenException();

  if (exo_nbr() > 0)
168
    {
sebastien's avatar
sebastien committed
169
170
171
      output << "M_.exo_names = '" << getName(exo_ids[0]) << "';" << endl;
      output << "M_.exo_names_tex = '" << getTeXName(exo_ids[0]) << "';" << endl;
      for (int id = 1; id < exo_nbr(); id++)
172
        {
173
174
          output << "M_.exo_names = char(M_.exo_names, '" << getName(exo_ids[id]) << "');" << endl
                 << "M_.exo_names_tex = char(M_.exo_names_tex, '" << getTeXName(exo_ids[id]) << "');" << endl;
175
176
        }
    }
sebastien's avatar
sebastien committed
177
  if (exo_det_nbr() > 0)
178
    {
sebastien's avatar
sebastien committed
179
180
181
      output << "M_.exo_det_names = '" << getName(exo_det_ids[0]) << "';" << endl;
      output << "M_.exo_det_names_tex = '" << getTeXName(exo_det_ids[0]) << "';" << endl;
      for (int id = 1; id < exo_det_nbr(); id++)
182
        {
183
184
          output << "M_.exo_det_names = char(M_.exo_det_names, '" << getName(exo_det_ids[id]) << "');" << endl
                 << "M_.exo_det_names_tex = char(M_.exo_det_names_tex, '" << getTeXName(exo_det_ids[id]) << "');" << endl;
185
186
        }
    }
sebastien's avatar
sebastien committed
187
  if (endo_nbr() > 0)
188
    {
sebastien's avatar
sebastien committed
189
190
191
      output << "M_.endo_names = '" << getName(endo_ids[0]) << "';" << endl;
      output << "M_.endo_names_tex = '" << getTeXName(endo_ids[0]) << "';" << endl;
      for (int id = 1; id < endo_nbr(); id++)
192
        {
193
194
          output << "M_.endo_names = char(M_.endo_names, '" << getName(endo_ids[id]) << "');" << endl
                 << "M_.endo_names_tex = char(M_.endo_names_tex, '" << getTeXName(endo_ids[id]) << "');" << endl;
195
196
        }
    }
sebastien's avatar
sebastien committed
197
  if (param_nbr() > 0)
198
    {
sebastien's avatar
sebastien committed
199
200
201
      output << "M_.param_names = '" << getName(param_ids[0]) << "';" << endl;
      output << "M_.param_names_tex = '" << getTeXName(param_ids[0]) << "';" << endl;
      for (int id = 1; id < param_nbr(); id++)
202
        {
203
204
          output << "M_.param_names = char(M_.param_names, '" << getName(param_ids[id]) << "');" << endl
                 << "M_.param_names_tex = char(M_.param_names_tex, '" << getTeXName(param_ids[id]) << "');" << endl;
205
206
207

          if (getName(param_ids[id]) == "dsge_prior_weight")
            output << "options_.dsge_var = 1;" << endl;
208
209
210
        }
    }

sebastien's avatar
sebastien committed
211
212
213
214
  output << "M_.exo_det_nbr = " << exo_det_nbr() << ";" << endl
         << "M_.exo_nbr = " << exo_nbr() << ";" << endl
         << "M_.endo_nbr = " << endo_nbr() << ";" << endl
         << "M_.param_nbr = " << param_nbr() << ";" << endl;
sebastien's avatar
sebastien committed
215

sebastien's avatar
sebastien committed
216
  // Write the auxiliary variable table
217
  output << "M_.orig_endo_nbr = " << orig_endo_nbr() << ";" << endl;
sebastien's avatar
sebastien committed
218
219
220
  if (aux_vars.size() == 0)
    output << "M_.aux_vars = [];" << endl;
  else
221
    for (int i = 0; i < (int) aux_vars.size(); i++)
sebastien's avatar
sebastien committed
222
      {
223
224
225
        output << "M_.aux_vars(" << i+1 << ").endo_index = " << getTypeSpecificID(aux_vars[i].get_symb_id())+1 << ";" << endl
               << "M_.aux_vars(" << i+1 << ").type = " << aux_vars[i].get_type() << ";" << endl;
        switch (aux_vars[i].get_type())
sebastien's avatar
sebastien committed
226
227
228
229
230
231
232
          {
          case avEndoLead:
          case avExoLead:
          case avExpectation:
            break;
          case avEndoLag:
          case avExoLag:
233
234
            output << "M_.aux_vars(" << i+1 << ").orig_index = " << getTypeSpecificID(aux_vars[i].get_orig_symb_id())+1 << ";" << endl
                   << "M_.aux_vars(" << i+1 << ").orig_lead_lag = " << aux_vars[i].get_orig_lead_lag() << ";" << endl;
sebastien's avatar
sebastien committed
235
            break;
236
237
238
          case avMultiplier:
            output << "M_.aux_vars(" << i+1 << ").eq_nbr = '" << aux_vars[i].get_equation_number_for_multiplier() << "';" << endl;
            break;
sebastien's avatar
sebastien committed
239
240
          }
      }
sebastien's avatar
sebastien committed
241
242
243
244

  if (predeterminedNbr() > 0)
    {
      output << "M_.predetermined_variables = [ ";
245
246
      for (set<int>::const_iterator it = predetermined_variables.begin();
           it != predetermined_variables.end(); it++)
247
        output << getTypeSpecificID(*it)+1 << " ";
sebastien's avatar
sebastien committed
248
249
      output << "];" << endl;
    }
Sébastien Villemot's avatar
Sébastien Villemot committed
250
251
252
253
254
255

  if (observedVariablesNbr() > 0)
    {
      output << "options_.varobs = [];" << endl;
      for (vector<int>::const_iterator it = varobs.begin();
           it != varobs.end(); it++)
256
257
258
259
        if (it == varobs.begin())
          output << "options_.varobs = '" << getName(*it) << "';" << endl;
        else
          output << "options_.varobs = char(options_.varobs, '" << getName(*it) << "');" << endl;
260
261
262
263
264
265

      output << "options_.varobs_id = [ ";
      for (vector<int>::const_iterator it = varobs.begin();
           it != varobs.end(); it++)
        output << getTypeSpecificID(*it)+1 << " ";
      output << " ];"  << endl;
Sébastien Villemot's avatar
Sébastien Villemot committed
266
    }
sebastien's avatar
sebastien committed
267
268
269
}

int
sebastien's avatar
sebastien committed
270
SymbolTable::addLeadAuxiliaryVarInternal(bool endo, int index) throw (FrozenException)
sebastien's avatar
sebastien committed
271
272
{
  ostringstream varname;
sebastien's avatar
sebastien committed
273
274
275
276
277
  if (endo)
    varname << "AUX_ENDO_LEAD_";
  else
    varname << "AUX_EXO_LEAD_";
  varname << index;
sebastien's avatar
sebastien committed
278
279
280
281
282
  int symb_id;
  try
    {
      symb_id = addSymbol(varname.str(), eEndogenous);
    }
283
  catch (AlreadyDeclaredException &e)
sebastien's avatar
sebastien committed
284
285
286
287
288
    {
      cerr << "ERROR: you should rename your variable called " << varname.str() << ", this name is internally used by Dynare" << endl;
      exit(EXIT_FAILURE);
    }

289
  aux_vars.push_back(AuxVarInfo(symb_id, (endo ? avEndoLead : avExoLead), 0, 0, 0));
sebastien's avatar
sebastien committed
290
291
292
293
294

  return symb_id;
}

int
sebastien's avatar
sebastien committed
295
SymbolTable::addLagAuxiliaryVarInternal(bool endo, int orig_symb_id, int orig_lead_lag) throw (FrozenException)
sebastien's avatar
sebastien committed
296
297
{
  ostringstream varname;
sebastien's avatar
sebastien committed
298
299
300
301
  if (endo)
    varname << "AUX_ENDO_LAG_";
  else
    varname << "AUX_EXO_LAG_";
302
  varname << orig_symb_id << "_" << -orig_lead_lag;
303

sebastien's avatar
sebastien committed
304
305
306
307
308
  int symb_id;
  try
    {
      symb_id = addSymbol(varname.str(), eEndogenous);
    }
309
  catch (AlreadyDeclaredException &e)
sebastien's avatar
sebastien committed
310
311
312
313
314
    {
      cerr << "ERROR: you should rename your variable called " << varname.str() << ", this name is internally used by Dynare" << endl;
      exit(EXIT_FAILURE);
    }

315
  aux_vars.push_back(AuxVarInfo(symb_id, (endo ? avEndoLag : avExoLag), orig_symb_id, orig_lead_lag, 0));
sebastien's avatar
sebastien committed
316
317

  return symb_id;
318
}
319

sebastien's avatar
sebastien committed
320
321
322
323
324
325
int
SymbolTable::addEndoLeadAuxiliaryVar(int index) throw (FrozenException)
{
  return addLeadAuxiliaryVarInternal(true, index);
}

326
int
sebastien's avatar
sebastien committed
327
SymbolTable::addEndoLagAuxiliaryVar(int orig_symb_id, int orig_lead_lag) throw (FrozenException)
328
{
sebastien's avatar
sebastien committed
329
  return addLagAuxiliaryVarInternal(true, orig_symb_id, orig_lead_lag);
330
331
332
}

int
sebastien's avatar
sebastien committed
333
SymbolTable::addExoLeadAuxiliaryVar(int index) throw (FrozenException)
334
{
sebastien's avatar
sebastien committed
335
  return addLeadAuxiliaryVarInternal(false, index);
336
337
338
}

int
sebastien's avatar
sebastien committed
339
SymbolTable::addExoLagAuxiliaryVar(int orig_symb_id, int orig_lead_lag) throw (FrozenException)
340
{
sebastien's avatar
sebastien committed
341
  return addLagAuxiliaryVarInternal(false, orig_symb_id, orig_lead_lag);
342
}
343
344

int
345
SymbolTable::addExpectationAuxiliaryVar(int information_set, int index) throw (FrozenException)
346
347
348
{
  ostringstream varname;
  int symb_id;
349

350
351
  varname << "AUX_EXPECT_" << (information_set < 0 ? "LAG" : "LEAD") << "_"
          << abs(information_set) << "_" << index;
352

353
354
355
356
  try
    {
      symb_id = addSymbol(varname.str(), eEndogenous);
    }
357
  catch (AlreadyDeclaredException &e)
358
359
360
361
362
    {
      cerr << "ERROR: you should rename your variable called " << varname.str() << ", this name is internally used by Dynare" << endl;
      exit(EXIT_FAILURE);
    }

363
  aux_vars.push_back(AuxVarInfo(symb_id, avExpectation, 0, 0, 0));
364
365
366
367
368
369
370
371
372

  return symb_id;
}

int
SymbolTable::addMultiplierAuxiliaryVar(int index) throw (FrozenException)
{
  ostringstream varname;
  int symb_id;
373
  varname << "MULT_" << index+1;
374
375
376
377
378
379
380
381
382
383

  try
    {
      symb_id = addSymbol(varname.str(), eEndogenous);
    }
  catch (AlreadyDeclaredException &e)
    {
      cerr << "ERROR: you should rename your variable called " << varname.str() << ", this name is internally used by Dynare" << endl;
      exit(EXIT_FAILURE);
    }
384

385
  aux_vars.push_back(AuxVarInfo(symb_id, avMultiplier, 0, 0, index));
386
387
  return symb_id;
}
sebastien's avatar
sebastien committed
388

389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
int
SymbolTable::addLogAuxiliaryVar(int index) throw (FrozenException)
{
  ostringstream varname;
  int symb_id;
  varname << "AUX_LOG_" << index+1;

  try
    {
      symb_id = addSymbol(varname.str(), eEndogenous);
    }
  catch (AlreadyDeclaredException &e)
    {
      cerr << "ERROR: you should rename your variable called " << varname.str() << ", this name is internally used by Dynare" << endl;
      exit(EXIT_FAILURE);
    }

  aux_vars.push_back(AuxVarInfo(symb_id, avMultiplier, 0, 0, index));
  return symb_id;
}

int
SymbolTable::addPowAuxiliaryVar(int index) throw (FrozenException)
{
  ostringstream varname;
  int symb_id;
  varname << "AUX_POW_" << index+1;

  try
    {
      symb_id = addSymbol(varname.str(), eEndogenous);
    }
  catch (AlreadyDeclaredException &e)
    {
      cerr << "ERROR: you should rename your variable called " << varname.str() << ", this name is internally used by Dynare" << endl;
      exit(EXIT_FAILURE);
    }

  aux_vars.push_back(AuxVarInfo(symb_id, avMultiplier, 0, 0, index));
  return symb_id;
}

431
int
Sébastien Villemot's avatar
Sébastien Villemot committed
432
SymbolTable::searchAuxiliaryVars(int orig_symb_id, int orig_lead_lag) const throw (SearchFailedException)
433
{
Sébastien Villemot's avatar
Sébastien Villemot committed
434
  for (size_t i = 0; i < aux_vars.size(); i++)
435
436
    if ((aux_vars[i].get_type() == avEndoLag || aux_vars[i].get_type() == avExoLag)
        && aux_vars[i].get_orig_symb_id() == orig_symb_id && aux_vars[i].get_orig_lead_lag() == orig_lead_lag)
437
      return aux_vars[i].get_symb_id();
Sébastien Villemot's avatar
Sébastien Villemot committed
438
  throw SearchFailedException(orig_symb_id, orig_lead_lag);
439
440
}

sebastien's avatar
sebastien committed
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
void
SymbolTable::markPredetermined(int symb_id) throw (UnknownSymbolIDException, FrozenException)
{
  if (symb_id < 0 || symb_id >= size)
    throw UnknownSymbolIDException(symb_id);
  if (frozen)
    throw FrozenException();

  assert(getType(symb_id) == eEndogenous);

  predetermined_variables.insert(symb_id);
}

bool
SymbolTable::isPredetermined(int symb_id) const throw (UnknownSymbolIDException)
{
  if (symb_id < 0 || symb_id >= size)
    throw UnknownSymbolIDException(symb_id);

460
  return (predetermined_variables.find(symb_id) != predetermined_variables.end());
sebastien's avatar
sebastien committed
461
462
463
464
465
}

int
SymbolTable::predeterminedNbr() const
{
466
  return (predetermined_variables.size());
sebastien's avatar
sebastien committed
467
}
Sébastien Villemot's avatar
Sébastien Villemot committed
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497

void
SymbolTable::addObservedVariable(int symb_id) throw (UnknownSymbolIDException)
{
  if (symb_id < 0 || symb_id >= size)
    throw UnknownSymbolIDException(symb_id);

  assert(getType(symb_id) == eEndogenous);
  varobs.push_back(symb_id);
}

int
SymbolTable::observedVariablesNbr() const
{
  return (int) varobs.size();
}

bool
SymbolTable::isObservedVariable(int symb_id) const
{
  return (find(varobs.begin(), varobs.end(), symb_id) != varobs.end());
}

int
SymbolTable::getObservedVariableIndex(int symb_id) const
{
  vector<int>::const_iterator it = find(varobs.begin(), varobs.end(), symb_id);
  assert(it != varobs.end());
  return (int) (it - varobs.begin());
}
498
499
500
501
502
503
504

vector <int>
SymbolTable::getTrendVarIds() const
{
  vector <int> trendVars;
  for (symbol_table_type::const_iterator it = symbol_table.begin();
       it != symbol_table.end(); it++)
505
    if (getType(it->second) == eTrend || getType(it->second) == eLogTrend)
506
507
508
      trendVars.push_back(it->second);
  return trendVars;
}
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530

set<int>
SymbolTable::getExogenous() const
{
  set <int> exogs;
  for (symbol_table_type::const_iterator it = symbol_table.begin();
       it != symbol_table.end(); it++)
    if (getType(it->second) == eExogenous)
      exogs.insert(it->second);
  return exogs;
}

set<int>
SymbolTable::getEndogenous() const
{
  set <int> endogs;
  for (symbol_table_type::const_iterator it = symbol_table.begin();
       it != symbol_table.end(); it++)
    if (getType(it->second) == eEndogenous)
      endogs.insert(it->second);
  return endogs;
}