slicot_dple_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 "slicot_dple.hpp"
27  #include <string>
28 
29  const std::string casadi::SlicotDple::meta_doc=
30  "\n"
31 "\n"
32 "\n"
33 "An efficient solver for Discrete Periodic Lyapunov Equations using \n"
34 "SLICOT\n"
35 "\n"
36 "Uses Periodic Schur Decomposition ('psd') and does not assume positive\n"
37 " definiteness. Based on Periodic Lyapunov equations: some applications\n"
38 " and new algorithms. Int. J. Control, vol. 67, pp. 69-87, 1997.\n"
39 "\n"
40 "Overview of the method: J. Gillis Practical Methods for Approximate \n"
41 "Robust Periodic Optimal Control ofNonlinear Mechanical Systems, PhD \n"
42 "Thesis, KULeuven, 2015\n"
43 "\n"
44 "Extra doc: https://github.com/casadi/casadi/wiki/L_22j \n"
45 "\n"
46 "\n"
47 ">List of available options\n"
48 "\n"
49 "+-----------------------+-----------+--------------------------------------+\n"
50 "| Id | Type | Description |\n"
51 "+=======================+===========+======================================+\n"
52 "| linear_solver | OT_STRING | User-defined linear solver class. |\n"
53 "| | | Needed for sensitivities. |\n"
54 "+-----------------------+-----------+--------------------------------------+\n"
55 "| linear_solver_options | OT_DICT | Options to be passed to the linear |\n"
56 "| | | solver. |\n"
57 "+-----------------------+-----------+--------------------------------------+\n"
58 "| psd_num_zero | OT_DOUBLE | Numerical zero used in Periodic |\n"
59 "| | | Schur decomposition with slicot.This |\n"
60 "| | | option is needed when your systems |\n"
61 "| | | has Floquet multiplierszero or close |\n"
62 "| | | to zero |\n"
63 "+-----------------------+-----------+--------------------------------------+\n"
64 "\n"
65 "\n"
66 "\n"
67 "\n"
68 ;
static const std::string meta_doc
A documentation string.