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

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

#include <MatrixPower.h>

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

List of all members.

Public Types

typedef Derived::Index Index
typedef Derived::PlainObject PlainObject
typedef Derived::RealScalar RealScalar

Public Member Functions

Index cols () const
template<typename ResultType >
void evalTo (ResultType &res) const
 Compute the matrix power.
 MatrixPowerReturnValue (const Derived &A, RealScalar p)
 Constructor.
Index rows () const

Private Member Functions

MatrixPowerReturnValueoperator= (const MatrixPowerReturnValue &)

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


Member Typedef Documentation

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

Definition at line 461 of file MatrixPower.h.

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

Definition at line 459 of file MatrixPower.h.

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

Definition at line 460 of file MatrixPower.h.


Constructor & Destructor Documentation

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]pscalar, the exponent of the matrix power.

Definition at line 469 of file MatrixPower.h.


Member Function Documentation

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

Reimplemented from Eigen::ReturnByValue< MatrixPowerReturnValue< Derived > >.

Definition at line 483 of file MatrixPower.h.

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

Compute the matrix power.

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

Definition at line 479 of file MatrixPower.h.

template<typename Derived>
MatrixPowerReturnValue& Eigen::MatrixPowerReturnValue< Derived >::operator= ( const MatrixPowerReturnValue< Derived > &  ) [private]
template<typename Derived>
Index Eigen::MatrixPowerReturnValue< Derived >::rows ( void  ) const [inline]

Reimplemented from Eigen::ReturnByValue< MatrixPowerReturnValue< Derived > >.

Definition at line 482 of file MatrixPower.h.


Member Data Documentation

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

Definition at line 486 of file MatrixPower.h.

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

Definition at line 487 of file MatrixPower.h.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Sat Jun 8 2019 19:40:49