Eigen::MatrixPowerReturnValue< Derived > Class Template Reference

Proxy for the matrix power of some matrix (expression). More...

#include <MatrixPower.h>

Inheritance diagram for Eigen::MatrixPowerReturnValue< Derived >:

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

Public Member Functions
	MatrixPowerReturnValue (const Derived &A, 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< MatrixPowerReturnValue< Derived > >
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
const Derived &	m_A
const RealScalar	m_p

Detailed Description

template<typename Derived>
class Eigen::MatrixPowerReturnValue< Derived >

Proxy for the matrix power of some matrix (expression).

Template Parameters

Derived

type of the base, a matrix (expression).

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 MatrixBase::pow() and related functions and most of the time this is the only way it is used.

Member Typedef Documentation

PlainObject

template<typename Derived >

typedef Derived::PlainObject Eigen::MatrixPowerReturnValue< Derived >::PlainObject

RealScalar

template<typename Derived >

typedef Derived::RealScalar Eigen::MatrixPowerReturnValue< Derived >::RealScalar

Constructor & Destructor Documentation

MatrixPowerReturnValue()

template<typename Derived >

Eigen::MatrixPowerReturnValue< Derived >::MatrixPowerReturnValue ( const Derived &  A, RealScalar  p  )

inline

Constructor.

Parameters

[in]	A	Matrix (expression), the base of the matrix power.
[in]	p	real scalar, the exponent of the matrix power.

: m_A(A), m_p(p) {}

Member Function Documentation

cols()

template<typename Derived >

Index Eigen::MatrixPowerReturnValue< Derived >::cols ( ) const

inline

{ return m_A.cols(); }

References Eigen::MatrixPowerReturnValue< Derived >::m_A.

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 Derived >

template<typename ResultType >

void Eigen::MatrixPowerReturnValue< Derived >::evalTo ( ResultType &  result ) const

inline

Compute the matrix power.

Parameters

[out]

result

\( A^p \) where A and p are as in the constructor.

                                               {
    MatrixPower<PlainObject>(m_A.eval()).compute(result, m_p);
  }

References Eigen::MatrixPower< MatrixType >::compute(), Eigen::MatrixPowerReturnValue< Derived >::m_A, and Eigen::MatrixPowerReturnValue< Derived >::m_p.

rows()

template<typename Derived >

Index Eigen::MatrixPowerReturnValue< Derived >::rows ( ) const

inline

{ return m_A.rows(); }

References Eigen::MatrixPowerReturnValue< Derived >::m_A.

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_A

template<typename Derived >

const Derived& Eigen::MatrixPowerReturnValue< Derived >::m_A

private

Referenced by Eigen::MatrixPowerReturnValue< Derived >::cols(), Eigen::MatrixPowerReturnValue< Derived >::evalTo(), and Eigen::MatrixPowerReturnValue< Derived >::rows().

m_p

template<typename Derived >

const RealScalar Eigen::MatrixPowerReturnValue< Derived >::m_p

private

Referenced by Eigen::MatrixPowerReturnValue< Derived >::evalTo().

---

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

• ForwardDeclarations.h
• MatrixPower.h