MatrixPowerReturnValue< Derived > Class Template Reference

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.

Inherits ReturnByValue< MatrixPowerReturnValue< Derived > >.

Public Member Functions
template<typename ResultType >
void	evalTo (ResultType &res) const
	Compute the matrix power. More...
	MatrixPowerReturnValue (const Derived &A, RealScalar p)
	Constructor. More...

Constructor & Destructor Documentation

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

void evalTo ( ResultType &  res ) const

inline

Compute the matrix power.

Parameters

[out]

result

where A and p are as in the constructor.

---

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

• MatrixPower.h