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

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

#include <MatrixFunction.h>

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

List of all members.

Public Types

typedef Derived::Index Index
typedef Derived::Scalar Scalar
typedef
internal::stem_function
< Scalar >::type 
StemFunction

Public Member Functions

Index cols () const
template<typename ResultType >
void evalTo (ResultType &result) const
 Compute the matrix function.
 MatrixFunctionReturnValue (const Derived &A, StemFunction f)
 Constructor.
Index rows () const

Private Member Functions

MatrixFunctionReturnValueoperator= (const MatrixFunctionReturnValue &)

Private Attributes

internal::nested< Derived >::type m_A
StemFunctionm_f

Detailed Description

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

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

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

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

Definition at line 487 of file MatrixFunction.h.


Member Typedef Documentation

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

Definition at line 493 of file MatrixFunction.h.

template<typename Derived>
typedef Derived::Scalar Eigen::MatrixFunctionReturnValue< Derived >::Scalar

Definition at line 492 of file MatrixFunction.h.

template<typename Derived>
typedef internal::stem_function<Scalar>::type Eigen::MatrixFunctionReturnValue< Derived >::StemFunction

Definition at line 494 of file MatrixFunction.h.


Constructor & Destructor Documentation

template<typename Derived>
Eigen::MatrixFunctionReturnValue< Derived >::MatrixFunctionReturnValue ( const Derived &  A,
StemFunction  f 
) [inline]

Constructor.

Parameters:
[in]AMatrix (expression) forming the argument of the matrix function.
[in]fStem function for matrix function under consideration.

Definition at line 502 of file MatrixFunction.h.


Member Function Documentation

template<typename Derived>
Index Eigen::MatrixFunctionReturnValue< Derived >::cols ( void  ) const [inline]
template<typename Derived>
template<typename ResultType >
void Eigen::MatrixFunctionReturnValue< Derived >::evalTo ( ResultType &  result) const [inline]

Compute the matrix function.

Parameters:
[out]resultf applied to A, where f and A are as in the constructor.

Definition at line 510 of file MatrixFunction.h.

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

Member Data Documentation

template<typename Derived>
internal::nested<Derived>::type Eigen::MatrixFunctionReturnValue< Derived >::m_A [private]

Definition at line 531 of file MatrixFunction.h.

template<typename Derived>
StemFunction* Eigen::MatrixFunctionReturnValue< Derived >::m_f [private]

Definition at line 532 of file MatrixFunction.h.


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


win_eigen
Author(s): Daniel Stonier
autogenerated on Mon Oct 6 2014 12:27:17