Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.4.90 (git rev e3e74001f7c4bf95f0dde572e8a08c5b2918a3ab)
Eigen::DiagonalWrapper< DiagonalVectorType_ > Class Template Reference

Detailed Description

template<typename DiagonalVectorType_>
class Eigen::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()

Inherits DiagonalBase< DiagonalWrapper< DiagonalVectorType_ > >, and Eigen::internal::no_assignment_operator.

Public Member Functions

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

Constructor & Destructor Documentation

◆ DiagonalWrapper()

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

Constructor from expression of diagonal coefficients to wrap.

Member Function Documentation

◆ diagonal()

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: