Eigen::DiagonalWrapper< _DiagonalVectorType > Class Template Reference

Expression of a diagonal matrix. More...

#include <DiagonalMatrix.h>

Inheritance diagram for Eigen::DiagonalWrapper< _DiagonalVectorType >:

Collaboration 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 > >::Index	Index
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime, 0, MaxRowsAtCompileTime, MaxColsAtCompileTime >	DenseMatrixType
typedef DenseMatrixType	DenseType
typedef DiagonalMatrix< Scalar, DiagonalVectorType::SizeAtCompileTime, DiagonalVectorType::MaxSizeAtCompileTime >	PlainObject
Public Types inherited from Eigen::EigenBase< Derived >
typedef internal::traits< Derived >::StorageKind	StorageKind
typedef internal::traits< Derived >::Index	Index

Public Member Functions
	DiagonalWrapper (DiagonalVectorType &a_diagonal)
const DiagonalVectorType &	diagonal () const
Public Member Functions inherited from Eigen::DiagonalBase< DiagonalWrapper< _DiagonalVectorType > >
const DiagonalWrapper< _DiagonalVectorType > &	derived () const
DiagonalWrapper< _DiagonalVectorType > &	derived ()
DenseMatrixType	toDenseMatrix () const
void	evalTo (MatrixBase< DenseDerived > &other) const
void	addTo (MatrixBase< DenseDerived > &other) const
void	subTo (MatrixBase< DenseDerived > &other) const
const DiagonalVectorType &	diagonal () const
DiagonalVectorType &	diagonal ()
Index	rows () const
Index	cols () const
const DiagonalProduct< MatrixDerived, DiagonalWrapper< _DiagonalVectorType >, OnTheLeft >	operator* (const MatrixBase< MatrixDerived > &matrix) const
const DiagonalWrapper< const CwiseUnaryOp< internal::scalar_multiple_op< Scalar >, const DiagonalVectorType > >	operator* (const Scalar &scalar) const
const DiagonalWrapper< const CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const DiagonalVectorType > >	inverse () const
Public Member Functions inherited from Eigen::EigenBase< Derived >
Derived &	derived ()
const Derived &	derived () const
Derived &	const_cast_derived () const
const Derived &	const_derived () const
Index	rows () const
Index	cols () const
Index	size () const
template<typename Dest >
void	evalTo (Dest &dst) const
template<typename Dest >
void	addTo (Dest &dst) const
template<typename Dest >
void	subTo (Dest &dst) const
template<typename Dest >
void	applyThisOnTheRight (Dest &dst) const
template<typename Dest >
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()

Definition at line 248 of file DiagonalMatrix.h.

Constructor & Destructor Documentation

template<typename _DiagonalVectorType>

Eigen::DiagonalWrapper< _DiagonalVectorType >::DiagonalWrapper ( DiagonalVectorType &  a_diagonal )

inline

Constructor from expression of diagonal coefficients to wrap.

Definition at line 258 of file DiagonalMatrix.h.

: m_diagonal(a_diagonal) {}

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.

Definition at line 261 of file DiagonalMatrix.h.

{ return m_diagonal; }

---

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

• C:/Users/Brig/Documents/ShapeWorksStudio/src/Surfworks/Eigen/src/Core/DiagonalMatrix.h