DynamicModel.cc 280 KB
Newer Older
sebastien's avatar
sebastien committed
1
/*
2
 * Copyright (C) 2003-2018 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 <iostream>
sebastien's avatar
sebastien committed
21
#include <cmath>
22
#include <cstdlib>
23
#include <cassert>
24
25
#include <cstdio>
#include <cerrno>
26
#include <algorithm>
Ferhat Mihoubi's avatar
Ferhat Mihoubi committed
27
#include <iterator>
28
#include <numeric>
sebastien's avatar
sebastien committed
29

30
31
32
#include <boost/filesystem.hpp>

#include "DynamicModel.hh"
sebastien's avatar
sebastien committed
33
34

DynamicModel::DynamicModel(SymbolTable &symbol_table_arg,
35
                           NumericalConstants &num_constants_arg,
36
                           ExternalFunctionsTable &external_functions_table_arg,
Houtan Bastani's avatar
Houtan Bastani committed
37
38
39
40
                           TrendComponentModelTable &trend_component_model_table_arg,
                           VarModelTable &var_model_table_arg) :
  ModelTree(symbol_table_arg, num_constants_arg, external_functions_table_arg,
            trend_component_model_table_arg, var_model_table_arg),
41
42
43
44
  max_lag(0), max_lead(0),
  max_endo_lag(0), max_endo_lead(0),
  max_exo_lag(0), max_exo_lead(0),
  max_exo_det_lag(0), max_exo_det_lead(0),
45
46
47
48
  max_lag_orig(0), max_lead_orig(0),
  max_endo_lag_orig(0), max_endo_lead_orig(0),
  max_exo_lag_orig(0), max_exo_lead_orig(0),
  max_exo_det_lag_orig(0), max_exo_det_lead_orig(0),
49
  dynJacobianColsNbr(0),
50
  global_temporary_terms(true)
sebastien's avatar
sebastien committed
51
52
53
{
}

sebastien's avatar
sebastien committed
54
55
VariableNode *
DynamicModel::AddVariable(int symb_id, int lag)
sebastien's avatar
sebastien committed
56
{
sebastien's avatar
sebastien committed
57
  return AddVariableInternal(symb_id, lag);
sebastien's avatar
sebastien committed
58
59
}

sebastien's avatar
sebastien committed
60
void
61
DynamicModel::compileDerivative(ofstream &code_file, unsigned int &instruction_number, int eq, int symb_id, int lag, const map_idx_t &map_idx) const
62
{
63
  auto it = first_derivatives.find({ eq, getDerivID(symbol_table.getID(SymbolType::endogenous, symb_id), lag) });
64
  if (it != first_derivatives.end())
65
    (it->second)->compile(code_file, instruction_number, false, temporary_terms, map_idx, true, false);
66
67
68
  else
    {
      FLDZ_ fldz;
69
      fldz.write(code_file, instruction_number);
70
71
    }
}
72
73

void
74
DynamicModel::compileChainRuleDerivative(ofstream &code_file, unsigned int &instruction_number, int eqr, int varr, int lag, const map_idx_t &map_idx) const
75
{
76
  auto it = first_chain_rule_derivatives.find({ eqr, { varr, lag } });
77
  if (it != first_chain_rule_derivatives.end())
78
    (it->second)->compile(code_file, instruction_number, false, temporary_terms, map_idx, true, false);
79
  else
80
81
    {
      FLDZ_ fldz;
82
      fldz.write(code_file, instruction_number);
83
    }
84
85
}

sebastien's avatar
sebastien committed
86
void
87
DynamicModel::computeTemporaryTermsOrdered()
sebastien's avatar
sebastien committed
88
{
89
  map<expr_t, pair<int, int>> first_occurence;
90
  map<expr_t, int> reference_count;
sebastien's avatar
sebastien committed
91
  BinaryOpNode *eq_node;
92
93
  first_derivatives_t::const_iterator it;
  first_chain_rule_derivatives_t::const_iterator it_chr;
sebastien's avatar
sebastien committed
94
  ostringstream tmp_s;
95
96
  v_temporary_terms.clear();
  map_idx.clear();
sebastien's avatar
sebastien committed
97

98
  unsigned int nb_blocks = getNbBlocks();
99
  v_temporary_terms = vector<vector<temporary_terms_t>>(nb_blocks);
100
  v_temporary_terms_inuse = vector<temporary_terms_inuse_t>(nb_blocks);
sebastien's avatar
sebastien committed
101
  temporary_terms.clear();
102

103
  if (!global_temporary_terms)
104
105
    {
      for (unsigned int block = 0; block < nb_blocks; block++)
sebastien's avatar
sebastien committed
106
        {
107
108
109
110
111
          reference_count.clear();
          temporary_terms.clear();
          unsigned int block_size = getBlockSize(block);
          unsigned int block_nb_mfs = getBlockMfs(block);
          unsigned int block_nb_recursives = block_size - block_nb_mfs;
112
          v_temporary_terms[block] = vector<temporary_terms_t>(block_size);
113
          for (unsigned int i = 0; i < block_size; i++)
sebastien's avatar
sebastien committed
114
            {
115
              if (i < block_nb_recursives && isBlockEquationRenormalized(block, i))
116
                getBlockEquationRenormalizedExpr(block, i)->computeTemporaryTerms(reference_count, temporary_terms, first_occurence, block, v_temporary_terms,  i);
117
              else
sebastien's avatar
sebastien committed
118
                {
119
                  eq_node = (BinaryOpNode *) getBlockEquationExpr(block, i);
120
                  eq_node->computeTemporaryTerms(reference_count, temporary_terms, first_occurence, block, v_temporary_terms,  i);
sebastien's avatar
sebastien committed
121
122
                }
            }
123
          for (block_derivatives_equation_variable_laglead_nodeid_t::const_iterator it = blocks_derivatives[block].begin(); it != (blocks_derivatives[block]).end(); it++)
124
            {
125
              expr_t id = it->second.second;
126
127
              id->computeTemporaryTerms(reference_count, temporary_terms, first_occurence, block, v_temporary_terms,  block_size-1);
            }
128
          for (derivative_t::const_iterator it = derivative_endo[block].begin(); it != derivative_endo[block].end(); it++)
129
            it->second->computeTemporaryTerms(reference_count, temporary_terms, first_occurence, block, v_temporary_terms,  block_size-1);
130
          for (derivative_t::const_iterator it = derivative_other_endo[block].begin(); it != derivative_other_endo[block].end(); it++)
131
132
133
134
            it->second->computeTemporaryTerms(reference_count, temporary_terms, first_occurence, block, v_temporary_terms,  block_size-1);
          set<int> temporary_terms_in_use;
          temporary_terms_in_use.clear();
          v_temporary_terms_inuse[block] = temporary_terms_in_use;
sebastien's avatar
sebastien committed
135
136
        }
    }
137
  else
sebastien's avatar
sebastien committed
138
    {
139
      for (unsigned int block = 0; block < nb_blocks; block++)
sebastien's avatar
sebastien committed
140
        {
141
142
143
144
          // Compute the temporary terms reordered
          unsigned int block_size = getBlockSize(block);
          unsigned int block_nb_mfs = getBlockMfs(block);
          unsigned int block_nb_recursives = block_size - block_nb_mfs;
145
          v_temporary_terms[block] = vector<temporary_terms_t>(block_size);
146
          for (unsigned int i = 0; i < block_size; i++)
147
            {
148
              if (i < block_nb_recursives && isBlockEquationRenormalized(block, i))
149
                getBlockEquationRenormalizedExpr(block, i)->computeTemporaryTerms(reference_count, temporary_terms, first_occurence, block, v_temporary_terms,  i);
150
151
              else
                {
152
                  eq_node = (BinaryOpNode *) getBlockEquationExpr(block, i);
153
154
                  eq_node->computeTemporaryTerms(reference_count, temporary_terms, first_occurence, block, v_temporary_terms, i);
                }
155
            }
156
          for (block_derivatives_equation_variable_laglead_nodeid_t::const_iterator it = blocks_derivatives[block].begin(); it != (blocks_derivatives[block]).end(); it++)
sebastien's avatar
sebastien committed
157
            {
158
              expr_t id = it->second.second;
159
              id->computeTemporaryTerms(reference_count, temporary_terms, first_occurence, block, v_temporary_terms, block_size-1);
sebastien's avatar
sebastien committed
160
            }
161
          for (derivative_t::const_iterator it = derivative_endo[block].begin(); it != derivative_endo[block].end(); it++)
162
            it->second->computeTemporaryTerms(reference_count, temporary_terms, first_occurence, block, v_temporary_terms, block_size-1);
163
          for (derivative_t::const_iterator it = derivative_other_endo[block].begin(); it != derivative_other_endo[block].end(); it++)
164
            it->second->computeTemporaryTerms(reference_count, temporary_terms, first_occurence, block, v_temporary_terms, block_size-1);
165
        }
166
      for (unsigned int block = 0; block < nb_blocks; block++)
167
        {
168
169
170
171
172
173
          // Collect the temporary terms reordered
          unsigned int block_size = getBlockSize(block);
          unsigned int block_nb_mfs = getBlockMfs(block);
          unsigned int block_nb_recursives = block_size - block_nb_mfs;
          set<int> temporary_terms_in_use;
          for (unsigned int i = 0; i < block_size; i++)
sebastien's avatar
sebastien committed
174
            {
175
              if (i < block_nb_recursives && isBlockEquationRenormalized(block, i))
176
                getBlockEquationRenormalizedExpr(block, i)->collectTemporary_terms(temporary_terms, temporary_terms_in_use, block);
177
              else
sebastien's avatar
sebastien committed
178
                {
179
                  eq_node = (BinaryOpNode *) getBlockEquationExpr(block, i);
180
                  eq_node->collectTemporary_terms(temporary_terms, temporary_terms_in_use, block);
sebastien's avatar
sebastien committed
181
182
                }
            }
183
          for (block_derivatives_equation_variable_laglead_nodeid_t::const_iterator it = blocks_derivatives[block].begin(); it != (blocks_derivatives[block]).end(); it++)
184
            {
185
              expr_t id = it->second.second;
186
187
              id->collectTemporary_terms(temporary_terms, temporary_terms_in_use, block);
            }
188
          for (derivative_t::const_iterator it = derivative_endo[block].begin(); it != derivative_endo[block].end(); it++)
189
            it->second->collectTemporary_terms(temporary_terms, temporary_terms_in_use, block);
190
          for (derivative_t::const_iterator it = derivative_other_endo[block].begin(); it != derivative_other_endo[block].end(); it++)
191
            it->second->collectTemporary_terms(temporary_terms, temporary_terms_in_use, block);
192
193
194
195
          for (derivative_t::const_iterator it = derivative_exo[block].begin(); it != derivative_exo[block].end(); it++)
            it->second->collectTemporary_terms(temporary_terms, temporary_terms_in_use, block);
          for (derivative_t::const_iterator it = derivative_exo_det[block].begin(); it != derivative_exo_det[block].end(); it++)
            it->second->collectTemporary_terms(temporary_terms, temporary_terms_in_use, block);
196
          v_temporary_terms_inuse[block] = temporary_terms_in_use;
sebastien's avatar
sebastien committed
197
        }
198
      computeTemporaryTermsMapping();
sebastien's avatar
sebastien committed
199
200
201
    }
}

202
203
204
205
206
void
DynamicModel::computeTemporaryTermsMapping()
{
  // Add a mapping form node ID to temporary terms order
  int j = 0;
207
208
  for (auto temporary_term : temporary_terms)
    map_idx[temporary_term->idx] = j++;
209
210
}

sebastien's avatar
sebastien committed
211
void
212
DynamicModel::writeModelEquationsOrdered_M(const string &basename) const
213
214
215
{
  string tmp_s, sps;
  ostringstream tmp_output, tmp1_output, global_output;
216
  expr_t lhs = nullptr, rhs = nullptr;
217
  BinaryOpNode *eq_node;
218
219
  ostringstream Ufoss;
  vector<string> Uf(symbol_table.endo_nbr(), "");
220
  map<expr_t, int> reference_count;
221
  temporary_terms_t local_temporary_terms;
222
  ofstream  output;
223
  int nze, nze_exo, nze_exo_det, nze_other_endo;
224
225
  vector<int> feedback_variables;
  ExprNodeOutputType local_output_type;
226
  Ufoss.str("");
sebastien's avatar
sebastien committed
227

Sébastien Villemot's avatar
Sébastien Villemot committed
228
  local_output_type = oMatlabDynamicModelSparse;
229
  if (global_temporary_terms)
Sébastien Villemot's avatar
Sébastien Villemot committed
230
    local_temporary_terms = temporary_terms;
231
232
233
234
235
236
237
238
239
240
241
242

  //----------------------------------------------------------------------
  //For each block
  for (unsigned int block = 0; block < getNbBlocks(); block++)
    {

      //recursive_variables.clear();
      feedback_variables.clear();
      //For a block composed of a single equation determines wether we have to evaluate or to solve the equation
      nze = derivative_endo[block].size();
      nze_other_endo = derivative_other_endo[block].size();
      nze_exo = derivative_exo[block].size();
243
      nze_exo_det = derivative_exo_det[block].size();
244
245
246
247
      BlockSimulationType simulation_type = getBlockSimulationType(block);
      unsigned int block_size = getBlockSize(block);
      unsigned int block_mfs = getBlockMfs(block);
      unsigned int block_recursive = block_size - block_mfs;
248
      deriv_node_temp_terms_t tef_terms;
Sébastien Villemot's avatar
Sébastien Villemot committed
249
      local_output_type = oMatlabDynamicModelSparse;
250
      if (global_temporary_terms)
Sébastien Villemot's avatar
Sébastien Villemot committed
251
        local_temporary_terms = temporary_terms;
252

253
254
      int prev_lag;
      unsigned int prev_var, count_col, count_col_endo, count_col_exo, count_col_exo_det, count_col_other_endo;
255
      map<pair<int, pair<int, int>>, expr_t> tmp_block_endo_derivative;
256
      for (auto it = blocks_derivatives[block].begin(); it != (blocks_derivatives[block]).end(); it++)
257
        tmp_block_endo_derivative[{ it->second.first, { it->first.second, it->first.first } }] = it->second.second;
258
259
260
      prev_var = 999999999;
      prev_lag = -9999999;
      count_col_endo = 0;
261
      for (map<pair<int, pair<int, int>>, expr_t>::const_iterator it = tmp_block_endo_derivative.begin(); it != tmp_block_endo_derivative.end(); it++)
262
263
264
265
266
267
268
269
270
271
        {
          int lag = it->first.first;
          unsigned int var = it->first.second.first;
          if (var != prev_var || lag != prev_lag)
            {
              prev_var = var;
              prev_lag = lag;
              count_col_endo++;
            }
        }
272
      map<pair<int, pair<int, int>>, expr_t> tmp_block_exo_derivative;
273
      for (auto it = derivative_exo[block].begin(); it != (derivative_exo[block]).end(); it++)
274
        tmp_block_exo_derivative[{ it->first.first, { it->first.second.second, it->first.second.first } }] = it->second;
275
276
277
      prev_var = 999999999;
      prev_lag = -9999999;
      count_col_exo = 0;
278
      for (map<pair<int, pair<int, int>>, expr_t>::const_iterator it = tmp_block_exo_derivative.begin(); it != tmp_block_exo_derivative.end(); it++)
279
280
281
282
283
284
285
286
287
288
        {
          int lag = it->first.first;
          unsigned int var = it->first.second.first;
          if (var != prev_var || lag != prev_lag)
            {
              prev_var = var;
              prev_lag = lag;
              count_col_exo++;
            }
        }
289
      map<pair<int, pair<int, int>>, expr_t> tmp_block_exo_det_derivative;
290
      for (auto it = derivative_exo_det[block].begin(); it != (derivative_exo_det[block]).end(); it++)
291
        tmp_block_exo_det_derivative[{ it->first.first, { it->first.second.second, it->first.second.first } }] = it->second;
292
293
294
      prev_var = 999999999;
      prev_lag = -9999999;
      count_col_exo_det = 0;
295
      for (map<pair<int, pair<int, int>>, expr_t>::const_iterator it = tmp_block_exo_derivative.begin(); it != tmp_block_exo_derivative.end(); it++)
296
297
298
299
300
301
302
303
304
305
        {
          int lag = it->first.first;
          unsigned int var = it->first.second.first;
          if (var != prev_var || lag != prev_lag)
            {
              prev_var = var;
              prev_lag = lag;
              count_col_exo_det++;
            }
        }
306
      map<pair<int, pair<int, int>>, expr_t> tmp_block_other_endo_derivative;
307
      for (auto it = derivative_other_endo[block].begin(); it != (derivative_other_endo[block]).end(); it++)
308
        tmp_block_other_endo_derivative[{ it->first.first, { it->first.second.second, it->first.second.first } }] = it->second;
309
310
311
      prev_var = 999999999;
      prev_lag = -9999999;
      count_col_other_endo = 0;
312
      for (map<pair<int, pair<int, int>>, expr_t>::const_iterator it = tmp_block_other_endo_derivative.begin(); it != tmp_block_other_endo_derivative.end(); it++)
313
314
315
316
317
318
319
320
321
322
323
        {
          int lag = it->first.first;
          unsigned int var = it->first.second.first;
          if (var != prev_var || lag != prev_lag)
            {
              prev_var = var;
              prev_lag = lag;
              count_col_other_endo++;
            }
        }

324
      tmp1_output.str("");
325
      tmp1_output << packageDir(basename + ".block") << "/dynamic_" << block+1 << ".m";
326
      output.open(tmp1_output.str(), ios::out | ios::binary);
327
328
329
330
331
332
333
334
      output << "%\n";
      output << "% " << tmp1_output.str() << " : Computes dynamic model for Dynare\n";
      output << "%\n";
      output << "% Warning : this file is generated automatically by Dynare\n";
      output << "%           from model file (.mod)\n\n";
      output << "%/\n";
      if (simulation_type == EVALUATE_BACKWARD || simulation_type == EVALUATE_FORWARD)
        {
335
          output << "function [y, g1, g2, g3, varargout] = dynamic_" << block+1 << "(y, x, params, steady_state, jacobian_eval, y_kmin, periods)\n";
336
337
        }
      else if (simulation_type == SOLVE_FORWARD_COMPLETE || simulation_type == SOLVE_BACKWARD_COMPLETE)
338
        output << "function [residual, y, g1, g2, g3, varargout] = dynamic_" << block+1 << "(y, x, params, steady_state, it_, jacobian_eval)\n";
339
      else if (simulation_type == SOLVE_BACKWARD_SIMPLE || simulation_type == SOLVE_FORWARD_SIMPLE)
340
        output << "function [residual, y, g1, g2, g3, varargout] = dynamic_" << block+1 << "(y, x, params, steady_state, it_, jacobian_eval)\n";
341
      else
342
        output << "function [residual, y, g1, g2, g3, b, varargout] = dynamic_" << block+1 << "(y, x, params, steady_state, periods, jacobian_eval, y_kmin, y_size, Periods)\n";
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
      BlockType block_type;
      if (simulation_type == SOLVE_TWO_BOUNDARIES_COMPLETE || simulation_type == SOLVE_TWO_BOUNDARIES_SIMPLE)
        block_type = SIMULTAN;
      else if (simulation_type == SOLVE_FORWARD_COMPLETE || simulation_type == SOLVE_BACKWARD_COMPLETE)
        block_type = SIMULTANS;
      else if ((simulation_type == SOLVE_FORWARD_SIMPLE || simulation_type == SOLVE_BACKWARD_SIMPLE
                || simulation_type == EVALUATE_BACKWARD    || simulation_type == EVALUATE_FORWARD)
               && getBlockFirstEquation(block) < prologue)
        block_type = PROLOGUE;
      else if ((simulation_type == SOLVE_FORWARD_SIMPLE || simulation_type == SOLVE_BACKWARD_SIMPLE
                || simulation_type == EVALUATE_BACKWARD    || simulation_type == EVALUATE_FORWARD)
               && getBlockFirstEquation(block) >= equations.size() - epilogue)
        block_type = EPILOGUE;
      else
        block_type = SIMULTANS;
      output << "  % ////////////////////////////////////////////////////////////////////////" << endl
             << "  % //" << string("                     Block ").substr(int (log10(block + 1))) << block + 1 << " " << BlockType0(block_type)
             << "          //" << endl
             << "  % //                     Simulation type "
             << BlockSim(simulation_type) << "  //" << endl
             << "  % ////////////////////////////////////////////////////////////////////////" << endl;
      //The Temporary terms
      if (simulation_type == EVALUATE_BACKWARD || simulation_type == EVALUATE_FORWARD)
        {
          output << "  if(jacobian_eval)\n";
368
369
          output << "    g1 = spalloc(" << block_mfs  << ", " << count_col_endo << ", " << nze << ");\n";
          output << "    g1_x=spalloc(" << block_size << ", " << count_col_exo  << ", " << nze_exo << ");\n";
370
          output << "    g1_xd=spalloc(" << block_size << ", " << count_col_exo_det  << ", " << nze_exo_det << ");\n";
371
          output << "    g1_o=spalloc(" << block_size << ", " << count_col_other_endo << ", " << nze_other_endo << ");\n";
372
373
374
375
376
          output << "  end;\n";
        }
      else
        {
          output << "  if(jacobian_eval)\n";
377
378
          output << "    g1 = spalloc(" << block_size << ", " << count_col_endo << ", " << nze << ");\n";
          output << "    g1_x=spalloc(" << block_size << ", " << count_col_exo  << ", " << nze_exo << ");\n";
379
          output << "    g1_xd=spalloc(" << block_size << ", " << count_col_exo_det  << ", " << nze_exo_det << ");\n";
380
          output << "    g1_o=spalloc(" << block_size << ", " << count_col_other_endo << ", " << nze_other_endo << ");\n";
381
382
383
          output << "  else\n";
          if (simulation_type == SOLVE_TWO_BOUNDARIES_COMPLETE || simulation_type == SOLVE_TWO_BOUNDARIES_SIMPLE)
            {
384
385
386
              output << "    g1 = spalloc(" << block_mfs << "*Periods, "
                     << block_mfs << "*(Periods+" << max_leadlag_block[block].first+max_leadlag_block[block].second+1 << ")"
                     << ", " << nze << "*Periods);\n";
387
            }
ferhat's avatar
ferhat committed
388
          else
389
390
391
392
393
394
            {
              output << "    g1 = spalloc(" << block_mfs
                     << ", " << block_mfs << ", " << nze << ");\n";
            }
          output << "  end;\n";
        }
395

396
397
398
399
      output << "  g2=0;g3=0;\n";
      if (v_temporary_terms_inuse[block].size())
        {
          tmp_output.str("");
400
401
          for (int it : v_temporary_terms_inuse[block])
            tmp_output << " T" << it;
402
403
404
405
          output << "  global" << tmp_output.str() << ";\n";
        }
      if (simulation_type == SOLVE_TWO_BOUNDARIES_COMPLETE || simulation_type == SOLVE_TWO_BOUNDARIES_SIMPLE)
        {
406
          temporary_terms_t tt2;
407
408
409
410
411
412
413
          tt2.clear();
          for (int i = 0; i < (int) block_size; i++)
            {
              if (v_temporary_terms[block][i].size() && global_temporary_terms)
                {
                  output << "  " << "% //Temporary variables initialization" << endl
                         << "  " << "T_zeros = zeros(y_kmin+periods, 1);" << endl;
414
                  for (auto it : v_temporary_terms[block][i])
415
416
                    {
                      output << "  ";
417
                      // In the following, "Static" is used to avoid getting the "(it_)" subscripting
418
                      it->writeOutput(output, oMatlabStaticModelSparse, local_temporary_terms, {});
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
                      output << " = T_zeros;" << endl;
                    }
                }
            }
        }
      if (simulation_type == SOLVE_BACKWARD_SIMPLE || simulation_type == SOLVE_FORWARD_SIMPLE || simulation_type == SOLVE_BACKWARD_COMPLETE || simulation_type == SOLVE_FORWARD_COMPLETE)
        output << "  residual=zeros(" << block_mfs << ",1);\n";
      else if (simulation_type == SOLVE_TWO_BOUNDARIES_COMPLETE || simulation_type == SOLVE_TWO_BOUNDARIES_SIMPLE)
        output << "  residual=zeros(" << block_mfs << ",y_kmin+periods);\n";
      if (simulation_type == EVALUATE_BACKWARD)
        output << "  for it_ = (y_kmin+periods):y_kmin+1\n";
      if (simulation_type == EVALUATE_FORWARD)
        output << "  for it_ = y_kmin+1:(y_kmin+periods)\n";

      if (simulation_type == SOLVE_TWO_BOUNDARIES_COMPLETE || simulation_type == SOLVE_TWO_BOUNDARIES_SIMPLE)
        {
          output << "  b = zeros(periods*y_size,1);" << endl
                 << "  for it_ = y_kmin+1:(periods+y_kmin)" << endl
                 << "    Per_y_=it_*y_size;" << endl
                 << "    Per_J_=(it_-y_kmin-1)*y_size;" << endl
                 << "    Per_K_=(it_-1)*y_size;" << endl;
          sps = "  ";
        }
      else
        if (simulation_type == EVALUATE_BACKWARD || simulation_type == EVALUATE_FORWARD)
          sps = "  ";
        else
          sps = "";
      // The equations
Houtan Bastani's avatar
Houtan Bastani committed
448
      temporary_terms_idxs_t temporary_terms_idxs;
449
450
      for (unsigned int i = 0; i < block_size; i++)
        {
451
          temporary_terms_t tt2;
452
453
454
455
          tt2.clear();
          if (v_temporary_terms[block].size())
            {
              output << "  " << "% //Temporary variables" << endl;
456
              for (auto it : v_temporary_terms[block][i])
457
                {
458
                  if (dynamic_cast<AbstractExternalFunctionNode *>(it) != nullptr)
459
                    it->writeExternalFunctionOutput(output, local_output_type, tt2, temporary_terms_idxs, tef_terms);
460

461
                  output << "  " <<  sps;
462
                  it->writeOutput(output, local_output_type, local_temporary_terms, {}, tef_terms);
463
                  output << " = ";
464
                  it->writeOutput(output, local_output_type, tt2, {}, tef_terms);
465
                  // Insert current node into tt2
466
                  tt2.insert(it);
467
468
469
470
471
472
473
                  output << ";" << endl;
                }
            }

          int variable_ID = getBlockVariableID(block, i);
          int equation_ID = getBlockEquationID(block, i);
          EquationType equ_type = getBlockEquationType(block, i);
474
          string sModel = symbol_table.getName(symbol_table.getID(SymbolType::endogenous, variable_ID));
475
          eq_node = (BinaryOpNode *) getBlockEquationExpr(block, i);
476
477
478
          lhs = eq_node->get_arg1();
          rhs = eq_node->get_arg2();
          tmp_output.str("");
479
          lhs->writeOutput(tmp_output, local_output_type, local_temporary_terms, {});
480
481
482
483
484
485
486
487
488
489
490
491
          switch (simulation_type)
            {
            case EVALUATE_BACKWARD:
            case EVALUATE_FORWARD:
            evaluation:     if (simulation_type == SOLVE_TWO_BOUNDARIES_COMPLETE || simulation_type == SOLVE_TWO_BOUNDARIES_SIMPLE)
                output << "    % equation " << getBlockEquationID(block, i)+1 << " variable : " << sModel
                       << " (" << variable_ID+1 << ") " << c_Equation_Type(equ_type) << endl;
              output << "    ";
              if (equ_type == E_EVALUATE)
                {
                  output << tmp_output.str();
                  output << " = ";
492
                  rhs->writeOutput(output, local_output_type, local_temporary_terms, {});
493
494
495
496
497
498
499
                }
              else if (equ_type == E_EVALUATE_S)
                {
                  output << "%" << tmp_output.str();
                  output << " = ";
                  if (isBlockEquationRenormalized(block, i))
                    {
500
                      rhs->writeOutput(output, local_output_type, local_temporary_terms, {});
501
502
                      output << "\n    ";
                      tmp_output.str("");
503
                      eq_node = (BinaryOpNode *) getBlockEquationRenormalizedExpr(block, i);
504
505
                      lhs = eq_node->get_arg1();
                      rhs = eq_node->get_arg2();
506
                      lhs->writeOutput(output, local_output_type, local_temporary_terms, {});
507
                      output << " = ";
508
                      rhs->writeOutput(output, local_output_type, local_temporary_terms, {});
509
510
511
512
                    }
                }
              else
                {
513
                  cerr << "Type mismatch for equation " << equation_ID+1  << "\n";
514
515
516
517
518
519
520
521
522
523
524
525
                  exit(EXIT_FAILURE);
                }
              output << ";\n";
              break;
            case SOLVE_BACKWARD_SIMPLE:
            case SOLVE_FORWARD_SIMPLE:
            case SOLVE_BACKWARD_COMPLETE:
            case SOLVE_FORWARD_COMPLETE:
              if (i < block_recursive)
                goto evaluation;
              feedback_variables.push_back(variable_ID);
              output << "  % equation " << equation_ID+1 << " variable : " << sModel
526
                     << " (" << variable_ID+1 << ") " << c_Equation_Type(equ_type) << " symb_id=" << symbol_table.getID(SymbolType::endogenous, variable_ID) << endl;
527
528
529
530
531
532
533
534
              output << "  " << "residual(" << i+1-block_recursive << ") = (";
              goto end;
            case SOLVE_TWO_BOUNDARIES_COMPLETE:
            case SOLVE_TWO_BOUNDARIES_SIMPLE:
              if (i < block_recursive)
                goto evaluation;
              feedback_variables.push_back(variable_ID);
              output << "    % equation " << equation_ID+1 << " variable : " << sModel
535
                     << " (" << variable_ID+1 << ") " << c_Equation_Type(equ_type) << " symb_id=" << symbol_table.getID(SymbolType::endogenous, variable_ID) << endl;
536
              Ufoss << "    b(" << i+1-block_recursive << "+Per_J_) = -residual(" << i+1-block_recursive << ", it_)";
537
              Uf[equation_ID] += Ufoss.str();
538
              Ufoss.str("");
539
540
541
542
543
544
              output << "    residual(" << i+1-block_recursive << ", it_) = (";
              goto end;
            default:
            end:
              output << tmp_output.str();
              output << ") - (";
545
              rhs->writeOutput(output, local_output_type, local_temporary_terms, {});
546
              output << ");\n";
sebastien's avatar
sebastien committed
547
#ifdef CONDITION
548
549
              if (simulation_type == SOLVE_TWO_BOUNDARIES_COMPLETE || simulation_type == SOLVE_TWO_BOUNDARIES_SIMPLE)
                output << "  condition(" << i+1 << ")=0;\n";
sebastien's avatar
sebastien committed
550
#endif
551
552
553
554
            }
        }
      // The Jacobian if we have to solve the block
      if (simulation_type == SOLVE_TWO_BOUNDARIES_SIMPLE || simulation_type == SOLVE_TWO_BOUNDARIES_COMPLETE)
555
        output << "  " << sps << "% Jacobian  " << endl << "    if jacobian_eval" << endl;
556
557
558
559
      else
        if (simulation_type == SOLVE_BACKWARD_SIMPLE   || simulation_type == SOLVE_FORWARD_SIMPLE
            || simulation_type == SOLVE_BACKWARD_COMPLETE || simulation_type == SOLVE_FORWARD_COMPLETE)
          output << "  % Jacobian  " << endl << "  if jacobian_eval" << endl;
sebastien's avatar
sebastien committed
560
        else
561
          output << "    % Jacobian  " << endl << "    if jacobian_eval" << endl;
562
563
564
      prev_var = 999999999;
      prev_lag = -9999999;
      count_col = 0;
565
      for (map<pair<int, pair<int, int>>, expr_t>::const_iterator it = tmp_block_endo_derivative.begin(); it != tmp_block_endo_derivative.end(); it++)
566
        {
567
568
569
          int lag = it->first.first;
          unsigned int var = it->first.second.first;
          unsigned int eq = it->first.second.second;
Ferhat Mihoubi's avatar
Ferhat Mihoubi committed
570
571
          int eqr = getBlockEquationID(block, eq);
          int varr = getBlockVariableID(block, var);
572
          if (var != prev_var || lag != prev_lag)
573
            {
574
575
576
577
              prev_var = var;
              prev_lag = lag;
              count_col++;
            }
578

579
          expr_t id = it->second;
580

581
          output << "      g1(" << eq+1 << ", " << count_col << ") = ";
582
          id->writeOutput(output, local_output_type, local_temporary_terms, {});
583
          output << "; % variable=" << symbol_table.getName(symbol_table.getID(SymbolType::endogenous, varr))
584
                 << "(" << lag
Ferhat Mihoubi's avatar
Ferhat Mihoubi committed
585
586
                 << ") " << varr+1 << ", " << var+1
                 << ", equation=" << eqr+1 << ", " << eq+1 << endl;
587
588
589
590
        }
      prev_var = 999999999;
      prev_lag = -9999999;
      count_col = 0;
591
      for (map<pair<int, pair<int, int>>, expr_t>::const_iterator it = tmp_block_exo_derivative.begin(); it != tmp_block_exo_derivative.end(); it++)
592
593
594
595
596
597
        {
          int lag = it->first.first;
          unsigned int var = it->first.second.first;
          unsigned int eq = it->first.second.second;
          int eqr = getBlockInitialEquationID(block, eq);
          if (var != prev_var || lag != prev_lag)
598
            {
599
600
601
              prev_var = var;
              prev_lag = lag;
              count_col++;
602
            }
603
604
          expr_t id = it->second;
          output << "      g1_x(" << eqr+1 << ", " << count_col << ") = ";
605
          id->writeOutput(output, local_output_type, local_temporary_terms, {});
606
          output << "; % variable=" << symbol_table.getName(symbol_table.getID(SymbolType::exogenous, var))
607
608
609
610
611
612
613
                 << "(" << lag
                 << ") " << var+1
                 << ", equation=" << eq+1 << endl;
        }
      prev_var = 999999999;
      prev_lag = -9999999;
      count_col = 0;
614
      for (map<pair<int, pair<int, int>>, expr_t>::const_iterator it = tmp_block_exo_det_derivative.begin(); it != tmp_block_exo_det_derivative.end(); it++)
615
616
617
618
619
620
        {
          int lag = it->first.first;
          unsigned int var = it->first.second.first;
          unsigned int eq = it->first.second.second;
          int eqr = getBlockInitialEquationID(block, eq);
          if (var != prev_var || lag != prev_lag)
621
            {
622
623
624
              prev_var = var;
              prev_lag = lag;
              count_col++;
625
            }
626
627
          expr_t id = it->second;
          output << "      g1_xd(" << eqr+1 << ", " << count_col << ") = ";
628
          id->writeOutput(output, local_output_type, local_temporary_terms, {});
629
          output << "; % variable=" << symbol_table.getName(symbol_table.getID(SymbolType::exogenous, var))
630
631
632
633
634
635
636
                 << "(" << lag
                 << ") " << var+1
                 << ", equation=" << eq+1 << endl;
        }
      prev_var = 999999999;
      prev_lag = -9999999;
      count_col = 0;
637
      for (map<pair<int, pair<int, int>>, expr_t>::const_iterator it = tmp_block_other_endo_derivative.begin(); it != tmp_block_other_endo_derivative.end(); it++)
638
639
640
641
642
643
        {
          int lag = it->first.first;
          unsigned int var = it->first.second.first;
          unsigned int eq = it->first.second.second;
          int eqr = getBlockInitialEquationID(block, eq);
          if (var != prev_var || lag != prev_lag)
644
            {
645
646
647
              prev_var = var;
              prev_lag = lag;
              count_col++;
648
            }
649
650
          expr_t id = it->second;

651
          output << "      g1_o(" << eqr+1 << ", " << /*var+1+(lag+block_max_lag)*block_size*/ count_col << ") = ";
