Eigen::DiagonalWrapper< _DiagonalVectorType > Class Template Reference

Expression of a diagonal matrix. More...

#include <DiagonalMatrix.h>

Inheritance diagram for Eigen::DiagonalWrapper< _DiagonalVectorType >:

Collaboration diagram for Eigen::DiagonalWrapper< _DiagonalVectorType >:

List of all members.

Public Types
typedef _DiagonalVectorType	DiagonalVectorType
typedef DiagonalWrapper	Nested
Public Member Functions
EIGEN_DEVICE_FUNC	DiagonalWrapper (DiagonalVectorType &a_diagonal)
EIGEN_DEVICE_FUNC const DiagonalVectorType &	diagonal () const
Protected Attributes
DiagonalVectorType::Nested	m_diagonal

---

Detailed Description

template<typename _DiagonalVectorType>
class Eigen::DiagonalWrapper< _DiagonalVectorType >

Expression of a diagonal matrix.

Parameters:

_DiagonalVectorType

the type of the vector of diagonal coefficients

This class is an expression of a diagonal matrix, but not storing its own vector of diagonal coefficients, instead wrapping an existing vector expression. It is the return type of MatrixBase::asDiagonal() and most of the time this is the only way that it is used.

See also:

class DiagonalMatrix, class DiagonalBase, MatrixBase::asDiagonal()

Definition at line 246 of file DiagonalMatrix.h.

---

Member Typedef Documentation

template<typename _DiagonalVectorType >

typedef _DiagonalVectorType Eigen::DiagonalWrapper< _DiagonalVectorType >::DiagonalVectorType

Reimplemented from Eigen::DiagonalBase< DiagonalWrapper< _DiagonalVectorType > >.

Definition at line 251 of file DiagonalMatrix.h.

template<typename _DiagonalVectorType >

typedef DiagonalWrapper Eigen::DiagonalWrapper< _DiagonalVectorType >::Nested

Definition at line 252 of file DiagonalMatrix.h.

---

Constructor & Destructor Documentation

template<typename _DiagonalVectorType >

EIGEN_DEVICE_FUNC Eigen::DiagonalWrapper< _DiagonalVectorType >::DiagonalWrapper

(

DiagonalVectorType &

a_diagonal

)

[inline, explicit]

Constructor from expression of diagonal coefficients to wrap.

Definition at line 257 of file DiagonalMatrix.h.

: m_diagonal(a_diagonal) {}

---

Member Function Documentation

template<typename _DiagonalVectorType >

EIGEN_DEVICE_FUNC const DiagonalVectorType& Eigen::DiagonalWrapper< _DiagonalVectorType >::diagonal

(

)

const [inline]

Returns:

a const reference to the wrapped expression of diagonal coefficients.

Reimplemented from Eigen::DiagonalBase< DiagonalWrapper< _DiagonalVectorType > >.

Definition at line 261 of file DiagonalMatrix.h.

{ return m_diagonal; }

---

Member Data Documentation

template<typename _DiagonalVectorType >

DiagonalVectorType::Nested Eigen::DiagonalWrapper< _DiagonalVectorType >::m_diagonal [protected]

Definition at line 264 of file DiagonalMatrix.h.

---

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

• DiagonalMatrix.h