rootfinder.hpp

/*
 *    This file is part of CasADi.
 *
 *    CasADi -- A symbolic framework for dynamic optimization.
 *    Copyright (C) 2010-2023 Joel Andersson, Joris Gillis, Moritz Diehl,
 *                            KU Leuven. All rights reserved.
 *    Copyright (C) 2011-2014 Greg Horn
 *
 *    CasADi is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 3 of the License, or (at your option) any later version.
 *
 *    CasADi 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
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with CasADi; if not, write to the Free Software
 *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
 
 
#ifndef CASADI_ROOTFINDER_HPP
#define CASADI_ROOTFINDER_HPP
 
#include "function.hpp"
#include "linsol.hpp"
 
namespace casadi {
 
 
  CASADI_EXPORT Function rootfinder(const std::string& name, const std::string& solver,
                                    const SXDict& rfp, const Dict& opts=Dict());
  CASADI_EXPORT Function rootfinder(const std::string& name, const std::string& solver,
                                    const MXDict& rfp, const Dict& opts=Dict());
  CASADI_EXPORT Function rootfinder(const std::string& name, const std::string& solver,
                               const Function& f, const Dict& opts=Dict());
 
  CASADI_EXPORT std::vector<std::string> rootfinder_in();
 
  CASADI_EXPORT std::vector<std::string> rootfinder_out();
 
  CASADI_EXPORT std::string rootfinder_in(casadi_int ind);
 
  CASADI_EXPORT std::string rootfinder_out(casadi_int ind);
 
  CASADI_EXPORT casadi_int rootfinder_n_in();
 
  CASADI_EXPORT casadi_int rootfinder_n_out();
 
  CASADI_EXPORT std::vector<std::string> rootfinder_options(const std::string& name);
 
  CASADI_EXPORT std::string rootfinder_option_type(const std::string& name, const std::string& op);
 
  CASADI_EXPORT std::string rootfinder_option_info(const std::string& name, const std::string& op);
 
  CASADI_EXPORT bool has_rootfinder(const std::string& name);
 
  CASADI_EXPORT void load_rootfinder(const std::string& name);
 
  CASADI_EXPORT std::string doc_rootfinder(const std::string& name);
  #ifndef SWIG
  enum RfpIn {
    RFP_X,
    RFP_P,
    RFP_NUM_IN};
 
  const std::vector<std::string> RFP_INPUTS = {"x", "p"};
 
  enum RfpOut {
    RFP_G,
    RFP_NUM_OUT};
 
  const std::vector<std::string> RFP_OUTPUTS = {"g"};
 
  enum RootfinderInput {
    ROOTFINDER_X0,
    ROOTFINDER_P,
    ROOTFINDER_NUM_IN
  };
 
  enum RootfinderOutput {
    ROOTFINDER_X,
    ROOTFINDER_NUM_OUT
  };
  #endif // SWIG
 
} // namespace casadi
 
#endif // CASADI_ROOTFINDER_HPP