652
          id->writeOutput(output, local_output_type, local_temporary_terms, {});
653
          output << "; % variable=" << symbol_table.getName(symbol_table.getID(SymbolType::endogenous, var))
654
655
656
657
658
659
660
661
662
663
664
665
                 << "(" << lag
                 << ") " << var+1
                 << ", equation=" << eq+1 << endl;
        }
      output << "      varargout{1}=g1_x;\n";
      output << "      varargout{2}=g1_xd;\n";
      output << "      varargout{3}=g1_o;\n";

      switch (simulation_type)
        {
        case EVALUATE_FORWARD:
        case EVALUATE_BACKWARD:
666
667
668
669
670
671
672
673
          output << "    end;" << endl;
          output << "  end;" << endl;
          break;
        case SOLVE_BACKWARD_SIMPLE:
        case SOLVE_FORWARD_SIMPLE:
        case SOLVE_BACKWARD_COMPLETE:
        case SOLVE_FORWARD_COMPLETE:
          output << "  else" << endl;
674
          for (auto it = blocks_derivatives[block].begin(); it != (blocks_derivatives[block]).end(); it++)
675
676
677
678
679
            {
              unsigned int eq = it->first.first;
              unsigned int var = it->first.second;
              unsigned int eqr = getBlockEquationID(block, eq);
              unsigned int varr = getBlockVariableID(block, var);
680
              expr_t id = it->second.second;
681
              int lag = it->second.first;
682
683
684
              if (lag == 0)
                {
                  output << "    g1(" << eq+1 << ", " << var+1-block_recursive << ") = ";
685
                  id->writeOutput(output, local_output_type, local_temporary_terms, {});
686
                  output << "; % variable=" << symbol_table.getName(symbol_table.getID(SymbolType::endogenous, varr))
687
688
689
690
691
                         << "(" << lag
                         << ") " << varr+1
                         << ", equation=" << eqr+1 << endl;
                }

692
693
694
695
696
            }
          output << "  end;\n";
          break;
        case SOLVE_TWO_BOUNDARIES_SIMPLE:
        case SOLVE_TWO_BOUNDARIES_COMPLETE:
697
          output << "    else" << endl;
698
          for (auto it = blocks_derivatives[block].begin(); it != (blocks_derivatives[block]).end(); it++)
699
700
701
702
703
704
            {
              unsigned int eq = it->first.first;
              unsigned int var = it->first.second;
              unsigned int eqr = getBlockEquationID(block, eq);
              unsigned int varr = getBlockVariableID(block, var);
              ostringstream tmp_output;
705
              expr_t id = it->second.second;
706
              int lag = it->second.first;
707
              if (eq >= block_recursive && var >= block_recursive)
708
709
                {
                  if (lag == 0)
710
711
712
                    Ufoss << "+g1(" << eq+1-block_recursive
                          << "+Per_J_, " << var+1-block_recursive
                          << "+Per_K_)*y(it_, " << varr+1 << ")";
713
                  else if (lag == 1)
714
715
716
                    Ufoss << "+g1(" << eq+1-block_recursive
                          << "+Per_J_, " << var+1-block_recursive
                          << "+Per_y_)*y(it_+1, " << varr+1 << ")";
717
                  else if (lag > 0)
718
719
720
                    Ufoss << "+g1(" << eq+1-block_recursive
                          << "+Per_J_, " << var+1-block_recursive
                          << "+y_size*(it_+" << lag-1 << "))*y(it_+" << lag << ", " << varr+1 << ")";
721
                  else
722
723
724
                    Ufoss << "+g1(" << eq+1-block_recursive
                          << "+Per_J_, " << var+1-block_recursive
                          << "+y_size*(it_" << lag-1 << "))*y(it_" << lag << ", " << varr+1 << ")";
725
                  Uf[eqr] += Ufoss.str();
726
727
                  Ufoss.str("");

728
729
730
731
732
733
734
735
736
737
738
739
740
                  if (lag == 0)
                    tmp_output << "     g1(" << eq+1-block_recursive << "+Per_J_, "
                               << var+1-block_recursive << "+Per_K_) = ";
                  else if (lag == 1)
                    tmp_output << "     g1(" << eq+1-block_recursive << "+Per_J_, "
                               << var+1-block_recursive << "+Per_y_) = ";
                  else if (lag > 0)
                    tmp_output << "     g1(" << eq+1-block_recursive << "+Per_J_, "
                               << var+1-block_recursive << "+y_size*(it_+" << lag-1 << ")) = ";
                  else if (lag < 0)
                    tmp_output << "     g1(" << eq+1-block_recursive << "+Per_J_, "
                               << var+1-block_recursive << "+y_size*(it_" << lag-1 << ")) = ";
                  output << " " << tmp_output.str();
741
                  id->writeOutput(output, local_output_type, local_temporary_terms, {});
742
                  output << ";";
743
                  output << " %2 variable=" << symbol_table.getName(symbol_table.getID(SymbolType::endogenous, varr))
744
745
746
                         << "(" << lag << ") " << varr+1
                         << ", equation=" << eqr+1 << " (" << eq+1 << ")" << endl;
                }
747

sebastien's avatar
sebastien committed
748
#ifdef CONDITION
749
750
              output << "  if (fabs(condition[" << eqr << "])<fabs(u[" << u << "+Per_u_]))\n";
              output << "    condition(" << eqr << ")=u(" << u << "+Per_u_);\n";
sebastien's avatar
sebastien committed
751
#endif
752
753
754
755
            }
          for (unsigned int i = 0; i < block_size; i++)
            {
              if (i >= block_recursive)
756
                output << "  " << Uf[getBlockEquationID(block, i)] << ";\n";
sebastien's avatar
sebastien committed
757
#ifdef CONDITION
758
759
              output << "  if (fabs(condition(" << i+1 << "))<fabs(u(" << i << "+Per_u_)))\n";
              output << "    condition(" << i+1 << ")=u(" << i+1 << "+Per_u_);\n";
sebastien's avatar
sebastien committed
760
#endif
761
            }
sebastien's avatar
sebastien committed
762
#ifdef CONDITION
763
764
765
766
767
768
769
770
771
772
773
774
775
776
          for (m = 0; m <= ModelBlock->Block_List[block].Max_Lead+ModelBlock->Block_List[block].Max_Lag; m++)
            {
              k = m-ModelBlock->Block_List[block].Max_Lag;
              for (i = 0; i < ModelBlock->Block_List[block].IM_lead_lag[m].size; i++)
                {
                  unsigned int eq = ModelBlock->Block_List[block].IM_lead_lag[m].Equ_Index[i];
                  unsigned int var = ModelBlock->Block_List[block].IM_lead_lag[m].Var_Index[i];
                  unsigned int u = ModelBlock->Block_List[block].IM_lead_lag[m].u[i];
                  unsigned int eqr = ModelBlock->Block_List[block].IM_lead_lag[m].Equ[i];
                  output << "  u(" << u+1 << "+Per_u_) = u(" << u+1 << "+Per_u_) / condition(" << eqr+1 << ");\n";
                }
            }
          for (i = 0; i < ModelBlock->Block_List[block].Size; i++)
            output << "  u(" << i+1 << "+Per_u_) = u(" << i+1 << "+Per_u_) / condition(" << i+1 << ");\n";
sebastien's avatar
sebastien committed
777
#endif
778
779
          output << "    end;" << endl;
          output << "  end;" << endl;
780
781
782
783
          break;
        default:
          break;
        }
