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

#include <MatrixPower.h>

Inheritance diagram for Eigen::MatrixPowerParenthesesReturnValue< MatrixType >:

Public Types
typedef MatrixType::RealScalar	RealScalar

typedef MatrixType::Index	Index

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

EIGEN_DEVICE_FUNC Index	cols () const

const Unusable &	coeff (Index) const

const Unusable &	coeff (Index, Index) const

Unusable &	coeffRef (Index)

Unusable &	coeffRef (Index, Index)

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.

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.

Member Function Documentation

§ evalTo()

template<typename MatrixType>

template<typename ResultType >

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

inline

Compute the matrix power.

Parameters

[out] result

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

third-party-libs/eigen3/unsupported/Eigen/src/MatrixFunctions/MatrixPower.h

Public Types