Eigen::MatrixPowerParenthesesReturnValue< MatrixType > Class Template Reference

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

#include <MatrixPower.h>

Inheritance diagram for Eigen::MatrixPowerParenthesesReturnValue< MatrixType >:

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

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

Private Attributes
MatrixPower< MatrixType > &	m_pow
const RealScalar	m_p

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.

Member Typedef Documentation

RealScalar

template<typename MatrixType >

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

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.

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

Member Function Documentation

cols()

template<typename MatrixType >

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

inline

{ return m_pow.cols(); }

References Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::m_pow.

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), gdb.printers.EigenMatrixPrinter::to_string(), and gdb.printers.EigenSparseMatrixPrinter::to_string().

evalTo()

template<typename MatrixType >

template<typename ResultType >

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

inline

Compute the matrix power.

Parameters

[out]

result

                                               {
    m_pow.compute(result, m_p);
  }

References Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::m_p, and Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::m_pow.

rows()

template<typename MatrixType >

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

inline

{ return m_pow.rows(); }

References Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::m_pow.

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), gdb.printers.EigenMatrixPrinter::to_string(), and gdb.printers.EigenSparseMatrixPrinter::to_string().

Member Data Documentation

m_p

template<typename MatrixType >

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

private

Referenced by Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::evalTo().

m_pow

template<typename MatrixType >

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

private

Referenced by Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::cols(), Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::evalTo(), and Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::rows().

---

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

• MatrixPower.h