ExternalFunctionsTable.cc

/*
 * Copyright (C) 2010 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 <http://www.gnu.org/licenses/>.
 */

#include <cstdlib>
#include <cassert>
#include <cerrno>
#include <cmath>
#include <iostream>

#include "ExternalFunctionsTable.hh"
#include "SymbolTable.hh"

ExternalFunctionsTable::ExternalFunctionsTable()
{
}

void
ExternalFunctionsTable::addExternalFunction(int symb_id, const external_function_options &external_function_options_arg)
{
  assert(symb_id >= 0);

  if (external_function_options_arg.nargs <= 0)
    {
      cerr << "ERROR: The number of arguments passed to an external function must be > 0." << endl;
      exit(EXIT_FAILURE);
    }

  external_function_options external_function_options_chng = external_function_options_arg;
  if (external_function_options_arg.firstDerivSymbID  == eExtFunSetButNoNameProvided)
    external_function_options_chng.firstDerivSymbID = symb_id;

  if (external_function_options_arg.secondDerivSymbID == eExtFunSetButNoNameProvided)
    external_function_options_chng.secondDerivSymbID = symb_id;

  if (external_function_options_chng.secondDerivSymbID == symb_id &&
      external_function_options_chng.firstDerivSymbID  != symb_id)
    {
      cerr << "ERROR: If the second derivative is provided by the top-level function "
           << "the first derivative must also be provided by the same function." << endl;
      exit(EXIT_FAILURE);
    }

  if ((external_function_options_chng.secondDerivSymbID != symb_id &&
       external_function_options_chng.firstDerivSymbID  == symb_id) &&
      external_function_options_chng.secondDerivSymbID != eExtFunNotSet)
    {
      cerr << "ERROR: If the first derivative is provided by the top-level function, the "
           << "second derivative cannot be provided by any other external function." << endl;
      exit(EXIT_FAILURE);
    }

  if (external_function_options_chng.secondDerivSymbID != eExtFunNotSet&&
      external_function_options_chng.firstDerivSymbID == eExtFunNotSet)
    {
      cerr << "ERROR: If the second derivative is provided, the first derivative must also be provided." << endl;
      exit(EXIT_FAILURE);
    }

  if (external_function_options_chng.secondDerivSymbID == external_function_options_chng.firstDerivSymbID &&
      external_function_options_chng.firstDerivSymbID != symb_id &&
      external_function_options_chng.firstDerivSymbID != eExtFunNotSet)
    {
      cerr << "ERROR: If the Jacobian and Hessian are provided by the same function, that "
           << "function must be the top-level function." << endl;
      exit(EXIT_FAILURE);
    }

  if (exists(symb_id))
    {
      if (external_function_options_arg.nargs != getNargs(symb_id))
        {
          cerr << "ERROR: The number of arguments passed to the external_function() statement do not "
               << "match the number of arguments passed to a previous call or declaration of the top-level function."<< endl;
          exit(EXIT_FAILURE);
        }

      if (external_function_options_chng.firstDerivSymbID != getFirstDerivSymbID(symb_id))
        {
          cerr << "ERROR: The first derivative function passed to the external_function() statement does not "
               << "match the first derivative function passed to a previous call or declaration of the top-level function."<< endl;
          exit(EXIT_FAILURE);
        }

      if (external_function_options_chng.secondDerivSymbID != getSecondDerivSymbID(symb_id))
        {
          cerr << "ERROR: The second derivative function passed to the external_function() statement does not "
               << "match the second derivative function passed to a previous call or declaration of the top-level function."<< endl;
          exit(EXIT_FAILURE);
        }
    }
  else
    externalFunctionTable[symb_id] = external_function_options_chng;
}