Eigen::SolverBase< Derived > Class Template Reference

#include <Eigen/src/Core/SolverBase.h>

Detailed Description

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

A base class for matrix decomposition and solvers.

Template Parameters

Derived

the 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, class HouseholderQR, class ColPivHouseholderQR, class FullPivHouseholderQR, class CompleteOrthogonalDecomposition, class LLT, class LDLT, class SVDBase

Inheritance diagram for Eigen::SolverBase< Derived >:

Public Member Functions
const AdjointReturnType	adjoint () const
constexpr Derived &	derived ()
constexpr const Derived &	derived () const
template<typename Rhs>
const Solve< Derived, Rhs >	solve (const MatrixBase< Rhs > &b) const
	SolverBase ()
const ConstTransposeReturnType	transpose () const
Public Member Functions inherited from Eigen::EigenBase< Derived >
constexpr Index	cols () const noexcept
constexpr Derived &	derived ()
constexpr const Derived &	derived () const
constexpr Index	rows () const noexcept
constexpr Index	size () const noexcept

Additional Inherited Members
Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices.

Constructor & Destructor Documentation

SolverBase()

template<typename Derived>

Eigen::SolverBase< Derived >::SolverBase ( )

inline

Default constructor

Member Function Documentation

adjoint()

template<typename Derived>

const 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()

derived() [1/2]

template<typename Derived>

Derived & Eigen::EigenBase< Derived >::derived ( )

inlineconstexpr

Returns

a reference to the derived object

derived() [2/2]

template<typename Derived>

const Derived & Eigen::EigenBase< Derived >::derived ( ) const

inlineconstexpr

Returns

a const reference to the derived object

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.

transpose()

template<typename Derived>

const 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:

• /builddir/build/BUILD/eigen3-5.0.1-build/eigen-5.0.1/Eigen/src/Core/SolverBase.h