ccopt_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 "ccopt_interface.hpp"
      #include <string>
 
      const std::string casadi::MadmpecInterface::meta_doc=
      "\n"
"\n"
">List of available options\n"
"\n"
"+--------------------+--------------------+--------------------------------+\n"
"|         Id         |        Type        |          Description           |\n"
"+====================+====================+================================+\n"
"| cc_pairs           | OT_INTVECTORVECTOR | List of complementary          |\n"
"|                    |                    | constraints on simple bounds.  |\n"
"|                    |                    | Pair (i, j) encodes            |\n"
"|                    |                    | complementarity between the    |\n"
"|                    |                    | bounds on variable i and       |\n"
"|                    |                    | variable j.                    |\n"
"+--------------------+--------------------+--------------------------------+\n"
"| cc_types           | OT_INTVECTOR       | Type of cc pairs (default: 0). |\n"
"+--------------------+--------------------+--------------------------------+\n"
"| ccopt              | OT_DICT            | Options to be passed to ccopt  |\n"
"|                    |                    | relaxation algorithm           |\n"
"+--------------------+--------------------+--------------------------------+\n"
"| convexify_margin   | OT_DOUBLE          | When using a convexification   |\n"
"|                    |                    | strategy, make sure that the   |\n"
"|                    |                    | smallest eigenvalue is at      |\n"
"|                    |                    | least this (default: 1e-7).    |\n"
"+--------------------+--------------------+--------------------------------+\n"
"| convexify_strategy | OT_STRING          | NONE|regularize|eigen-         |\n"
"|                    |                    | reflect|eigen-clip. Strategy   |\n"
"|                    |                    | to convexify the Lagrange      |\n"
"|                    |                    | Hessian before passing it to   |\n"
"|                    |                    | the solver.                    |\n"
"+--------------------+--------------------+--------------------------------+\n"
"| madnlp             | OT_DICT            | Options to be passed to madnlp |\n"
"+--------------------+--------------------+--------------------------------+\n"
"\n"
"\n"
"\n"
"\n"
;