lapack_lu_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 "lapack_lu.hpp"
27  #include <string>
28 
29  const std::string casadi::LapackLu::meta_doc=
30  "\n"
31 "\n"
32 "\n"
33 "This class solves the linear system A.x=b by making an LU factorization of A: A = L.U, with L lower and U upper triangular\n"
34 "\n"
35 "Extra doc: https://github.com/casadi/casadi/wiki/L_22h \n"
36 "\n"
37 "\n"
38 ">List of available options\n"
39 "\n"
40 "+-----------------------------+---------+----------------------------------+\n"
41 "| Id | Type | Description |\n"
42 "+=============================+=========+==================================+\n"
43 "| allow_equilibration_failure | OT_BOOL | Non-fatal error when |\n"
44 "| | | equilibration fails |\n"
45 "+-----------------------------+---------+----------------------------------+\n"
46 "| equilibration | OT_BOOL | Equilibrate the matrix |\n"
47 "+-----------------------------+---------+----------------------------------+\n"
48 "\n"
49 "\n"
50 "\n"
51 "\n"
52 ;
static const std::string meta_doc
A documentation string.
Definition: lapack_lu.hpp:120