k_ord_dynare.cc 11.8 KB
Newer Older
george's avatar
george committed
1
/*
2
 * Copyright (C) 2008-2011 Dynare Team
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
 *
 * 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/>.
 */
george's avatar
george committed
19 20 21 22 23

// GP, based on work by O.Kamenik

#include <vector>
#include "first_order.h"
24
#include "dynamic_abstract_class.hh"
george's avatar
george committed
25

26
#include <cmath>
sebastien's avatar
sebastien committed
27
#include <sstream>
george's avatar
george committed
28 29 30

#include "memory_file.h"

31 32 33
#include <iostream>
#include <fstream>

george's avatar
george committed
34 35 36 37
/**************************************************************************************/
/*       Dynare DynamicModel class                                                                 */
/**************************************************************************************/

38 39
KordpDynare::KordpDynare(const vector<string> &endo, int num_endo,
                         const vector<string> &exo, int nexog, int npar,
40 41
                         Vector &ysteady, TwoDMatrix &vcov, Vector &inParams, int nstat,
                         int npred, int nforw, int nboth, const int jcols, const Vector &nnzd,
42
                         const int nsteps, int norder,
43
                         Journal &jr, DynamicModelAC *dynamicModelFile_arg, double sstol,
44
                         const vector<int> &var_order, const TwoDMatrix &llincidence, double criterium) throw (TLException) :
sebastien's avatar
sebastien committed
45 46
  nStat(nstat), nBoth(nboth), nPred(npred), nForw(nforw), nExog(nexog), nPar(npar),
  nYs(npred + nboth), nYss(nboth + nforw), nY(num_endo), nJcols(jcols), NNZD(nnzd), nSteps(nsteps),
47
  nOrder(norder), journal(jr), ySteady(ysteady), params(inParams), vCov(vcov),
48
  md(1), dnl(*this, endo), denl(*this, exo), dsnl(*this, dnl, denl), ss_tol(sstol), varOrder(var_order),
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
  ll_Incidence(llincidence), qz_criterium(criterium), dynamicModelFile(dynamicModelFile_arg), g1p(NULL),
  g2p(NULL), g3p(NULL)
{
  ReorderDynareJacobianIndices();

  //	Initialise ModelDerivativeContainer(*this, this->md, nOrder);
  for (int iord = 1; iord <= nOrder; iord++)
    md.insert(new FSSparseTensor(iord, nY+nYs+nYss+nExog, nY));
}

KordpDynare::KordpDynare(const vector<string> &endo, int num_endo,
                         const vector<string> &exo, int nexog, int npar,
                         Vector &ysteady, TwoDMatrix &vcov, Vector &inParams, int nstat,
                         int npred, int nforw, int nboth, const int jcols, const Vector &nnzd,
                         const int nsteps, int norder,
                         Journal &jr, DynamicModelAC *dynamicModelFile_arg, double sstol,
                         const vector<int> &var_order, const TwoDMatrix &llincidence, double criterium,
			 TwoDMatrix *g1_arg, TwoDMatrix *g2_arg, TwoDMatrix *g3_arg) throw (TLException) :
  nStat(nstat), nBoth(nboth), nPred(npred), nForw(nforw), nExog(nexog), nPar(npar),
  nYs(npred + nboth), nYss(nboth + nforw), nY(num_endo), nJcols(jcols), NNZD(nnzd), nSteps(nsteps),
  nOrder(norder), journal(jr), ySteady(ysteady), params(inParams), vCov(vcov),
  md(1), dnl(*this, endo), denl(*this, exo), dsnl(*this, dnl, denl), ss_tol(sstol), varOrder(var_order),
  ll_Incidence(llincidence), qz_criterium(criterium), dynamicModelFile(dynamicModelFile_arg), 
  g1p(g1_arg), g2p(g2_arg), g3p(g3_arg)
