Eigen::MatrixPowerParenthesesReturnValue< MatrixType > Class Template Reference

Proxy for the matrix power of some matrix. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/unsupported/Eigen/src/MatrixFunctions/MatrixPower.h>

Inheritance diagram for Eigen::MatrixPowerParenthesesReturnValue< MatrixType >:

Public Types
typedef MatrixType::RealScalar	RealScalar

Public Member Functions
	MatrixPowerParenthesesReturnValue (MatrixPower< MatrixType > &pow, RealScalar p)
	Constructor. More...
template<typename ResultType >
void	evalTo (ResultType &result) const
	Compute the matrix power. More...
Index	rows () const
Index	cols () const

Detailed Description

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

Proxy for the matrix power of some matrix.

Template Parameters

MatrixType

type 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.

Member Typedef Documentation

RealScalar

template<typename MatrixType >

typedef MatrixType::RealScalar Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::RealScalar

Constructor & Destructor Documentation

MatrixPowerParenthesesReturnValue()

template<typename MatrixType >

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

inline

Constructor.

Parameters

[in]	pow	MatrixPower storing the base.
[in]	p	scalar, the exponent of the matrix power.

Member Function Documentation

cols()

template<typename MatrixType >

Index Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::cols ( ) const

inline

evalTo()

template<typename MatrixType >

template<typename ResultType >

void Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::evalTo ( ResultType &  result ) const

inline

Compute the matrix power.

Parameters

[out]

result

rows()

template<typename MatrixType >

Index Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::rows ( ) const

inline

---

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

• /home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/unsupported/Eigen/src/MatrixFunctions/MatrixPower.h