Eigen::MatrixPowerAtomic< MatrixType > Class Template Reference

Detailed Description

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

Class for computing matrix powers.

Template Parameters
MatrixTypetype of the base, expected to be an instantiation of the Matrix class template.

This class is capable of computing triangular real/complex matrices raised to a power in the interval $ (-1, 1) $.

Note
Currently this class is only used by MatrixPower. One may insist that this be nested into MatrixPower. This class is here to faciliate future development of triangular matrix functions.

Inherits noncopyable.

Public Member Functions

void compute (ResultType &res) const
 Compute the matrix power. More...
 
 MatrixPowerAtomic (const MatrixType &T, RealScalar p)
 Constructor. More...
 

Constructor & Destructor Documentation

◆ MatrixPowerAtomic()

template<typename MatrixType >
Eigen::MatrixPowerAtomic< MatrixType >::MatrixPowerAtomic ( const MatrixType &  T,
RealScalar  p 
)

Constructor.

Parameters
[in]Tthe base of the matrix power.
[in]pthe exponent of the matrix power, should be in $ (-1, 1) $.

The class stores a reference to T, so it should not be changed (or destroyed) before evaluation. Only the upper triangular part of T is read.

Member Function Documentation

◆ compute()

template<typename MatrixType >
void Eigen::MatrixPowerAtomic< MatrixType >::compute ( ResultType &  res) const

Compute the matrix power.

Parameters
[out]res$ A^p $ where A and p are specified in the constructor.

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