conopt_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 "conopt_interface.hpp"
27  #include <string>
28 
29  const std::string casadi::ConoptInterface::meta_doc=
30  "\n"
31 "\n"
32 "\n"
33 "CONOPT interface\n"
34 "\n"
35 "\n"
36 ">List of available options\n"
37 "\n"
38 "+---------------+-----------+-----------------------------------+\n"
39 "| Id | Type | Description |\n"
40 "+===============+===========+===================================+\n"
41 "| conopt | OT_DICT | Options to be passed to CONOPT |\n"
42 "+---------------+-----------+-----------------------------------+\n"
43 "| debug | OT_BOOL | Print debug output: constraint |\n"
44 "| | | values at each FDEval, solution |\n"
45 "| | | vector, and option echo |\n"
46 "+---------------+-----------+-----------------------------------+\n"
47 "| exact_hessian | OT_BOOL | Provide exact Hessian to CONOPT |\n"
48 "+---------------+-----------+-----------------------------------+\n"
49 "| optfile | OT_STRING | Path to a CONOPT option file (for |\n"
50 "| | | string-valued CR-cells such as |\n"
51 "| | | Algorithm) |\n"
52 "+---------------+-----------+-----------------------------------+\n"
53 "| warm_start | OT_BOOL | Warm-start CONOPT using |\n"
54 "| | | multipliers from a prior solve to |\n"
55 "| | | infer basis status (IniStat=2) |\n"
56 "+---------------+-----------+-----------------------------------+\n"
57 "\n"
58 "\n"
59 "\n"
60 "\n"
61 ;
static const std::string meta_doc
A documentation string.