Main MRPT website > C++ reference
MRPT logo
Public Member Functions | Protected Attributes

DiagonalWrapper< _DiagonalVectorType > Class Template Reference


Detailed Description

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

Definition at line 230 of file DiagonalMatrix.h.

#include <src/Core/DiagonalMatrix.h>

Inheritance diagram for DiagonalWrapper< _DiagonalVectorType >:
Inheritance graph
[legend]

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>
DiagonalWrapper< _DiagonalVectorType >::DiagonalWrapper ( const DiagonalVectorType &  diagonal ) [inline]

Constructor from expression of diagonal coefficients to wrap.

Definition at line 240 of file DiagonalMatrix.h.


Member Function Documentation

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

Definition at line 243 of file DiagonalMatrix.h.

References DiagonalWrapper< _DiagonalVectorType >::m_diagonal.


Member Data Documentation

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

Definition at line 246 of file DiagonalMatrix.h.

Referenced by DiagonalWrapper< _DiagonalVectorType >::diagonal().




Page generated by Doxygen 1.7.2 for MRPT 0.9.4 SVN: at Mon Jan 10 22:30:30 UTC 2011