WPILibC++ 2023.4.3
Eigen::SolveWithGuess< Decomposition, RhsType, GuessType > Class Template Reference

Pseudo expression representing a solving operation. More...

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

Inheritance diagram for Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >:

Public Types

typedef internal::traits< SolveWithGuess >::Scalar Scalar
 
typedef internal::traits< SolveWithGuess >::PlainObject PlainObject
 
typedef internal::generic_xpr_base< SolveWithGuess< Decomposition, RhsType, GuessType >, MatrixXpr, typenameinternal::traits< RhsType >::StorageKind >::type Base
 
typedef internal::ref_selector< SolveWithGuess >::type Nested
 

Public Member Functions

 SolveWithGuess (const Decomposition &dec, const RhsType &rhs, const GuessType &guess)
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC const Decomposition & dec () const
 
EIGEN_DEVICE_FUNC const RhsType & rhs () const
 
EIGEN_DEVICE_FUNC const GuessType & guess () const
 

Protected Attributes

const Decomposition & m_dec
 
const RhsType & m_rhs
 
const GuessType & m_guess
 

Detailed Description

template<typename Decomposition, typename RhsType, typename GuessType>
class Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >

Pseudo expression representing a solving operation.

Template Parameters
Decompositionthe type of the matrix or decomposion object
Rhstypethe type of the right-hand side

This class represents an expression of A.solve(B) and most of the time this is the only way it is used.

Member Typedef Documentation

◆ Base

template<typename Decomposition , typename RhsType , typename GuessType >
typedef internal::generic_xpr_base<SolveWithGuess<Decomposition,RhsType,GuessType>,MatrixXpr,typenameinternal::traits<RhsType>::StorageKind>::type Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::Base

◆ Nested

template<typename Decomposition , typename RhsType , typename GuessType >
typedef internal::ref_selector<SolveWithGuess>::type Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::Nested

◆ PlainObject

template<typename Decomposition , typename RhsType , typename GuessType >
typedef internal::traits<SolveWithGuess>::PlainObject Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::PlainObject

◆ Scalar

template<typename Decomposition , typename RhsType , typename GuessType >
typedef internal::traits<SolveWithGuess>::Scalar Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::Scalar

Constructor & Destructor Documentation

◆ SolveWithGuess()

template<typename Decomposition , typename RhsType , typename GuessType >
Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::SolveWithGuess ( const Decomposition &  dec,
const RhsType &  rhs,
const GuessType &  guess 
)
inline

Member Function Documentation

◆ cols()

template<typename Decomposition , typename RhsType , typename GuessType >
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::cols ( ) const
inline

◆ dec()

template<typename Decomposition , typename RhsType , typename GuessType >
EIGEN_DEVICE_FUNC const Decomposition & Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::dec ( ) const
inline

◆ guess()

template<typename Decomposition , typename RhsType , typename GuessType >
EIGEN_DEVICE_FUNC const GuessType & Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::guess ( ) const
inline

◆ rhs()

template<typename Decomposition , typename RhsType , typename GuessType >
EIGEN_DEVICE_FUNC const RhsType & Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::rhs ( ) const
inline

◆ rows()

template<typename Decomposition , typename RhsType , typename GuessType >
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::rows ( ) const
inline

Member Data Documentation

◆ m_dec

template<typename Decomposition , typename RhsType , typename GuessType >
const Decomposition& Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::m_dec
protected

◆ m_guess

template<typename Decomposition , typename RhsType , typename GuessType >
const GuessType& Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::m_guess
protected

◆ m_rhs

template<typename Decomposition , typename RhsType , typename GuessType >
const RhsType& Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::m_rhs
protected

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