nlpsol.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_NLPSOL_HPP
#define CASADI_NLPSOL_HPP
 
#include "function.hpp"
 
namespace casadi {
 
  CASADI_EXPORT Function nlpsol(const std::string& name, const std::string& solver,
                                const SXDict& nlp, const Dict& opts=Dict());
  CASADI_EXPORT Function nlpsol(const std::string& name, const std::string& solver,
                                const MXDict& nlp, const Dict& opts=Dict());
  CASADI_EXPORT Function nlpsol(const std::string& name, const std::string& solver,
                                const std::string& fname, const Dict& opts=Dict());
  CASADI_EXPORT Function nlpsol(const std::string& name, const std::string& solver,
                                const Importer& compiler, const Dict& opts=Dict());
  CASADI_EXPORT Function nlpsol(const std::string& name, const std::string& solver,
                                const NlpBuilder& nl, const Dict& opts=Dict());
  CASADI_EXPORT Function nlpsol(const std::string& name, const std::string& solver,
                                const Function& nlp, const Dict& opts=Dict());
 
  CASADI_EXPORT std::vector<std::string> nlpsol_in();
 
  CASADI_EXPORT std::vector<std::string> nlpsol_out();
 
  CASADI_EXPORT std::string nlpsol_in(casadi_int ind);
 
  CASADI_EXPORT std::string nlpsol_out(casadi_int ind);
 
  CASADI_EXPORT casadi_int nlpsol_n_in();
 
  CASADI_EXPORT casadi_int nlpsol_n_out();
 
 
  CASADI_EXPORT double nlpsol_default_in(casadi_int ind);
  CASADI_EXPORT std::vector<double> nlpsol_default_in();
 
  CASADI_EXPORT std::vector<std::string> nlpsol_options(const std::string& name);
 
  CASADI_EXPORT std::string nlpsol_option_type(const std::string& name, const std::string& op);
 
  CASADI_EXPORT std::string nlpsol_option_info(const std::string& name, const std::string& op);
 
  CASADI_EXPORT bool has_nlpsol(const std::string& name);
 
  CASADI_EXPORT void load_nlpsol(const std::string& name);
 
  CASADI_EXPORT std::string doc_nlpsol(const std::string& name);
 
#ifndef SWIG
enum NLPInput {
  NL_X,
  NL_P,
  NL_NUM_IN
};
 
const std::vector<std::string> NL_INPUTS = {"x", "p"};
 
enum NLPOutput {
  NL_F,
  NL_G,
  NL_NUM_OUT
};
 
const std::vector<std::string> NL_OUTPUTS = {"f", "g"};
 
enum NlpsolInput {
  NLPSOL_X0,
  NLPSOL_P,
  NLPSOL_LBX,
  NLPSOL_UBX,
  NLPSOL_LBG,
  NLPSOL_UBG,
  NLPSOL_LAM_X0,
  NLPSOL_LAM_G0,
  NLPSOL_NUM_IN
};
 
enum NlpsolOutput {
  NLPSOL_X,
  NLPSOL_F,
  NLPSOL_G,
  NLPSOL_LAM_X,
  NLPSOL_LAM_G,
  NLPSOL_LAM_P,
  NLPSOL_NUM_OUT
};
#endif // SWIG
 
} // namespace casadi
 
#endif // CASADI_NLPSOL_HPP