WPILibC++ 2023.4.3
Eigen::SparseSolverBase< Derived > Class Template Reference

A base class for sparse solvers. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/SparseSolverBase.h>

Inheritance diagram for Eigen::SparseSolverBase< Derived >:
Eigen::internal::noncopyable Eigen::IterativeSolverBase< Derived > Eigen::SimplicialCholeskyBase< Derived >

Public Member Functions

 SparseSolverBase ()
 Default constructor. More...
 
 ~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
Derivedthe actual type of the solver.

Constructor & Destructor Documentation

◆ SparseSolverBase()

template<typename Derived >
Eigen::SparseSolverBase< Derived >::SparseSolverBase ( )
inline

Default constructor.

◆ ~SparseSolverBase()

template<typename Derived >
Eigen::SparseSolverBase< Derived >::~SparseSolverBase ( )
inline

Member Function Documentation

◆ _solve_impl()

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

◆ derived() [1/2]

template<typename Derived >
Derived & Eigen::SparseSolverBase< Derived >::derived ( )
inline

◆ derived() [2/2]

template<typename Derived >
const Derived & Eigen::SparseSolverBase< Derived >::derived ( ) const
inline

◆ solve() [1/2]

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 \( A x = b \) using the current decomposition of A.
See also
compute()

◆ solve() [2/2]

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 \( A x = b \) using the current decomposition of A.
See also
compute()

Member Data Documentation

◆ m_isInitialized

template<typename Derived >
bool Eigen::SparseSolverBase< Derived >::m_isInitialized
mutableprotected

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