Public Types | Public Member Functions | Protected Attributes

DiagonalWrapper< _DiagonalVectorType > Class Template Reference

Expression of a diagonal matrix. More...

#include <DiagonalMatrix.h>

Inheritance diagram for DiagonalWrapper< _DiagonalVectorType >:
DiagonalBase< DiagonalWrapper< _DiagonalVectorType > > internal::no_assignment_operator EigenBase< DiagonalWrapper< _DiagonalVectorType > >

List of all members.

Public Types

typedef _DiagonalVectorType DiagonalVectorType
typedef DiagonalWrapper Nested

Public Member Functions

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

Protected Attributes

const DiagonalVectorType::Nested m_diagonal

Detailed Description

template<typename _DiagonalVectorType>
class 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()

Member Typedef Documentation

template<typename _DiagonalVectorType>
typedef _DiagonalVectorType DiagonalWrapper< _DiagonalVectorType >::DiagonalVectorType
template<typename _DiagonalVectorType>
typedef DiagonalWrapper DiagonalWrapper< _DiagonalVectorType >::Nested

Constructor & Destructor Documentation

template<typename _DiagonalVectorType>
DiagonalWrapper< _DiagonalVectorType >::DiagonalWrapper ( const DiagonalVectorType diagonal  )  [inline]

Constructor from expression of diagonal coefficients to wrap.


Member Function Documentation

template<typename _DiagonalVectorType>
const DiagonalVectorType& DiagonalWrapper< _DiagonalVectorType >::diagonal (  )  const [inline]
Returns:
a const reference to the wrapped expression of diagonal coefficients.

Member Data Documentation

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

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