Public Member Functions | Protected Attributes
DiagonalWrapper< _DiagonalVectorType > Class Template Reference

Expression of a diagonal matrix. More...

#include <DiagonalMatrix.h>

+ Inheritance diagram for DiagonalWrapper< _DiagonalVectorType >:

List of all members.

Public Member Functions

const DiagonalVectorType & diagonal () const
 DiagonalWrapper (DiagonalVectorType &diagonal)

Protected Attributes

DiagonalVectorType::Nested m_diagonal

Detailed Description

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

Expression of a diagonal matrix.

Parameters:
_DiagonalVectorTypethe 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()

Constructor & Destructor Documentation

DiagonalWrapper ( DiagonalVectorType &  diagonal)
inline

Constructor from expression of diagonal coefficients to wrap.


Member Function Documentation

const DiagonalVectorType& diagonal ( ) const
inline
Returns:
a const reference to the wrapped expression of diagonal coefficients.

References DiagonalWrapper< _DiagonalVectorType >::m_diagonal.


Member Data Documentation

DiagonalVectorType::Nested m_diagonal
protected

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