Eigen::SparseSolverBase< Derived > Class Template Reference

A base class for sparse solvers. More...

#include <SparseSolverBase.h>

Inheritance diagram for Eigen::SparseSolverBase< Derived >:

Collaboration diagram for Eigen::SparseSolverBase< Derived >:

List of all members.

Public Member Functions
	SparseSolverBase ()
	~SparseSolverBase ()
Derived &	derived ()
const Derived &	derived () const
template<typename Rhs >
const Solve< Derived, Rhs >	solve (const MatrixBase< Rhs > &b) const
template<typename Rhs >
const Solve< Derived, Rhs >	solve (const SparseMatrixBase< Rhs > &b) const
template<typename Rhs , typename Dest >
void	_solve_impl (const SparseMatrixBase< Rhs > &b, SparseMatrixBase< Dest > &dest) const
Protected Attributes
bool	m_isInitialized

---

Detailed Description

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

A base class for sparse solvers.

Template Parameters:

Derived

the actual type of the solver.

Definition at line 53 of file SparseSolverBase.h.

---

Constructor & Destructor Documentation

template<typename Derived>

Eigen::SparseSolverBase< Derived >::SparseSolverBase

(

)

[inline]

Default constructor

Definition at line 58 of file SparseSolverBase.h.

      : m_isInitialized(false)
    {}

template<typename Derived>

Eigen::SparseSolverBase< Derived >::~SparseSolverBase

(

)

[inline]

Definition at line 62 of file SparseSolverBase.h.

    {}

---

Member Function Documentation

template<typename Derived>

template<typename Rhs , typename Dest >

void Eigen::SparseSolverBase< Derived >::_solve_impl	(	const SparseMatrixBase< Rhs > &	b,
		SparseMatrixBase< Dest > &	dest
	)		const [inline]

default implementation of solving with a sparse rhs

Reimplemented in Eigen::SimplicialCholesky< _MatrixType, _UpLo, _Ordering >, Eigen::SimplicialCholeskyBase< Derived >, Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >, Eigen::SimplicialCholeskyBase< SimplicialLLT< _MatrixType, _UpLo, _Ordering > >, and Eigen::SimplicialCholeskyBase< SimplicialLDLT< _MatrixType, _UpLo, _Ordering > >.

Definition at line 97 of file SparseSolverBase.h.

    {
      internal::solve_sparse_through_dense_panels(derived(), b.derived(), dest.derived());
    }

template<typename Derived>

Derived& Eigen::SparseSolverBase< Derived >::derived

(

)

[inline]

Reimplemented in Eigen::SimplicialCholeskyBase< Derived >, Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >, Eigen::SimplicialCholeskyBase< SimplicialLLT< _MatrixType, _UpLo, _Ordering > >, and Eigen::SimplicialCholeskyBase< SimplicialLDLT< _MatrixType, _UpLo, _Ordering > >.

Definition at line 65 of file SparseSolverBase.h.

{ return *static_cast<Derived*>(this); }

template<typename Derived>

const Derived& Eigen::SparseSolverBase< Derived >::derived

(

)

const [inline]

Reimplemented in Eigen::SimplicialCholeskyBase< Derived >, Eigen::SimplicialCholeskyBase< SimplicialCholesky< _MatrixType, _UpLo, _Ordering > >, Eigen::SimplicialCholeskyBase< SimplicialLLT< _MatrixType, _UpLo, _Ordering > >, and Eigen::SimplicialCholeskyBase< SimplicialLDLT< _MatrixType, _UpLo, _Ordering > >.

Definition at line 66 of file SparseSolverBase.h.

{ return *static_cast<const Derived*>(this); }

template<typename Derived>

template<typename Rhs >

const Solve<Derived, Rhs> Eigen::SparseSolverBase< Derived >::solve

(

const MatrixBase< Rhs > &

b

)

const [inline]

Returns:

an expression of the solution x of using the current decomposition of A.

See also:

compute()

Reimplemented in Eigen::SparseQR< _MatrixType, _OrderingType >.

Definition at line 74 of file SparseSolverBase.h.

    {
      eigen_assert(m_isInitialized && "Solver is not initialized.");
      eigen_assert(derived().rows()==b.rows() && "solve(): invalid number of rows of the right hand side matrix b");
      return Solve<Derived, Rhs>(derived(), b.derived());
    }

template<typename Derived>

template<typename Rhs >

const Solve<Derived, Rhs> Eigen::SparseSolverBase< Derived >::solve

(

const SparseMatrixBase< Rhs > &

b

)

const [inline]

Returns:

an expression of the solution x of using the current decomposition of A.

See also:

compute()

Reimplemented in Eigen::SparseQR< _MatrixType, _OrderingType >.

Definition at line 87 of file SparseSolverBase.h.

    {
      eigen_assert(m_isInitialized && "Solver is not initialized.");
      eigen_assert(derived().rows()==b.rows() && "solve(): invalid number of rows of the right hand side matrix b");
      return Solve<Derived, Rhs>(derived(), b.derived());
    }

---

Member Data Documentation

template<typename Derived>

bool Eigen::SparseSolverBase< Derived >::m_isInitialized [mutable, protected]

Definition at line 105 of file SparseSolverBase.h.

---

The documentation for this class was generated from the following file:

• SparseSolverBase.h