george's avatar
george committed
73
{
74
  ReorderDynareJacobianIndices();
75

sebastien's avatar
sebastien committed
76 77
  //	Initialise ModelDerivativeContainer(*this, this->md, nOrder);
  for (int iord = 1; iord <= nOrder; iord++)
78
    md.insert(new FSSparseTensor(iord, nY+nYs+nYss+nExog, nY));
george's avatar
george committed
79 80 81 82
}

KordpDynare::~KordpDynare()
{
83
  // No need to manually delete tensors in "md", they are deleted by the TensorContainer destructor
george's avatar
george committed
84 85
}

86
void
sebastien's avatar
sebastien committed
87
KordpDynare::solveDeterministicSteady()
george's avatar
george committed
88 89 90 91 92
{
  JournalRecordPair pa(journal);
  pa << "Non-linear solver for deterministic steady state By-passed " << endrec;
}

93
void
sebastien's avatar
sebastien committed
94
KordpDynare::evaluateSystem(Vector &out, const Vector &yy, const Vector &xx) throw (DynareException)
george's avatar
george committed
95
{
96 97
  // This method is only called when checking the residuals at steady state (Approximation::check), so return zero residuals
  out.zeros();
george's avatar
george committed
98 99
}

100 101
void
KordpDynare::evaluateSystem(Vector &out, const Vector &yym, const Vector &yy,
sebastien's avatar
sebastien committed
102
                            const Vector &yyp, const Vector &xx) throw (DynareException)
george's avatar
george committed
103
{
104 105
  // This method is only called when checking the residuals at steady state (Approximation::check), so return zero residuals
  out.zeros();
george's avatar
george committed
106
}
sebastien's avatar
sebastien committed
107

george's avatar
george committed
108
/************************************************
109 110 111 112
 * this is main derivative calculation functin that indirectly calls dynamic.dll
 * which performs actual calculation and reorders
 ***************************************************/
void
113
KordpDynare::calcDerivativesAtSteady() throw (DynareException)
george's avatar
george committed
114
{
115
  if (g1p == NULL)
116
    {
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
      g1p = new TwoDMatrix(nY, nJcols);
      g1p->zeros();
      
      if (nOrder > 1)
	{
	  // allocate space for sparse Hessian
	  g2p = new TwoDMatrix((int) NNZD[1], 3);
	  g2p->zeros();
	}
      
      if (nOrder > 2)
	{
	  g3p = new TwoDMatrix((int) NNZD[2], 3);
	  g3p->zeros();
	}

      Vector xx(nexog());
      xx.zeros();
      
      Vector out(nY);
      out.zeros();
      Vector llxSteady(nJcols-nExog);
      LLxSteady(ySteady, llxSteady);
      
      dynamicModelFile->eval(llxSteady, xx, params, ySteady, out, g1p, g2p, g3p);
142
    }
143

144 145
  populateDerivativesContainer(*g1p, 1, JacobianIndices);
  delete g1p;
146

147
  if (nOrder > 1)
george's avatar
george committed
148
    {
149 150
      populateDerivativesContainer(*g2p, 2, JacobianIndices);
      delete g2p;
george's avatar
george committed
151
    }
152
  if (nOrder > 2)
george's avatar
george committed
153
    {
154 155
      populateDerivativesContainer(*g3p, 3, JacobianIndices);
      delete g3p;
george's avatar
george committed
156
    }
george's avatar
george committed
157 158 159
}

/*******************************************************************************
sebastien's avatar
sebastien committed
160 161
 * populateDerivatives to sparse Tensor and fit it in the Derivatives Container
 *******************************************************************************/
