Public Types | Public Member Functions | Private Attributes | List of all members
Eigen::MatrixPowerParenthesesReturnValue< MatrixType > Class Template Reference

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

#include <MatrixPower.h>

Inheritance diagram for Eigen::MatrixPowerParenthesesReturnValue< MatrixType >:
Inheritance graph
[legend]

Public Types

typedef MatrixType::RealScalar RealScalar
 
- Public Types inherited from Eigen::ReturnByValue< MatrixPowerParenthesesReturnValue< MatrixType > >
typedef internal::dense_xpr_base< ReturnByValue >::type Base
 
typedef internal::traits< MatrixPowerParenthesesReturnValue< MatrixType > >::ReturnType ReturnType
 

Public Member Functions

Index cols () const
 
template<typename ResultType >
void evalTo (ResultType &result) const
 Compute the matrix power. More...
 
 MatrixPowerParenthesesReturnValue (MatrixPower< MatrixType > &pow, RealScalar p)
 Constructor. More...
 
Index rows () const
 
- Public Member Functions inherited from Eigen::ReturnByValue< MatrixPowerParenthesesReturnValue< MatrixType > >
const Unusablecoeff (Index) const
 
const Unusablecoeff (Index, Index) const
 
UnusablecoeffRef (Index)
 
UnusablecoeffRef (Index, Index)
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC void evalTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 

Private Attributes

const RealScalar m_p
 
MatrixPower< MatrixType > & m_pow
 

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.

Definition at line 39 of file MatrixPower.h.

Member Typedef Documentation

◆ RealScalar

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

Definition at line 42 of file MatrixPower.h.

Constructor & Destructor Documentation

◆ MatrixPowerParenthesesReturnValue()

Constructor.

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

Definition at line 50 of file MatrixPower.h.

Member Function Documentation

◆ cols()

template<typename MatrixType >
Index Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::cols ( ) const
inline

Definition at line 63 of file MatrixPower.h.

◆ evalTo()

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

Compute the matrix power.

Parameters
[out]result

Definition at line 59 of file MatrixPower.h.

◆ rows()

template<typename MatrixType >
Index Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::rows ( ) const
inline

Definition at line 62 of file MatrixPower.h.

Member Data Documentation

◆ m_p

template<typename MatrixType >
const RealScalar Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::m_p
private

Definition at line 67 of file MatrixPower.h.

◆ m_pow

template<typename MatrixType >
MatrixPower<MatrixType>& Eigen::MatrixPowerParenthesesReturnValue< MatrixType >::m_pow
private

Definition at line 66 of file MatrixPower.h.


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


gtsam
Author(s):
autogenerated on Sat Nov 16 2024 04:11:17