Expression of a diagonal matrix. More...

#include <DiagonalMatrix.h>

Inheritance diagram for Eigen::DiagonalWrapper< _DiagonalVectorType >:

Public Types
typedef _DiagonalVectorType	DiagonalVectorType

typedef DiagonalWrapper	Nested

Public Types inherited from Eigen::DiagonalBase< DiagonalWrapper< _DiagonalVectorType > >
enum

typedef internal::traits< DiagonalWrapper< _DiagonalVectorType > >::DiagonalVectorType	DiagonalVectorType

typedef DiagonalVectorType::Scalar	Scalar

typedef DiagonalVectorType::RealScalar	RealScalar

typedef internal::traits< DiagonalWrapper< _DiagonalVectorType > >::StorageKind	StorageKind

typedef internal::traits< DiagonalWrapper< _DiagonalVectorType > >::StorageIndex	StorageIndex

typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime, 0, MaxRowsAtCompileTime, MaxColsAtCompileTime >	DenseMatrixType

typedef DenseMatrixType	DenseType

typedef DiagonalMatrix< Scalar, DiagonalVectorType::SizeAtCompileTime, DiagonalVectorType::MaxSizeAtCompileTime >	PlainObject

typedef DiagonalWrapper< const CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const DiagonalVectorType > >	InverseReturnType

typedef DiagonalWrapper< const CwiseUnaryOp< internal::scalar_multiple_op< Scalar >, const DiagonalVectorType > >	ScalarMultipleReturnType

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

typedef internal::traits< Derived >::StorageKind	StorageKind

Public Member Functions
EIGEN_DEVICE_FUNC	DiagonalWrapper (DiagonalVectorType &a_diagonal)
	Constructor from expression of diagonal coefficients to wrap.

EIGEN_DEVICE_FUNC const DiagonalVectorType &	diagonal () const

Public Member Functions inherited from Eigen::DiagonalBase< DiagonalWrapper< _DiagonalVectorType > >
EIGEN_DEVICE_FUNC const DiagonalWrapper< _DiagonalVectorType > &	derived () const

EIGEN_DEVICE_FUNC DiagonalWrapper< _DiagonalVectorType > &	derived ()

EIGEN_DEVICE_FUNC DenseMatrixType	toDenseMatrix () const

EIGEN_DEVICE_FUNC const DiagonalVectorType &	diagonal () const

EIGEN_DEVICE_FUNC DiagonalVectorType &	diagonal ()

EIGEN_DEVICE_FUNC Index	rows () const

EIGEN_DEVICE_FUNC Index	cols () const

EIGEN_DEVICE_FUNC const Product< DiagonalWrapper< _DiagonalVectorType >, MatrixDerived, LazyProduct >	operator* (const MatrixBase< MatrixDerived > &matrix) const

EIGEN_DEVICE_FUNC const ScalarMultipleReturnType	operator* (const Scalar &scalar) const

EIGEN_DEVICE_FUNC const InverseReturnType	inverse () const

Public Member Functions inherited from Eigen::EigenBase< Derived >
EIGEN_DEVICE_FUNC Derived &	derived ()

EIGEN_DEVICE_FUNC const Derived &	derived () const

EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const

EIGEN_DEVICE_FUNC const Derived &	const_derived () const

EIGEN_DEVICE_FUNC Index	rows () const

EIGEN_DEVICE_FUNC Index	cols () const

EIGEN_DEVICE_FUNC Index	size () const

template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const

Protected Attributes
DiagonalVectorType::Nested	m_diagonal

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

Member Function Documentation

◆ diagonal()

template<typename _DiagonalVectorType >

EIGEN_DEVICE_FUNC 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:

External/Eigen/src/Core/DiagonalMatrix.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ diagonal()