Eigen::MatrixComplexPowerReturnValue< Derived > Class Template Reference

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

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

Inheritance diagram for Eigen::MatrixComplexPowerReturnValue< Derived >:

Public Types
typedef Derived::PlainObject	PlainObject
typedef std::complex< typename Derived::RealScalar >	ComplexScalar

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

Member Typedef Documentation

ComplexScalar

template<typename Derived >

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

PlainObject

template<typename Derived >

typedef Derived::PlainObject Eigen::MatrixComplexPowerReturnValue< Derived >::PlainObject

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

cols()

template<typename Derived >

Index Eigen::MatrixComplexPowerReturnValue< Derived >::cols ( ) const

inline

evalTo()

template<typename Derived >

template<typename ResultType >

void Eigen::MatrixComplexPowerReturnValue< Derived >::evalTo ( ResultType &  result ) 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.

rows()

template<typename Derived >

Index Eigen::MatrixComplexPowerReturnValue< Derived >::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