gurobi_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 "gurobi_interface.hpp"
27  #include <string>
28 
29  const std::string casadi::GurobiInterface::meta_doc=
30  "\n"
31 "\n"
32 "\n"
33 "Interface to the GUROBI Solver for quadratic programming\n"
34 "\n"
35 "Extra doc: https://github.com/casadi/casadi/wiki/L_22q \n"
36 "\n"
37 "\n"
38 ">List of available options\n"
39 "\n"
40 "+-------------+-----------------------+------------------------------------+\n"
41 "| Id | Type | Description |\n"
42 "+=============+=======================+====================================+\n"
43 "| gurobi | OT_DICT | Options to be passed to gurobi. |\n"
44 "+-------------+-----------------------+------------------------------------+\n"
45 "| sos_groups | OT_INTVECTORVECTOR | Definition of SOS groups by |\n"
46 "| | | indices. |\n"
47 "+-------------+-----------------------+------------------------------------+\n"
48 "| sos_types | OT_INTVECTOR | Specify 1 or 2 for each SOS group. |\n"
49 "+-------------+-----------------------+------------------------------------+\n"
50 "| sos_weights | OT_DOUBLEVECTORVECTOR | Weights corresponding to SOS |\n"
51 "| | | entries. |\n"
52 "+-------------+-----------------------+------------------------------------+\n"
53 "| vtype | OT_STRINGVECTOR | Type of variables: [CONTINUOUS|bin |\n"
54 "| | | ary|integer|semicont|semiint] |\n"
55 "+-------------+-----------------------+------------------------------------+\n"
56 "\n"
57 "\n"
58 "\n"
59 "\n"
60 ;
static const std::string meta_doc
A documentation string.