cbc_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 "cbc_interface.hpp"
27  #include <string>
28 
29  const std::string casadi::CbcInterface::meta_doc=
30  "\n"
31 "\n"
32 "\n"
33 "Interface to Cbc solver for sparse Quadratic Programs\n"
34 "\n"
35 "Extra doc: https://github.com/casadi/casadi/wiki/L_221 \n"
36 "\n"
37 "\n"
38 ">List of available options\n"
39 "\n"
40 "+-------------+-----------------------+------------------------------------+\n"
41 "| Id | Type | Description |\n"
42 "+=============+=======================+====================================+\n"
43 "| cbc | OT_DICT | Options to be passed to CBC.Three |\n"
44 "| | | sets of options are supported. The |\n"
45 "| | | first can be found in |\n"
46 "| | | OsiSolverParameters.hpp. The |\n"
47 "| | | second can be found in |\n"
48 "| | | CbcModel.hpp. The third are |\n"
49 "| | | options that can be passed to |\n"
50 "| | | CbcMain1. |\n"
51 "+-------------+-----------------------+------------------------------------+\n"
52 "| hot_start | OT_BOOL | Hot start with x0 [Default false]. |\n"
53 "+-------------+-----------------------+------------------------------------+\n"
54 "| sos_groups | OT_INTVECTORVECTOR | Definition of SOS groups by |\n"
55 "| | | indices. |\n"
56 "+-------------+-----------------------+------------------------------------+\n"
57 "| sos_types | OT_INTVECTOR | Specify 1 or 2 for each SOS group. |\n"
58 "+-------------+-----------------------+------------------------------------+\n"
59 "| sos_weights | OT_DOUBLEVECTORVECTOR | Weights corresponding to SOS |\n"
60 "| | | entries. |\n"
61 "+-------------+-----------------------+------------------------------------+\n"
62 "\n"
63 "\n"
64 "\n"
65 "\n"
66 ;
static const std::string meta_doc
A documentation string.