Public Types | Public Member Functions
MatrixFunctionReturnValue< Derived > Class Template Reference

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

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

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.


Constructor & Destructor Documentation

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.

Member Function Documentation

void evalTo ( ResultType &  result) const [inline]

Compute the matrix function.

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

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