Warning, /include/eigen3/Eigen/IterativeLinearSolvers is written in an unsupported language. File is not indexed.
0001 // This file is part of Eigen, a lightweight C++ template library
0002 // for linear algebra.
0003 //
0004 // This Source Code Form is subject to the terms of the Mozilla
0005 // Public License v. 2.0. If a copy of the MPL was not distributed
0006 // with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
0007
0008 #ifndef EIGEN_ITERATIVELINEARSOLVERS_MODULE_H
0009 #define EIGEN_ITERATIVELINEARSOLVERS_MODULE_H
0010
0011 #include "SparseCore"
0012 #include "OrderingMethods"
0013
0014 #include "src/Core/util/DisableStupidWarnings.h"
0015
0016 /**
0017 * \defgroup IterativeLinearSolvers_Module IterativeLinearSolvers module
0018 *
0019 * This module currently provides iterative methods to solve problems of the form \c A \c x = \c b, where \c A is a squared matrix, usually very large and sparse.
0020 * Those solvers are accessible via the following classes:
0021 * - ConjugateGradient for selfadjoint (hermitian) matrices,
0022 * - LeastSquaresConjugateGradient for rectangular least-square problems,
0023 * - BiCGSTAB for general square matrices.
0024 *
0025 * These iterative solvers are associated with some preconditioners:
0026 * - IdentityPreconditioner - not really useful
0027 * - DiagonalPreconditioner - also called Jacobi preconditioner, work very well on diagonal dominant matrices.
0028 * - IncompleteLUT - incomplete LU factorization with dual thresholding
0029 *
0030 * Such problems can also be solved using the direct sparse decomposition modules: SparseCholesky, CholmodSupport, UmfPackSupport, SuperLUSupport.
0031 *
0032 \code
0033 #include <Eigen/IterativeLinearSolvers>
0034 \endcode
0035 */
0036
0037 #include "src/IterativeLinearSolvers/SolveWithGuess.h"
0038 #include "src/IterativeLinearSolvers/IterativeSolverBase.h"
0039 #include "src/IterativeLinearSolvers/BasicPreconditioners.h"
0040 #include "src/IterativeLinearSolvers/ConjugateGradient.h"
0041 #include "src/IterativeLinearSolvers/LeastSquareConjugateGradient.h"
0042 #include "src/IterativeLinearSolvers/BiCGSTAB.h"
0043 #include "src/IterativeLinearSolvers/IncompleteLUT.h"
0044 #include "src/IterativeLinearSolvers/IncompleteCholesky.h"
0045
0046 #include "src/Core/util/ReenableStupidWarnings.h"
0047
0048 #endif // EIGEN_ITERATIVELINEARSOLVERS_MODULE_H