784
      output << "end" << endl;
785
786
787
      output.close();
    }
}
sebastien's avatar
sebastien committed
788
789

void
790
DynamicModel::writeModelEquationsCode(const string &basename, const map_idx_t &map_idx) const
791
{
792

793
794
  ostringstream tmp_output;
  ofstream code_file;
795
  unsigned int instruction_number = 0;
796
797
  bool file_open = false;

798
799
800
  boost::filesystem::create_directories(basename + "/model/bytecode");

  string main_name = basename + "/model/bytecode/dynamic.cod";
801
  code_file.open(main_name, ios::out | ios::binary | ios::ate);
802
803
  if (!code_file.is_open())
    {
804
      cerr << "Error : Can't open file \"" << main_name << "\" for writing" << endl;
805
806
807
808
809
810
811
812
813
814
815
816
817
      exit(EXIT_FAILURE);
    }

  int count_u;
  int u_count_int = 0;
  BlockSimulationType simulation_type;
  if ((max_endo_lag > 0) && (max_endo_lead > 0))
    simulation_type = SOLVE_TWO_BOUNDARIES_COMPLETE;
  else if ((max_endo_lag >= 0) && (max_endo_lead == 0))
    simulation_type = SOLVE_FORWARD_COMPLETE;
  else
    simulation_type = SOLVE_BACKWARD_COMPLETE;

818
  Write_Inf_To_Bin_File(basename + "/model/bytecode/dynamic.bin", u_count_int, file_open, simulation_type == SOLVE_TWO_BOUNDARIES_COMPLETE, symbol_table.endo_nbr());
819
820
821
822
  file_open = true;

  //Temporary variables declaration
  FDIMT_ fdimt(temporary_terms.size());
823
824
825
  fdimt.write(code_file, instruction_number);

  vector<unsigned int> exo, exo_det, other_endo;
826

827
  for (int i = 0; i < symbol_table.exo_det_nbr(); i++)
828
    exo_det.push_back(i);
829
  for (int i = 0; i < symbol_table.exo_nbr(); i++)
830
    exo.push_back(i);
831

832
  map<pair< int, pair<int, int>>, expr_t> first_derivatives_reordered_endo;
833
  map<pair< pair<int, SymbolType>, pair<int, int>>, expr_t>  first_derivatives_reordered_exo;
834
  for (const auto & first_derivative : first_derivatives)
835
    {
836
837
      int deriv_id = first_derivative.first.second;
      unsigned int eq = first_derivative.first.first;
838
839
840
      int symb = getSymbIDByDerivID(deriv_id);
      unsigned int var = symbol_table.getTypeSpecificID(symb);
      int lag = getLagByDerivID(deriv_id);
841
      if (getTypeByDerivID(deriv_id) == SymbolType::endogenous)
842
        first_derivatives_reordered_endo[{ lag, make_pair(var, eq) }] = first_derivative.second;
843
      else if (getTypeByDerivID(deriv_id) == SymbolType::exogenous || getTypeByDerivID(deriv_id) == SymbolType::exogenousDet)
844
        first_derivatives_reordered_exo[{ { lag, getTypeByDerivID(deriv_id) }, { var, eq } }] = first_derivative.second;
845
846
847
848
    }
  int prev_var = -1;
  int prev_lag = -999999999;
  int count_col_endo = 0;
849
  for (map<pair< int, pair<int, int>>, expr_t>::const_iterator it = first_derivatives_reordered_endo.begin();
850
851
852
853
       it != first_derivatives_reordered_endo.end(); it++)
    {
      int var = it->first.second.first;
      int lag = it->first.first;
854
      if (prev_var != var || prev_lag != lag)
855
856
857
858
859
860
        {
          prev_var = var;
          prev_lag = lag;
          count_col_endo++;
        }
    }
861
862
  prev_var = -1;
  prev_lag = -999999999;