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

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

#include <ForwardDeclarations.h>

Inheritance diagram for Eigen::MatrixPowerReturnValue< Derived >:
Inheritance graph
[legend]

Public Types

typedef Derived::PlainObject PlainObject
 
typedef Derived::RealScalar RealScalar
 
- Public Types inherited from Eigen::ReturnByValue< MatrixPowerReturnValue< Derived > >
typedef internal::dense_xpr_base< ReturnByValue >::type Base
 
typedef internal::traits< MatrixPowerReturnValue< Derived > >::ReturnType ReturnType
 

Public Member Functions

Index cols () const
 
template<typename ResultType >
void evalTo (ResultType &result) const
 Compute the matrix power. More...
 
 MatrixPowerReturnValue (const Derived &A, RealScalar p)
 Constructor. More...
 
Index rows () const
 
- Public Member Functions inherited from Eigen::ReturnByValue< MatrixPowerReturnValue< Derived > >
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 Derived & m_A
 
const RealScalar m_p
 

Detailed Description

template<typename Derived>
class Eigen::MatrixPowerReturnValue< Derived >

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

Template Parameters
Derivedtype 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.

Definition at line 308 of file ForwardDeclarations.h.

Member Typedef Documentation

◆ PlainObject

template<typename Derived >
typedef Derived::PlainObject Eigen::MatrixPowerReturnValue< Derived >::PlainObject

Definition at line 599 of file MatrixPower.h.

◆ RealScalar

template<typename Derived >
typedef Derived::RealScalar Eigen::MatrixPowerReturnValue< Derived >::RealScalar

Definition at line 600 of file MatrixPower.h.

Constructor & Destructor Documentation

◆ MatrixPowerReturnValue()

template<typename Derived >
Eigen::MatrixPowerReturnValue< Derived >::MatrixPowerReturnValue ( const Derived &  A,
RealScalar  p 
)
inline

Constructor.

Parameters
[in]AMatrix (expression), the base of the matrix power.
[in]preal scalar, the exponent of the matrix power.

Definition at line 608 of file MatrixPower.h.

Member Function Documentation

◆ cols()

template<typename Derived >
Index Eigen::MatrixPowerReturnValue< Derived >::cols ( void  ) const
inline

Definition at line 622 of file MatrixPower.h.

◆ evalTo()

template<typename Derived >
template<typename ResultType >
void Eigen::MatrixPowerReturnValue< Derived >::evalTo ( ResultType &  result) const
inline

Compute the matrix power.

Parameters
[out]result$ A^p $ where A and p are as in the constructor.

Definition at line 618 of file MatrixPower.h.

◆ rows()

template<typename Derived >
Index Eigen::MatrixPowerReturnValue< Derived >::rows ( void  ) const
inline

Definition at line 621 of file MatrixPower.h.

Member Data Documentation

◆ m_A

template<typename Derived >
const Derived& Eigen::MatrixPowerReturnValue< Derived >::m_A
private

Definition at line 625 of file MatrixPower.h.

◆ m_p

template<typename Derived >
const RealScalar Eigen::MatrixPowerReturnValue< Derived >::m_p
private

Definition at line 626 of file MatrixPower.h.


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


gtsam
Author(s):
autogenerated on Tue Jul 4 2023 02:42:13