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::Index Index
 
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 Index cols () const
 
EIGEN_DEVICE_FUNC void evalTo (Dest &dst) const
 
EIGEN_DEVICE_FUNC Index rows () const
 

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

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

Definition at line 43 of file MatrixPower.h.

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

Definition at line 42 of file MatrixPower.h.

Constructor & Destructor Documentation

Constructor.

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

Definition at line 51 of file MatrixPower.h.

Member Function Documentation

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

Definition at line 64 of file MatrixPower.h.

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 60 of file MatrixPower.h.

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

Definition at line 63 of file MatrixPower.h.

Member Data Documentation

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

Definition at line 68 of file MatrixPower.h.

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

Definition at line 67 of file MatrixPower.h.


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


gtsam
Author(s):
autogenerated on Sat May 8 2021 02:53:17