Eigen  3.3.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Eigen::DiagonalWrapper< _DiagonalVectorType > Class Template Reference

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

Inherits Eigen::DiagonalBase< Derived >, and Eigen::internal::no_assignment_operator.

Public Member Functions

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

Constructor & Destructor Documentation

template<typename _DiagonalVectorType >
Eigen::DiagonalWrapper< _DiagonalVectorType >::DiagonalWrapper ( DiagonalVectorType &  a_diagonal)
inlineexplicit

Constructor from expression of diagonal coefficients to wrap.

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.

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