Eigen::MatrixPowerParenthesesReturnValue< MatrixType > Class Template Reference

Proxy for the matrix power of some matrix. More...

Inheritance diagram for Eigen::MatrixPowerParenthesesReturnValue< MatrixType >:

Public Types
typedef MatrixType::RealScalar	RealScalar
Public Types inherited from Eigen::ReturnByValue< MatrixPowerParenthesesReturnValue< MatrixType > >
typedef internal::dense_xpr_base< ReturnByValue >::type	Base
typedef internal::traits< Derived >::ReturnType	ReturnType

Public Member Functions
Index	cols () const
template<typename ResultType >
void	evalTo (ResultType &result) const
	Compute the matrix power. More...
	MatrixPowerParenthesesReturnValue (MatrixPower< MatrixType > &pow, RealScalar p)
	Constructor. More...
Index	rows () const
Public Member Functions inherited from Eigen::ReturnByValue< MatrixPowerParenthesesReturnValue< MatrixType > >
EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
void	evalTo (Dest &dst) const
EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

Private Attributes
const RealScalar	m_p
MatrixPower< MatrixType > &	m_pow

Detailed Description

template<typename MatrixType>
class Eigen::MatrixPowerParenthesesReturnValue< MatrixType >

Proxy for the matrix power of some matrix.

Template Parameters

MatrixType

type of the base, a matrix.

This class holds the arguments to the matrix power until it is assigned or evaluated for some other reason (so the argument should not be changed in the meantime). It is the return type of MatrixPower::operator() and related functions and most of the time this is the only way it is used.

Definition at line 41 of file MatrixPower.h.

Member Typedef Documentation

RealScalar

template<typename MatrixType >

typedef MatrixType::RealScalar Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::RealScalar

Definition at line 44 of file MatrixPower.h.

Constructor & Destructor Documentation

MatrixPowerParenthesesReturnValue()

template<typename MatrixType >

Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::MatrixPowerParenthesesReturnValue ( MatrixPower< MatrixType > &  pow, RealScalar  p  )

inline

Constructor.

Parameters

[in]	pow	MatrixPower storing the base.
[in]	p	scalar, the exponent of the matrix power.

Definition at line 52 of file MatrixPower.h.

                                                                                  : m_pow(pow), m_p(p)
    { }

Member Function Documentation

cols()

template<typename MatrixType >

Index Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::cols ( void  ) const

inline

Definition at line 65 of file MatrixPower.h.

{ return m_pow.cols(); }

evalTo()

template<typename MatrixType >

template<typename ResultType >

void Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::evalTo ( ResultType &  result ) const

inline

Compute the matrix power.

Parameters

[out]

result

Definition at line 61 of file MatrixPower.h.

    { m_pow.compute(result, m_p); }

rows()

template<typename MatrixType >

Index Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::rows ( void  ) const

inline

Definition at line 64 of file MatrixPower.h.

{ return m_pow.rows(); }

Member Data Documentation

m_p

template<typename MatrixType >

const RealScalar Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::m_p

private

Definition at line 69 of file MatrixPower.h.

m_pow

template<typename MatrixType >

MatrixPower<MatrixType>& Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::m_pow

private

Definition at line 68 of file MatrixPower.h.

---

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

• MatrixPower.h