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

#include <MatrixPower.h>

Inheritance diagram for Eigen::MatrixComplexPowerReturnValue< Derived >:

Public Types
typedef Derived::PlainObject	PlainObject

typedef std::complex< typename Derived::RealScalar >	ComplexScalar

typedef Derived::Index	Index

Public Types inherited from Eigen::ReturnByValue< MatrixComplexPowerReturnValue< Derived > >
typedef internal::traits< MatrixComplexPowerReturnValue< Derived > >::ReturnType	ReturnType

typedef internal::dense_xpr_base< ReturnByValue >::type	Base

Public Member Functions
	MatrixComplexPowerReturnValue (const Derived &A, const ComplexScalar &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< MatrixComplexPowerReturnValue< Derived > >
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 Derived>
class Eigen::MatrixComplexPowerReturnValue< 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

§ MatrixComplexPowerReturnValue()

template<typename Derived>

Eigen::MatrixComplexPowerReturnValue< Derived >::MatrixComplexPowerReturnValue	(	const Derived &	A,
		const ComplexScalar &	p
	)

inline

Constructor.

Parameters

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

Member Function Documentation

§ evalTo()

template<typename Derived>

template<typename ResultType >

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

inline

Compute the matrix power.

Because p is complex, \( A^p \) is simply evaluated as \( \exp(p \log(A)) \).

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:

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

Public Types