Eigen::MatrixExponentialReturnValue< Derived > Struct Template Reference

---

Detailed Description

template<typename Derived>
struct Eigen::MatrixExponentialReturnValue< Derived >

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

Template Parameters:

Derived

Type 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 303 of file MatrixFunctions.

Inheritance diagram for Eigen::MatrixExponentialReturnValue< Derived >:

List of all members.

Public Types
typedef Derived::Index	Index
typedef internal::traits < MatrixExponentialReturnValue < Derived > >::ReturnType	ReturnType
typedef internal::dense_xpr_base < ReturnByValue >::type	Base
Public Member Functions
	MatrixExponentialReturnValue (const Derived &src)
	Constructor.
template<typename ResultType >
void	evalTo (ResultType &result) const
	Compute the matrix exponential.
Index	rows () const
Index	cols () const
void	evalTo (Dest &dst) const
Protected Attributes
const Derived &	m_src
Private Member Functions
MatrixExponentialReturnValue &	operator= (const MatrixExponentialReturnValue &)

---

Member Typedef Documentation

typedef internal::dense_xpr_base<ReturnByValue>::type Eigen::ReturnByValue< MatrixExponentialReturnValue< Derived > >::Base [inherited]

Definition at line 70 of file Core.

template<typename Derived >

typedef Derived::Index Eigen::MatrixExponentialReturnValue< Derived >::Index

Definition at line 306 of file MatrixFunctions.

typedef internal::traits<MatrixExponentialReturnValue< Derived > >::ReturnType Eigen::ReturnByValue< MatrixExponentialReturnValue< Derived > >::ReturnType [inherited]

Definition at line 68 of file Core.

---

Constructor & Destructor Documentation

template<typename Derived >

Eigen::MatrixExponentialReturnValue< Derived >::MatrixExponentialReturnValue

(

const Derived &

src

)

[inline]

Constructor.

Parameters:

[in]

src

Matrix (expression) forming the argument of the matrix exponential.

Definition at line 313 of file MatrixFunctions.

---

Member Function Documentation

template<typename Derived >

Index Eigen::MatrixExponentialReturnValue< Derived >::cols

(

void

)

const [inline]

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

Definition at line 329 of file MatrixFunctions.

void Eigen::ReturnByValue< MatrixExponentialReturnValue< Derived > >::evalTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 74 of file Core.

template<typename Derived >

template<typename ResultType >

void Eigen::MatrixExponentialReturnValue< Derived >::evalTo

(

ResultType &

result

)

const [inline]

Compute the matrix exponential.

Parameters:

[out]

result

the matrix exponential of src in the constructor.

Definition at line 321 of file MatrixFunctions.

template<typename Derived >

MatrixExponentialReturnValue& Eigen::MatrixExponentialReturnValue< Derived >::operator=

(

const MatrixExponentialReturnValue< Derived > &

)

[private]

template<typename Derived >

Index Eigen::MatrixExponentialReturnValue< Derived >::rows

(

void

)

const [inline]

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

Definition at line 328 of file MatrixFunctions.

---

Member Data Documentation

template<typename Derived >

const Derived& Eigen::MatrixExponentialReturnValue< Derived >::m_src [protected]

Definition at line 332 of file MatrixFunctions.