162
void
163
KordpDynare::populateDerivativesContainer(const TwoDMatrix &g, int ord, const vector<int> &vOrder)
george's avatar
george committed
164
{
165
  // model derivatives FSSparseTensor instance
166
  FSSparseTensor *mdTi = (new FSSparseTensor(ord, nJcols, nY));
167 168 169

  IntSequence s(ord, 0);

170 171
  if (ord == 1)
    {
172
      for (int i = 0; i < g.ncols(); i++)
sebastien's avatar
sebastien committed
173
        {
174
          for (int j = 0; j < g.nrows(); j++)
sebastien's avatar
sebastien committed
175 176 177
            {
              double x;
              if (s[0] < nJcols-nExog)
178
                x = g.get(j, vOrder[s[0]]);
sebastien's avatar
sebastien committed
179
              else
180
                x = g.get(j, s[0]);
sebastien's avatar
sebastien committed
181 182 183 184 185
              if (x != 0.0)
                mdTi->insert(s, j, x);
            }
          s[0]++;
        }
186
    }
sebastien's avatar
sebastien committed
187
  else if (ord == 2)
188
    {
sebastien's avatar
sebastien committed
189 190 191
      int nJcols1 = nJcols-nExog;
      vector<int> revOrder(nJcols1);
      for (int i = 0; i < nJcols1; i++)
192 193
        revOrder[vOrder[i]] = i;
      for (int i = 0; i < g.nrows(); i++)
sebastien's avatar
sebastien committed
194
        {
195 196
          int j = (int) g.get(i, 0)-1; // hessian indices start with 1
          int i1 = (int) g.get(i, 1) -1;
197 198
          int s0 = i1 / nJcols;
          int s1 = i1 % nJcols;
sebastien's avatar
sebastien committed
199 200 201 202 203 204 205 206 207 208
          if (s0 < nJcols1)
            s[0] = revOrder[s0];
          else
            s[0] = s0;
          if (s1 < nJcols1)
            s[1] = revOrder[s1];
          else
            s[1] = s1;
          if (s[1] >= s[0])
            {
209
              double x = g.get(i, 2);
sebastien's avatar
sebastien committed
210 211 212
              mdTi->insert(s, j, x);
            }
        }
213
    }
sebastien's avatar
sebastien committed
214
  else if (ord == 3)
215 216 217 218 219
    {
      int nJcols1 = nJcols-nExog;
      int nJcols2 = nJcols*nJcols;
      vector<int> revOrder(nJcols1);
      for (int i = 0; i < nJcols1; i++)
220 221
        revOrder[vOrder[i]] = i;
      for (int i = 0; i < g.nrows(); i++)
sebastien's avatar
sebastien committed
222
        {
223 224
          int j = (int) g.get(i, 0)-1;
          int i1 = (int) g.get(i, 1) -1;
225 226 227 228
          int s0 = i1 / nJcols2;
          int i2 = i1 % nJcols2;
          int s1 = i2 / nJcols;
          int s2 = i2 % nJcols;
sebastien's avatar
sebastien committed
229 230 231 232 233 234 235 236 237 238 239 240
          if (s0 < nJcols1)
            s[0] = revOrder[s0];
          else
            s[0] = s0;
          if (s1 < nJcols1)
            s[1] = revOrder[s1];
          else
            s[1] = s1;
          if (s2 < nJcols1)
            s[2] = revOrder[s2];
          else
            s[2] = s2;
241 242 243
          double x = g.get(i, 2);
          if (s.isSorted())
            mdTi->insert(s, j, x);
sebastien's avatar
sebastien committed
244
        }
245
    }
sebastien's avatar
sebastien committed
246

george's avatar
george committed
247 248
  // md container
  md.remove(Symmetry(ord));
249
  md.insert(mdTi);
250
  // No need to delete mdTi, it will be deleted by TensorContainer destructor
george's avatar
george committed
251 252 253
}

/*********************************************************
254 255 256 257
 * LLxSteady()
 * returns ySteady extended with leads and lags suitable for
 * passing to <model>_dynamic DLL
 *************************************************************/
