Eigen::DiagonalWrapper< _DiagonalVectorType > Class Template Reference

---

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 245 of file Core.

Inheritance diagram for Eigen::DiagonalWrapper< _DiagonalVectorType >:

List of all members.

Public Member Functions
	DiagonalWrapper (const DiagonalVectorType &diagonal)
	Constructor from expression of diagonal coefficients to wrap.
const DiagonalVectorType &	diagonal () const
Protected Attributes
const DiagonalVectorType::Nested	m_diagonal

---

Constructor & Destructor Documentation

template<typename _DiagonalVectorType >

Eigen::DiagonalWrapper< _DiagonalVectorType >::DiagonalWrapper

(

const DiagonalVectorType &

diagonal

)

[inline]

Constructor from expression of diagonal coefficients to wrap.

Definition at line 255 of file Core.

---

Member Function Documentation

template<typename _DiagonalVectorType >

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

(

)

const [inline]

Returns:

a const reference to the wrapped expression of diagonal coefficients.

Definition at line 258 of file Core.

---

Member Data Documentation

template<typename _DiagonalVectorType >

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

Definition at line 261 of file Core.