Public Types | Public Member Functions | Protected Attributes | Private Member Functions
MatrixExponentialReturnValue< Derived > Struct Template Reference

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

#include <MatrixExponential.h>

Inheritance diagram for MatrixExponentialReturnValue< Derived >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef Derived::Index Index

Public Member Functions

Index cols () const
template<typename ResultType >
void evalTo (ResultType &result) const
 Compute the matrix exponential.
 MatrixExponentialReturnValue (const Derived &src)
 Constructor.
Index rows () const

Protected Attributes

const Derived & m_src

Private Member Functions

MatrixExponentialReturnValueoperator= (const MatrixExponentialReturnValue &)

Detailed Description

template<typename Derived>
struct MatrixExponentialReturnValue< Derived >

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

Template Parameters:
DerivedType of the argument to the matrix exponential.

This class holds the argument to the matrix exponential 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::exp() and most of the time this is the only way it is used.

Definition at line 302 of file MatrixExponential.h.


Member Typedef Documentation

template<typename Derived>
typedef Derived::Index MatrixExponentialReturnValue< Derived >::Index

Definition at line 305 of file MatrixExponential.h.


Constructor & Destructor Documentation

template<typename Derived>
MatrixExponentialReturnValue< Derived >::MatrixExponentialReturnValue ( const Derived &  src) [inline]

Constructor.

Parameters:
[in]srcMatrix (expression) forming the argument of the matrix exponential.

Definition at line 312 of file MatrixExponential.h.


Member Function Documentation

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

Reimplemented from ReturnByValue< MatrixExponentialReturnValue< Derived > >.

Definition at line 328 of file MatrixExponential.h.

template<typename Derived>
template<typename ResultType >
void MatrixExponentialReturnValue< Derived >::evalTo ( ResultType &  result) const [inline]

Compute the matrix exponential.

Parameters:
[out]resultthe matrix exponential of src in the constructor.

Definition at line 320 of file MatrixExponential.h.

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

Reimplemented from ReturnByValue< MatrixExponentialReturnValue< Derived > >.

Definition at line 327 of file MatrixExponential.h.


Member Data Documentation

template<typename Derived>
const Derived& MatrixExponentialReturnValue< Derived >::m_src [protected]

Definition at line 331 of file MatrixExponential.h.


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


libicr
Author(s): Robert Krug
autogenerated on Mon Jan 6 2014 11:34:23