bspline_interpolant_meta.cpp
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  #include "bspline_interpolant.hpp"
27  #include <string>
28 
29  const std::string casadi::BSplineInterpolant::meta_doc=
30  "\n"
31 "\n"
32 "\n"
33 "Extra doc: https://github.com/casadi/casadi/wiki/L_239 \n"
34 "\n"
35 "\n"
36 ">List of available options\n"
37 "\n"
38 "+-----------------------+--------------+-----------------------------------+\n"
39 "| Id | Type | Description |\n"
40 "+=======================+==============+===================================+\n"
41 "| algorithm | OT_STRING | Algorithm used for fitting the |\n"
42 "| | | data: 'not_a_knot' (default, same |\n"
43 "| | | as Matlab), 'smooth_linear'. |\n"
44 "+-----------------------+--------------+-----------------------------------+\n"
45 "| degree | OT_INTVECTOR | Sets, for each grid dimension, |\n"
46 "| | | the degree of the spline. |\n"
47 "+-----------------------+--------------+-----------------------------------+\n"
48 "| linear_solver | OT_STRING | Solver used for constructing the |\n"
49 "| | | coefficient tensor. |\n"
50 "+-----------------------+--------------+-----------------------------------+\n"
51 "| linear_solver_options | OT_DICT | Options to be passed to the |\n"
52 "| | | linear solver. |\n"
53 "+-----------------------+--------------+-----------------------------------+\n"
54 "| smooth_linear_frac | OT_DOUBLE | When 'smooth_linear' algorithm is |\n"
55 "| | | active, determines sharpness |\n"
56 "| | | between 0 (sharp, as linear |\n"
57 "| | | interpolation) and 0.5 |\n"
58 "| | | (smooth).Default value is 0.1. |\n"
59 "+-----------------------+--------------+-----------------------------------+\n"
60 "\n"
61 "\n"
62 "\n"
63 "\n"
64 ;
static const std::string meta_doc
A documentation string.