Eigen::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:
Derivedtype 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 > >.

List of all members.

Public Member Functions

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

Constructor & Destructor Documentation

template<typename Derived >
Eigen::MatrixPowerReturnValue< Derived >::MatrixPowerReturnValue ( const Derived &  A,
RealScalar  p 
) [inline]

Constructor.

Parameters:
[in]AMatrix (expression), the base of the matrix power.
[in]preal scalar, the exponent of the matrix power.

Member Function Documentation

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 file:
 All Classes Functions Variables Typedefs Enumerator