dple.hpp
1 /*
2  * This file is part of CasADi.
3  *
4  * CasADi -- A symbolic framework for dynamic optimization.
5  * Copyright (C) 2010-2023 Joel Andersson, Joris Gillis, Moritz Diehl,
6  * KU Leuven. All rights reserved.
7  * Copyright (C) 2011-2014 Greg Horn
8  *
9  * CasADi is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 3 of the License, or (at your option) any later version.
13  *
14  * CasADi is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with CasADi; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  *
23  */
24 
25 
26 #ifndef CASADI_DPLE_HPP
27 #define CASADI_DPLE_HPP
28 
29 #include "function.hpp"
30 
31 namespace casadi {
32 
66  CASADI_EXPORT Function dplesol(const std::string& name, const std::string& solver,
67  const SpDict& st, const Dict& opts=Dict());
68  CASADI_EXPORT MX dplesol(const MX& A, const MX& V, const std::string& solver,
69  const Dict& opts=Dict());
70  CASADI_EXPORT MXVector dplesol(const MXVector& A, const MXVector& V, const std::string& solver,
71  const Dict& opts=Dict());
72  CASADI_EXPORT DMVector dplesol(const DMVector& A, const DMVector& V, const std::string& solver,
73  const Dict& opts=Dict());
75 
79  CASADI_EXPORT std::vector<std::string> dple_in();
80 
84  CASADI_EXPORT std::vector<std::string> dple_out();
85 
89  CASADI_EXPORT std::string dple_in(casadi_int ind);
90 
94  CASADI_EXPORT std::string dple_out(casadi_int ind);
95 
99  CASADI_EXPORT casadi_int dple_n_in();
100 
104  CASADI_EXPORT casadi_int dple_n_out();
105 
107  CASADI_EXPORT bool has_dple(const std::string& name);
108 
110  CASADI_EXPORT void load_dple(const std::string& name);
111 
113  CASADI_EXPORT std::string doc_dple(const std::string& name);
114 
117 #ifndef SWIG
119 enum DpleInput {
121  DPLE_A,
123  DPLE_V,
124  DPLE_NUM_IN
125 };
126 
128 enum DpleOutput {
130  DPLE_P,
132  DPLE_NUM_OUT
133 };
134 #endif // SWIG
135 
136 } // namespace casadi
137 
138 #endif // CASADI_DPLE_HPP
Function object.
Definition: function.hpp:60
MX - Matrix expression.
Definition: mx.hpp:84
CASADI_EXPORT bool has_dple(const std::string &name)
Check if a particular plugin is available.
CASADI_EXPORT Function dplesol(const std::string &name, const std::string &solver, const SpDict &st, const Dict &opts=Dict())
CASADI_EXPORT std::vector< std::string > dple_in()
Get input scheme of DPLE solvers.
CASADI_EXPORT void load_dple(const std::string &name)
Explicitly load a plugin dynamically.
CASADI_EXPORT casadi_int dple_n_in()
Get the number of QP solver inputs.
CASADI_EXPORT std::vector< std::string > dple_out()
Get output scheme of DPLE solvers.
CASADI_EXPORT casadi_int dple_n_out()
Get the number of QP solver outputs.
CASADI_EXPORT std::string doc_dple(const std::string &name)
Get the documentation string for a plugin.
The casadi namespace.
std::vector< MX > MXVector
Definition: mx.hpp:940
GenericType::Dict Dict
C++ equivalent of Python's dict or MATLAB's struct.
std::vector< DM > DMVector
Definition: dm_fwd.hpp:34
std::map< std::string, Sparsity > SpDict
Definition: sparsity.hpp:1490