Eigen  3.3.3
Eigen::SolverBase< Derived > Class Template Reference

Detailed Description

template<typename Derived>
class Eigen::SolverBase< Derived >

A base class for matrix decomposition and solvers.

Template Parameters:
Derivedthe actual type of the decomposition/solver.

Any matrix decomposition inheriting this base class provide the following API:

 MatrixType A, b, x;
 DecompositionType dec(A);
 x = dec.solve(b);             // solve A   * x = b
 x = dec.transpose().solve(b); // solve A^T * x = b
 x = dec.adjoint().solve(b);   // solve A'  * x = b
Warning:
Currently, any other usage of transpose() and adjoint() are not supported and will produce compilation errors.
See also:
class PartialPivLU, class FullPivLU
+ Inheritance diagram for Eigen::SolverBase< Derived >:

List of all members.

Public Member Functions

AdjointReturnType adjoint () const
template<typename Rhs >
const Solve< Derived, Rhs > solve (const MatrixBase< Rhs > &b) const
 SolverBase ()
ConstTransposeReturnType transpose () const

Constructor & Destructor Documentation

template<typename Derived>
Eigen::SolverBase< Derived >::SolverBase ( ) [inline]

Default constructor


Member Function Documentation

template<typename Derived>
AdjointReturnType Eigen::SolverBase< Derived >::adjoint ( ) const [inline]
Returns:
an expression of the adjoint of the factored matrix

A typical usage is to solve for the adjoint problem A' x = b:

 x = dec.adjoint().solve(b); 

For real scalar types, this function is equivalent to transpose().

See also:
transpose(), solve()
template<typename Derived>
template<typename Rhs >
const Solve<Derived, Rhs> Eigen::SolverBase< Derived >::solve ( const MatrixBase< Rhs > &  b) const [inline]
Returns:
an expression of the solution x of $ A x = b $ using the current decomposition of A.

Reimplemented in Eigen::FullPivLU< _MatrixType >, and Eigen::PartialPivLU< _MatrixType >.

template<typename Derived>
ConstTransposeReturnType Eigen::SolverBase< Derived >::transpose ( ) const [inline]
Returns:
an expression of the transposed of the factored matrix.

A typical usage is to solve for the transposed problem A^T x = b:

 x = dec.transpose().solve(b); 
See also:
adjoint(), solve()

The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends