Public Types | Public Member Functions | Protected Attributes | Private Member Functions | List of all members
Eigen::SolveWithGuess< Decomposition, RhsType, GuessType > Class Template Reference
Sparse linear algebra » Reference » IterativeLinearSolvers_Module

Pseudo expression representing a solving operation. More...

#include <SolveWithGuess.h>

Inheritance diagram for Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >:
Inheritance graph
[legend]

Public Types

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

Public Member Functions

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

Protected Attributes

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

Private Member Functions

Scalar coeff (Index row, Index col) const
 
Scalar coeff (Index i) const
 

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.

Definition at line 15 of file SolveWithGuess.h.

Member Typedef Documentation

◆ Base

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

Definition at line 46 of file SolveWithGuess.h.

◆ Nested

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

Definition at line 47 of file SolveWithGuess.h.

◆ PlainObject

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

Definition at line 45 of file SolveWithGuess.h.

◆ Scalar

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

Definition at line 44 of file SolveWithGuess.h.

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

Definition at line 49 of file SolveWithGuess.h.

Member Function Documentation

◆ coeff() [1/2]

template<typename Decomposition , typename RhsType , typename GuessType >
Scalar Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::coeff ( Index  row,
Index  col 
) const
private

◆ coeff() [2/2]

template<typename Decomposition , typename RhsType , typename GuessType >
Scalar Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::coeff ( Index  i) const
private

◆ cols()

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

Definition at line 56 of file SolveWithGuess.h.

◆ dec()

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

Definition at line 58 of file SolveWithGuess.h.

◆ guess()

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

Definition at line 60 of file SolveWithGuess.h.

◆ rhs()

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

Definition at line 59 of file SolveWithGuess.h.

◆ rows()

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

Definition at line 54 of file SolveWithGuess.h.

Member Data Documentation

◆ m_dec

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

Definition at line 63 of file SolveWithGuess.h.

◆ m_guess

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

Definition at line 65 of file SolveWithGuess.h.

◆ m_rhs

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

Definition at line 64 of file SolveWithGuess.h.

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

gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:43:17