All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Eigen::MatrixPowerParenthesesReturnValue< MatrixType > Class Template Reference

Detailed Description

template<typename MatrixType>
class Eigen::MatrixPowerParenthesesReturnValue< MatrixType >

Proxy for the matrix power of some matrix.

Template Parameters
MatrixTypetype 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.

Inherits ReturnByValue< MatrixPowerParenthesesReturnValue< MatrixType > >.

Public Member Functions

template<typename ResultType >
void evalTo (ResultType &res) const
 Compute the matrix power. More...
 
 MatrixPowerParenthesesReturnValue (MatrixPower< MatrixType > &pow, RealScalar p)
 Constructor. More...
 

Constructor & Destructor Documentation

template<typename MatrixType >
Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::MatrixPowerParenthesesReturnValue ( MatrixPower< MatrixType > &  pow,
RealScalar  p 
)
inline

Constructor.

Parameters
[in]powMatrixPower storing the base.
[in]pscalar, the exponent of the matrix power.

Member Function Documentation

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: