interpolant.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_INTERPOLANT_HPP
27 #define CASADI_INTERPOLANT_HPP
28 
29 #include "function.hpp"
30 
31 namespace casadi {
32 
33 
101  CASADI_EXPORT Function interpolant(const std::string& name,
102  const std::string& solver,
103  const std::vector<std::vector<double> >& grid,
104  const std::vector<double>& values,
105  const Dict& opts=Dict());
115  CASADI_EXPORT Function interpolant(const std::string& name,
116  const std::string& solver,
117  const std::vector<std::vector<double> >& grid,
118  casadi_int m=1,
119  const Dict& opts=Dict());
121 
130  CASADI_EXPORT Function interpolant(const std::string& name,
131  const std::string& solver,
132  const std::vector<casadi_int>& grid_dims,
133  casadi_int m=1,
134  const Dict& opts=Dict());
135 
144  CASADI_EXPORT Function interpolant(const std::string& name,
145  const std::string& solver,
146  const std::vector<casadi_int>& grid_dims,
147  const std::vector<double>& values,
148  const Dict& opts=Dict());
149 
151  CASADI_EXPORT bool has_interpolant(const std::string& name);
152 
154  CASADI_EXPORT void load_interpolant(const std::string& name);
155 
157  CASADI_EXPORT std::string doc_interpolant(const std::string& name);
158 
161 } // namespace casadi
162 
163 #endif // CASADI_INTERPOLANT_HPP
Function object.
Definition: function.hpp:60
CASADI_EXPORT std::string doc_interpolant(const std::string &name)
Get the documentation string for a plugin.
CASADI_EXPORT Function interpolant(const std::string &name, const std::string &solver, const std::vector< std::vector< double > > &grid, const std::vector< double > &values, const Dict &opts=Dict())
CASADI_EXPORT void load_interpolant(const std::string &name)
Explicitly load a plugin dynamically.
CASADI_EXPORT bool has_interpolant(const std::string &name)
Check if a particular plugin is available.
The casadi namespace.
GenericType::Dict Dict
C++ equivalent of Python's dict or MATLAB's struct.