madnlp_interface_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 "madnlp_interface.hpp"
27  #include <string>
28 
29  const std::string casadi::MadnlpInterface::meta_doc=
30  "\n"
31 "\n"
32 ">List of available options\n"
33 "\n"
34 "+--------------------+--------------+--------------------------------------+\n"
35 "| Id | Type | Description |\n"
36 "+====================+==============+======================================+\n"
37 "| convexify_margin | OT_DOUBLE | When using a convexification |\n"
38 "| | | strategy, make sure that the |\n"
39 "| | | smallest eigenvalue is at least this |\n"
40 "| | | (default: 1e-7). |\n"
41 "+--------------------+--------------+--------------------------------------+\n"
42 "| convexify_strategy | OT_STRING | NONE|regularize|eigen-reflect|eigen- |\n"
43 "| | | clip. Strategy to convexify the |\n"
44 "| | | Lagrange Hessian before passing it |\n"
45 "| | | to the solver. |\n"
46 "+--------------------+--------------+--------------------------------------+\n"
47 "| madnlp | OT_DICT | Options to be passed to madnlp |\n"
48 "+--------------------+--------------+--------------------------------------+\n"
49 "| ng | OT_INTVECTOR | Number of constraints |\n"
50 "+--------------------+--------------+--------------------------------------+\n"
51 "| nw | OT_INTVECTOR | Number of variables |\n"
52 "+--------------------+--------------+--------------------------------------+\n"
53 "\n"
54 "\n"
55 "\n"
56 "\n"
57 ;
static const std::string meta_doc
A documentation string.