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

Expression of a diagonal matrix. More...

#include <DiagonalMatrix.h>

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

List of all members.

Public Types

typedef _DiagonalVectorType DiagonalVectorType
typedef DiagonalWrapper Nested

Public Member Functions

const DiagonalVectorTypediagonal () 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()

Definition at line 243 of file DiagonalMatrix.h.


Member Typedef Documentation

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

Definition at line 249 of file DiagonalMatrix.h.


Constructor & Destructor Documentation

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

Constructor from expression of diagonal coefficients to wrap.

Definition at line 253 of file DiagonalMatrix.h.


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.

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

Definition at line 256 of file DiagonalMatrix.h.


Member Data Documentation

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

Definition at line 259 of file DiagonalMatrix.h.


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


win_eigen
Author(s): Daniel Stonier
autogenerated on Wed Sep 16 2015 07:12:50