258 259
void
KordpDynare::LLxSteady(const Vector &yS, Vector &llxSteady) throw (DynareException, TLException)
260 261
{
  if ((nJcols-nExog) == yS.length())
sebastien's avatar
sebastien committed
262 263
    throw DynareException(__FILE__, __LINE__, "ySteady already of right size");

264
  // create temporary square 2D matrix size nEndo x nEndo (sparse)
george's avatar
george committed
265
  // for the lag, current and lead blocks of the jacobian
266 267 268 269
  if (llxSteady.length() != nJcols-nExog)
    throw DynareException(__FILE__, __LINE__, "llxSteady has wrong size");

  for (int ll_row = 0; ll_row < ll_Incidence.nrows(); ll_row++)
sebastien's avatar
sebastien committed
270 271 272
    {
      // populate (non-sparse) vector with ysteady values
      for (int i = 0; i < nY; i++)
273
        {
274 275
          if (ll_Incidence.get(ll_row, i))
            llxSteady[((int) ll_Incidence.get(ll_row, i))-1] = yS[i];
276
        }
sebastien's avatar
sebastien committed
277
    }
george's avatar
george committed
278 279 280
}

/************************************
sebastien's avatar
sebastien committed
281 282 283 284
 * Reorder DynareJacobianIndices of variables in a vector according to
 * given int * varOrder together with lead & lag incidence matrix and
 * any the extra columns for exogenous vars, and then,
 * reorders its blocks given by the varOrder and the Dynare++ expectations:
george's avatar
george committed
285

sebastien's avatar
sebastien committed
286 287
 * extra	nboth+ npred (t-1) lags
 * varOrder
288
                static:
george's avatar
george committed
289
    pred
290 291
    both
    forward
sebastien's avatar
sebastien committed
292 293
    * extra both + nforw (t+1) leads, and
    * extra exogen
294

sebastien's avatar
sebastien committed
295
    * so to match the jacobian organisation expected by the Appoximation class
george's avatar
george committed
296 297 298 299 300 301 302 303 304
      both + nforw (t+1) leads
      static
      pred
      both
      forward
      nboth+ npred  (t-1) lags
      exogen
************************************/

305 306
void
KordpDynare::ReorderDynareJacobianIndices() throw (TLException)
307 308
{
  // create temporary square 2D matrix size nEndo x nEndo (sparse)
george's avatar
george committed
309
  // for the lag, current and lead blocks of the jacobian
310
  JacobianIndices.resize(nJcols);
311
  vector <int> tmp(nY);
sebastien's avatar
sebastien committed
312 313
  int i, j, rjoff = nJcols-nExog-1;

314
  for (int ll_row = 0; ll_row < ll_Incidence.nrows(); ll_row++)
sebastien's avatar
sebastien committed
315 316 317 318
    {
      // reorder in orde-var order & populate temporary nEndo (sparse) vector with
      // the lag, current and lead blocks of the jacobian respectively
      for (i = 0; i < nY; i++)
319
        tmp[i] = ((int) ll_Incidence.get(ll_row, varOrder[i]-1));
sebastien's avatar
sebastien committed
320 321 322 323 324
      // write the reordered blocks back to the jacobian
      // in reverse order
      for (j = nY-1; j >= 0; j--)
        if (tmp[j])
          {
325
            JacobianIndices[rjoff] = tmp[j] -1;
sebastien's avatar
sebastien committed
326 327 328 329 330
            rjoff--;
            if (rjoff < 0)
              break;
          }
    }
sebastien's avatar
sebastien committed
331

george's avatar
george committed
332
  //add the indices for the nExog exogenous jacobians
333
  for (j = nJcols-nExog; j < nJcols; j++)
334
    JacobianIndices[j] = j;
george's avatar
george committed
335 336 337 338 339 340
}

/**************************************************************************************/
/*       DynareNameList class                                                         */
/**************************************************************************************/

341
DynareNameList::DynareNameList(const KordpDynare &dynare, const vector<string> &names_arg) : names(names_arg)
george's avatar
george committed
342 343 344
{
}

345
DynareStateNameList::DynareStateNameList(const KordpDynare &dynare, const DynareNameList &dnl,
346
                                         const DynareNameList &denl)
george's avatar
george committed
347
{
348
  for (int i = 0; i < dynare.nys(); i++)
349
    names.push_back(string(dnl.getName(i+dynare.nstat())));
350
  for (int i = 0; i < dynare.nexog(); i++)
351
    names.push_back(string(denl.getName(i)));
george's avatar
george committed
352
}