W3cubDocs

/Eigen3

Eigen::DiagonalWrapper

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.

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

DiagonalWrapper()

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

Constructor from expression of diagonal coefficients to wrap.

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:

© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/classEigen_1_1DiagonalWrapper.html