xpress_interface_meta.cpp

/*
 *    This file is part of CasADi.
 *
 *    CasADi -- A symbolic framework for dynamic optimization.
 *    Copyright (C) 2010-2023 Joel Andersson, Joris Gillis, Moritz Diehl,
 *                            KU Leuven. All rights reserved.
 *    Copyright (C) 2011-2014 Greg Horn
 *
 *    CasADi is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 3 of the License, or (at your option) any later version.
 *
 *    CasADi is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with CasADi; if not, write to the Free Software
 *    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
 
 
      #include "xpress_interface.hpp"
      #include <string>
 
      const std::string casadi::XpressInterface::meta_doc=
      "\n"
"\n"
"\n"
"Interface to FICO Xpress Optimizer for sparse Linear, Quadratic and \n"
"Mixed-Integer Quadratic Programs. See https://www.fico.com/en/products/fico-xpress-optimization  for more information and the Xpress reference manual for the list of \n"
"controls (options) accepted under the  xpress option dict.\n"
"\n"
"Extra doc: https://github.com/casadi/casadi/wiki/L_xpress \n"
"\n"
"\n"
">List of available options\n"
"\n"
"+-------------+-----------------------+------------------------------------+\n"
"|     Id      |         Type          |            Description             |\n"
"+=============+=======================+====================================+\n"
"| compute_iis | OT_BOOL               | When the problem is infeasible,    |\n"
"|             |                       | compute an IIS immediately after   |\n"
"|             |                       | the solve and expose it in         |\n"
"|             |                       | get_stats() as iis_rows /          |\n"
"|             |                       | iis_cols. IIS computation can be   |\n"
"|             |                       | expensive; set to false to skip it |\n"
"|             |                       | [Default false].                   |\n"
"+-------------+-----------------------+------------------------------------+\n"
"| log_file    | OT_STRING             | Write solver log to this file path |\n"
"|             |                       | via XPRSsetlogfile. Useful for     |\n"
"|             |                       | capturing output (e.g. warm-start  |\n"
"|             |                       | acceptance messages) in automated  |\n"
"|             |                       | tests. Empty string (default)      |\n"
"|             |                       | disables file logging.             |\n"
"+-------------+-----------------------+------------------------------------+\n"
"| mip_start   | OT_BOOL               | Pass x0 as an initial integer      |\n"
"|             |                       | solution hint to Xpress via        |\n"
"|             |                       | XPRSaddmipsol before the MIP solve |\n"
"|             |                       | [Default false].                   |\n"
"+-------------+-----------------------+------------------------------------+\n"
"| sos_groups  | OT_INTVECTORVECTOR    | Definition of SOS groups by        |\n"
"|             |                       | indices.                           |\n"
"+-------------+-----------------------+------------------------------------+\n"
"| sos_types   | OT_INTVECTOR          | Specify 1 or 2 for each SOS group. |\n"
"+-------------+-----------------------+------------------------------------+\n"
"| sos_weights | OT_DOUBLEVECTORVECTOR | Weights corresponding to SOS       |\n"
"|             |                       | entries.                           |\n"
"+-------------+-----------------------+------------------------------------+\n"
"| xpress      | OT_DICT               | Options to be passed to FICO       |\n"
"|             |                       | Xpress. Each entry's key is the    |\n"
"|             |                       | Xpress control name (e.g.          |\n"
"|             |                       | \"OUTPUTLOG\", \"MAXTIME\",            |\n"
"|             |                       | \"MIPRELSTOP\"); the value's type    |\n"
"|             |                       | must match the control's type (int |\n"
"|             |                       | / double / string).                |\n"
"+-------------+-----------------------+------------------------------------+\n"
"\n"
"\n"
"\n"
"\n"
;