Safe Haskell | None |
---|---|
Language | Haskell98 |
This documentation is based on original Eigen page Solving Sparse Linear Systems
Eigen currently provides a limited set of built-in MPL2 compatible solvers. They are summarized in the following table:
Sparse solver Solver kind Matrix kind Notes ConjugateGradient Classic iterative CG SPD Recommended for large symmetric problems (e.g., 3D Poisson eq.) BiCGSTAB Iterative stabilized Square bi-conjugate gradient SparseLU LU factorization Square Optimized for small and large problems with irregular patterns SparseQR QR factorization Any, rectangular Recommended for least-square problems, has a basic rank-revealing feature
All these solvers follow the same general concept. Here is a typical and general example:
let
a :: SparseMatrixXd
a = ... -- fill a
b :: SparseMatrixXd
b = ... -- fill b
validate msg = info >>= (when
fail msg) . (/= Success)
// solve Ax = b
runSolverT solver $ do
compute a
validate "decomposition failed"
x <- solve b
validate "solving failed"
// solve for another right hand side
x1 <- solve b1
In the case where multiple problems with the same sparsity pattern have to be solved, then the "compute" step can be decomposed as follow:
runSolverT solver $ do analyzePattern a1 factorize a1 x1 <- solve b1 x2 <- solve b2 factorize a2 x1 <- solve b1 x2 <- solve b2
Finally, each solver provides some specific features, such as determinant, access to the factors, controls of the iterations, and so on.
The Compute Step
In the compute
function, the matrix is generally factorized: LLT for self-adjoint matrices, LDLT for general hermitian matrices,
LU for non hermitian matrices and QR for rectangular matrices. These are the results of using direct solvers.
For this class of solvers precisely, the compute step is further subdivided into analyzePattern
and factorize
.
The goal of analyzePattern
is to reorder the nonzero elements of the matrix, such that the factorization step creates less fill-in.
This step exploits only the structure of the matrix. Hence, the results of this step can be used for other linear systems where the
matrix has the same structure.
In factorize
, the factors of the coefficient matrix are computed. This step should be called each time the values of the matrix change.
However, the structural pattern of the matrix should not change between multiple calls.
For iterative solvers, the compute
step is used to eventually setup a preconditioner.
Remember that, basically, the goal of the preconditioner is to speedup the convergence of an iterative method by solving a modified linear
system where the coefficient matrix has more clustered eigenvalues.
For real problems, an iterative solver should always be used with a preconditioner.
The Solve Step
The solve
function computes the solution of the linear systems with one or many right hand sides.
x <- solve b
Here, b
can be a vector or a matrix where the columns form the different right hand sides.
The solve
function can be called several times as well, for instance when all the right hand sides are not available at once.
x1 <- solve b1 -- Get the second right hand side b2 x2 <- solve b2 -- ...
For direct methods, the solution are computed at the machine precision. Sometimes, the solution need not be too accurate.
In this case, the iterative methods are more suitable and the desired accuracy can be set before the solve step using setTolerance
.
- data SolverInfo
- data ComputationInfo
- type SolverT a b m = ReaderT (SolverInfo, ForeignPtr (CSolver a b)) m
- runSolverT :: (MonadIO m, Elem a b) => SolverInfo -> SolverT a b m c -> m c
- analyzePattern :: (MonadIO m, Elem a b) => SparseMatrix a b -> SolverT a b m ()
- factorize :: (MonadIO m, Elem a b) => SparseMatrix a b -> SolverT a b m ()
- compute :: (MonadIO m, Elem a b) => SparseMatrix a b -> SolverT a b m ()
- solve :: (MonadIO m, Elem a b) => SparseMatrix a b -> SolverT a b m (SparseMatrix a b)
- tolerance :: (MonadIO m, Elem a b) => SolverT a b m Double
- setTolerance :: (MonadIO m, Elem a b) => Double -> SolverT a b m ()
- maxIterations :: (MonadIO m, Elem a b) => SolverT a b m Int
- setMaxIterations :: (MonadIO m, Elem a b) => Int -> SolverT a b m ()
- info :: (MonadIO m, Elem a b) => SolverT a b m ComputationInfo
- error :: (MonadIO m, Elem a b) => SolverT a b m Double
- iterations :: (MonadIO m, Elem a b) => SolverT a b m Int
Documentation
data SolverInfo Source
ConjugateGradient | A conjugate gradient solver for sparse self-adjoint problems. This class allows to solve for The maximal number of iterations and tolerance value can be controlled via the |
BiCGSTAB | A bi conjugate gradient stabilized solver for sparse square problems. This class allows to solve for The maximal number of iterations and tolerance value can be controlled via the |
SparseLU | Sparse supernodal LU factorization for general matrices. This class implements the supernodal LU factorization for general matrices. It uses the main techniques from the sequential SuperLU package. It handles transparently real and complex arithmetics with single and double precision, depending on the scalar type of your input matrix. The code has been optimized to provide BLAS-3 operations during supernode-panel updates. It benefits directly from the built-in high-performant Eigen BLAS routines. Moreover, when the size of a supernode is very small, the BLAS calls are avoided to enable a better optimization from the compiler. For best performance, you should compile it with NDEBUG flag to avoid the numerous bounds checking on vectors. |
SparseQR | Sparse left-looking rank-revealing QR factorization. This class implements a left-looking rank-revealing QR decomposition of sparse matrices. When a column has a norm less than a given
tolerance it is implicitly permuted to the end. The QR factorization thus obtained is given by
|
data ComputationInfo Source
Success | Computation was successful. |
NumericalIssue | The provided data did not satisfy the prerequisites. |
NoConvergence | Iterative procedure did not converge. |
InvalidInput | The inputs are invalid, or the algorithm has been improperly called. When assertions are enabled, such errors trigger an error. |
type SolverT a b m = ReaderT (SolverInfo, ForeignPtr (CSolver a b)) m Source
runSolverT :: (MonadIO m, Elem a b) => SolverInfo -> SolverT a b m c -> m c Source
The Compute step
analyzePattern :: (MonadIO m, Elem a b) => SparseMatrix a b -> SolverT a b m () Source
Initializes the iterative solver for the sparsity pattern of the matrix A
for further solving Ax=b
problems.
factorize :: (MonadIO m, Elem a b) => SparseMatrix a b -> SolverT a b m () Source
nitializes the iterative solver with the numerical values of the matrix A
for further solving Ax=b
problems.
compute :: (MonadIO m, Elem a b) => SparseMatrix a b -> SolverT a b m () Source
Initializes the iterative solver with the matrix A
for further solving Ax=b
problems.
The compute
method is equivalent to calling both analyzePattern
and factorize
.
The Solve step
solve :: (MonadIO m, Elem a b) => SparseMatrix a b -> SolverT a b m (SparseMatrix a b) Source
An expression of the solution x of A x = b
using the current decomposition of A
.
tolerance :: (MonadIO m, Elem a b) => SolverT a b m Double Source
The tolerance threshold used by the stopping criteria.
setTolerance :: (MonadIO m, Elem a b) => Double -> SolverT a b m () Source
Sets the tolerance threshold used by the stopping criteria.
| This value is used as an upper bound to the relative residual error: |Ax-b|/|b|
. The default value is the machine precision given by epsilon
maxIterations :: (MonadIO m, Elem a b) => SolverT a b m Int Source
The max number of iterations. It is either the value setted by setMaxIterations or, by default, twice the number of columns of the matrix.
setMaxIterations :: (MonadIO m, Elem a b) => Int -> SolverT a b m () Source
Sets the max number of iterations. Default is twice the number of columns of the matrix.
info :: (MonadIO m, Elem a b) => SolverT a b m ComputationInfo Source
Success if the iterations converged, and NoConvergence otherwise.