DynamicModel.hh

/*
 * Copyright © 2003-2024 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/>.
 */

#ifndef DYNAMIC_MODEL_HH
#define DYNAMIC_MODEL_HH

#include <filesystem>
#include <fstream>

#include "Bytecode.hh"
#include "StaticModel.hh"

using namespace std;

//! Stores a dynamic model
class DynamicModel : public ModelTree
{
  friend class StaticModel; // For reading static_mfs from converting constructor
public:
  //! A reference to the trend component model table
  TrendComponentModelTable& trend_component_model_table;
  //! A reference to the VAR model table
  VarModelTable& var_model_table;
  /* Used in the balanced growth test, for determining whether the
     cross-derivative of a given equation, w.r.t. an endogenous and a trend
     variable is zero. Controlled by option “balanced_growth_test_tol” of the
     “model” block. The default should not be too small (see dynare#1389). */
  double balanced_growth_test_tol {1e-6};

  /* For a given equation, tracks all the regimes and the declared alternatives with combinations of
     bind and relax tags */
  class OccbinRegimeTracker
  {
  private:
    // The list of constraints used for this equation
    vector<string> constraints;
    /* The list of regimes present for this equation; each regime is a vector of boolean, of same
       length as “constraints”; each boolean represents a constraint (in the order of
       “constraints”): false for relax, true for bind */
    set<vector<bool>> regimes_present;

  public:
    struct ConstraintInBothBindAndRelaxException
    {
      const string constraint;
    };
    struct RegimeAlreadyPresentException
    {
      const vector<string> constraints_bind, constraints_relax;
    };
    void addRegime(const vector<string>& constraints_bind,
                   const vector<string>& constraints_relax) noexcept(false);
    struct MissingRegimeException
    {