Eigen  3.4.90 (git rev 5a9f66fb35d03a4da9ef8976e67a61b30aa16dcf)
 
Loading...
Searching...
No Matches
List of all members | Public Member Functions
Eigen::DiagonalWrapper< DiagonalVectorType_ > Class Template Reference
Dense matrix and array manipulation » Reference » Core module

Detailed Description

template<typename DiagonalVectorType_>
class Eigen::DiagonalWrapper< DiagonalVectorType_ >

Expression of a diagonal matrix.

Template 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()
+ Inheritance diagram for Eigen::DiagonalWrapper< DiagonalVectorType_ >:

Public Member Functions

const DiagonalVectorType & diagonal () const
 
 DiagonalWrapper (DiagonalVectorType &a_diagonal)
 
- Public Member Functions inherited from Eigen::DiagonalBase< DiagonalWrapper< DiagonalVectorType_ > >
Scalar coeff (Index row, Index col) const
 
EIGEN_CONSTEXPR Index cols () const
 
DiagonalWrapper< DiagonalVectorType_ > & derived ()
 
const DiagonalWrapper< DiagonalVectorType_ > & derived () const
 
DiagonalVectorType & diagonal ()
 
const DiagonalVectorType & diagonal () const
 
const DiagonalInverseReturnType inverse () const
 
const DiagonalProductReturnType< OtherDerived > operator* (const DiagonalBase< OtherDerived > &other) const
 
const Product< DiagonalWrapper< DiagonalVectorType_ >, MatrixDerived, LazyProduct > operator* (const MatrixBase< MatrixDerived > &matrix) const
 
const DiagonalScaleReturnType operator* (const Scalar &scalar) const
 
const DiagonalSumReturnType< OtherDerived > operator+ (const DiagonalBase< OtherDerived > &other) const
 
const DiagonalDifferenceReturnType< OtherDerived > operator- (const DiagonalBase< OtherDerived > &other) const
 
EIGEN_CONSTEXPR Index rows () const
 
DenseMatrixType toDenseMatrix () const
 
- Public Member Functions inherited from Eigen::EigenBase< DiagonalWrapper< DiagonalVectorType_ > >
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
DiagonalWrapper< DiagonalVectorType_ > & derived ()
 
const DiagonalWrapper< DiagonalVectorType_ > & derived () const
 
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
 
EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT
 

Additional Inherited Members

- Public Types inherited from Eigen::EigenBase< DiagonalWrapper< DiagonalVectorType_ > >
typedef Eigen::Index Index
 The interface type of indices.
 

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: