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

typedef Derived::Index	Index

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 &res) const
	Compute the matrix power. More...

Index	rows () const

Index	cols () const

Public Member Functions inherited from Eigen::ReturnByValue< MatrixPowerReturnValue< Derived > >
void	evalTo (Dest &dst) const

Index	rows () const

Index	cols () const

const Unusable &	coeff (Index) const

const Unusable &	coeff (Index, Index) const

Unusable &	coeffRef (Index)

Unusable &	coeffRef (Index, Index)

Unusable &	packet (Index) const

Unusable &	packet (Index, Index) const

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.

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	scalar, the exponent of the matrix power.

Member Function Documentation

§ evalTo()

template<typename Derived>

template<typename ResultType >

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

inline

Compute the matrix power.

Parameters

[out] result \( A^p \) where A and p are as in the constructor.

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

vendor/eigen/Eigen/src/Core/util/ForwardDeclarations.h
vendor/eigen/unsupported/Eigen/src/MatrixFunctions/MatrixPower.h

Public Types