Pseudo expression representing a solving operation. More...

#include <src/eigen/Eigen/src/IterativeLinearSolvers/SolveWithGuess.h>

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

Collaboration 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 Index	rows () const

EIGEN_DEVICE_FUNC Index	cols () const

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

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

Decomposition	the type of the matrix or decomposion object
Rhstype	the 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

50 : m_dec(dec), m_rhs(rhs), m_guess(guess)

51 {}

Eigen::SolveWithGuess::rhs

EIGEN_DEVICE_FUNC const RhsType & rhs() const

Definition SolveWithGuess.h:57

Eigen::SolveWithGuess::m_guess

const GuessType & m_guess

Definition SolveWithGuess.h:63

Eigen::SolveWithGuess::guess

EIGEN_DEVICE_FUNC const GuessType & guess() const

Definition SolveWithGuess.h:58

Eigen::SolveWithGuess::m_rhs

const RhsType & m_rhs

Definition SolveWithGuess.h:62

Eigen::SolveWithGuess::dec

EIGEN_DEVICE_FUNC const Decomposition & dec() const

Definition SolveWithGuess.h:56

Eigen::SolveWithGuess::m_dec

const Decomposition & m_dec

Definition SolveWithGuess.h:61

Member Function Documentation

◆ coeff() [1/2]

template<typename Decomposition , typename RhsType , typename GuessType >

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

private

◆ coeff() [2/2]

template<typename Decomposition , typename RhsType , typename GuessType >

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

private

◆ cols()

template<typename Decomposition , typename RhsType , typename GuessType >

EIGEN_DEVICE_FUNC Index Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::cols ( ) const

inline

54{ return m_rhs.cols(); }

References Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::m_rhs.

Referenced by Eigen::internal::Assignment< DstXprType, SolveWithGuess< DecType, RhsType, GuessType >, internal::assign_op< Scalar, Scalar >, Dense2Dense >::run().

Here is the caller graph for this function:

◆ dec()

template<typename Decomposition , typename RhsType , typename GuessType >

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

inline

56{ return m_dec; }

References Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::m_dec.

Referenced by Eigen::internal::evaluator< SolveWithGuess< Decomposition, RhsType, GuessType > >::evaluator(), and Eigen::internal::Assignment< DstXprType, SolveWithGuess< DecType, RhsType, GuessType >, internal::assign_op< Scalar, Scalar >, Dense2Dense >::run().

Here is the caller graph for this function:

◆ guess()

template<typename Decomposition , typename RhsType , typename GuessType >

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

inline

58{ return m_guess; }

References Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::m_guess.

Referenced by Eigen::internal::evaluator< SolveWithGuess< Decomposition, RhsType, GuessType > >::evaluator(), and Eigen::internal::Assignment< DstXprType, SolveWithGuess< DecType, RhsType, GuessType >, internal::assign_op< Scalar, Scalar >, Dense2Dense >::run().

Here is the caller graph for this function:

◆ rhs()

template<typename Decomposition , typename RhsType , typename GuessType >

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

inline

57{ return m_rhs; }

References Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::m_rhs.

Referenced by Eigen::internal::evaluator< SolveWithGuess< Decomposition, RhsType, GuessType > >::evaluator(), and Eigen::internal::Assignment< DstXprType, SolveWithGuess< DecType, RhsType, GuessType >, internal::assign_op< Scalar, Scalar >, Dense2Dense >::run().

Here is the caller graph for this function:

◆ rows()

template<typename Decomposition , typename RhsType , typename GuessType >

EIGEN_DEVICE_FUNC Index Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::rows ( ) const

inline

53{ return m_dec.cols(); }

References Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::m_dec.

Referenced by Eigen::internal::Assignment< DstXprType, SolveWithGuess< DecType, RhsType, GuessType >, internal::assign_op< Scalar, Scalar >, Dense2Dense >::run().

Here is the caller graph for this function:

Member Data Documentation

◆ m_dec

template<typename Decomposition , typename RhsType , typename GuessType >

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

protected

Referenced by Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::dec(), and Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::rows().

◆ m_guess

template<typename Decomposition , typename RhsType , typename GuessType >

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

protected

Referenced by Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::guess().

◆ m_rhs

template<typename Decomposition , typename RhsType , typename GuessType >

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

protected

Referenced by Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::cols(), and Eigen::SolveWithGuess< Decomposition, RhsType, GuessType >::rhs().

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

src/eigen/Eigen/src/IterativeLinearSolvers/SolveWithGuess.h

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ Base

◆ Nested

◆ PlainObject

◆ Scalar

Constructor & Destructor Documentation

◆ SolveWithGuess()

Member Function Documentation

◆ coeff() [1/2]

◆ coeff() [2/2]

◆ cols()

◆ dec()

◆ guess()

◆ rhs()

◆ rows()

Member Data Documentation

◆ m_dec

◆ m_guess

◆ m_rhs