Represents a diagonal matrix with its storage. More...

#include <DiagonalMatrix.h>

Inheritance diagram for Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >:

Public Types
typedef internal::traits< DiagonalMatrix >::DiagonalVectorType	DiagonalVectorType

typedef const DiagonalMatrix &	Nested

typedef _Scalar	Scalar

typedef internal::traits< DiagonalMatrix >::StorageIndex	StorageIndex

typedef internal::traits< DiagonalMatrix >::StorageKind	StorageKind

Public Types inherited from Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >
enum

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

typedef DenseMatrixType	DenseType

typedef internal::traits< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::DiagonalVectorType	DiagonalVectorType

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

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

typedef DiagonalVectorType::RealScalar	RealScalar

typedef DiagonalVectorType::Scalar	Scalar

typedef internal::traits< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::StorageIndex	StorageIndex

typedef internal::traits< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::StorageKind	StorageKind

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

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

Public Member Functions
EIGEN_DEVICE_FUNC const DiagonalVectorType &	diagonal () const

EIGEN_DEVICE_FUNC DiagonalVectorType &	diagonal ()

EIGEN_DEVICE_FUNC	DiagonalMatrix ()

EIGEN_DEVICE_FUNC	DiagonalMatrix (Index dim)

EIGEN_DEVICE_FUNC	DiagonalMatrix (const Scalar &x, const Scalar &y)

EIGEN_DEVICE_FUNC	DiagonalMatrix (const Scalar &x, const Scalar &y, const Scalar &z)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC	DiagonalMatrix (const DiagonalBase< OtherDerived > &other)

	DiagonalMatrix (const DiagonalMatrix &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC	DiagonalMatrix (const MatrixBase< OtherDerived > &other)

template<typename OtherDerived >
EIGEN_DEVICE_FUNC DiagonalMatrix &	operator= (const DiagonalBase< OtherDerived > &other)

EIGEN_DEVICE_FUNC DiagonalMatrix &	operator= (const DiagonalMatrix &other)

EIGEN_DEVICE_FUNC void	resize (Index size)

EIGEN_DEVICE_FUNC void	setIdentity ()

EIGEN_DEVICE_FUNC void	setIdentity (Index size)

EIGEN_DEVICE_FUNC void	setZero ()

EIGEN_DEVICE_FUNC void	setZero (Index size)

Public Member Functions inherited from Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >
EIGEN_DEVICE_FUNC Index	cols () const

EIGEN_DEVICE_FUNC const DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > &	derived () const

EIGEN_DEVICE_FUNC DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > &	derived ()

EIGEN_DEVICE_FUNC const DiagonalVectorType &	diagonal () const

EIGEN_DEVICE_FUNC DiagonalVectorType &	diagonal ()

EIGEN_DEVICE_FUNC const InverseReturnType	inverse () const

EIGEN_DEVICE_FUNC const Product< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >, MatrixDerived, LazyProduct >	operator* (const MatrixBase< MatrixDerived > &matrix) const

EIGEN_DEVICE_FUNC const DiagonalWrapper< const EIGEN_EXPR_BINARYOP_SCALAR_RETURN_TYPE(DiagonalVectorType, Scalar, product) >	operator* (const Scalar &scalar) const

EIGEN_DEVICE_FUNC Index	rows () const

EIGEN_DEVICE_FUNC DenseMatrixType	toDenseMatrix () const

Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const

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

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

EIGEN_DEVICE_FUNC Index	cols () const

EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const

EIGEN_DEVICE_FUNC const Derived &	const_derived () const

EIGEN_DEVICE_FUNC Derived &	derived ()

EIGEN_DEVICE_FUNC const Derived &	derived () const

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

EIGEN_DEVICE_FUNC Index	rows () const

EIGEN_DEVICE_FUNC Index	size () const

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

Protected Attributes
DiagonalVectorType	m_diagonal

Detailed Description

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
class Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >

Represents a diagonal matrix with its storage.

Parameters

_Scalar	the type of coefficients
SizeAtCompileTime	the dimension of the matrix, or Dynamic
MaxSizeAtCompileTime	the dimension of the matrix, or Dynamic. This parameter is optional and defaults to SizeAtCompileTime. Most of the time, you do not need to specify it.

See also: class DiagonalWrapper

Definition at line 116 of file DiagonalMatrix.h.

Member Typedef Documentation

◆ DiagonalVectorType

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

typedef internal::traits<DiagonalMatrix>::DiagonalVectorType Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalVectorType

Definition at line 121 of file DiagonalMatrix.h.

◆ Nested

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

typedef const DiagonalMatrix& Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::Nested

Definition at line 122 of file DiagonalMatrix.h.

◆ Scalar

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

typedef _Scalar Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::Scalar

Definition at line 123 of file DiagonalMatrix.h.

◆ StorageIndex

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

typedef internal::traits<DiagonalMatrix>::StorageIndex Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::StorageIndex

Definition at line 125 of file DiagonalMatrix.h.

◆ StorageKind

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

typedef internal::traits<DiagonalMatrix>::StorageKind Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::StorageKind

Definition at line 124 of file DiagonalMatrix.h.

Constructor & Destructor Documentation

◆ DiagonalMatrix() [1/7]

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( )

inline

Default constructor without initialization

Definition at line 143 of file DiagonalMatrix.h.

◆ DiagonalMatrix() [2/7]

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( Index dim )

inlineexplicit

Constructs a diagonal matrix with given dimension

Definition at line 147 of file DiagonalMatrix.h.

◆ DiagonalMatrix() [3/7]

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix	(	const Scalar &	x,
		const Scalar &	y
	)

inline

2D constructor.

Definition at line 151 of file DiagonalMatrix.h.

◆ DiagonalMatrix() [4/7]

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix	(	const Scalar &	x,
		const Scalar &	y,
		const Scalar &	z
	)

inline

3D constructor.

Definition at line 155 of file DiagonalMatrix.h.

◆ DiagonalMatrix() [5/7]

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( const DiagonalBase< OtherDerived > & other )

inline

Copy constructor.

Definition at line 160 of file DiagonalMatrix.h.

◆ DiagonalMatrix() [6/7]

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( const DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > & other )

inline

copy constructor. prevent a default copy constructor from hiding the other templated constructor

Definition at line 164 of file DiagonalMatrix.h.

◆ DiagonalMatrix() [7/7]

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix ( const MatrixBase< OtherDerived > & other )

inlineexplicit

generic constructor from expression of the diagonal coefficients

Definition at line 170 of file DiagonalMatrix.h.

Member Function Documentation

◆ diagonal() [1/2]

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC const DiagonalVectorType& Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::diagonal ( ) const

inline

const version of diagonal().

Definition at line 136 of file DiagonalMatrix.h.

◆ diagonal() [2/2]

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC DiagonalVectorType& Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::diagonal ( )

inline

Returns: a reference to the stored vector of diagonal coefficients.

Definition at line 139 of file DiagonalMatrix.h.

◆ operator=() [1/2]

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

template<typename OtherDerived >

EIGEN_DEVICE_FUNC DiagonalMatrix& Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::operator= ( const DiagonalBase< OtherDerived > & other )

inline

Copy operator.

Definition at line 176 of file DiagonalMatrix.h.

◆ operator=() [2/2]

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC DiagonalMatrix& Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::operator= ( const DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > & other )

inline

This is a special case of the templated operator=. Its purpose is to prevent a default operator= from hiding the templated operator=.

Definition at line 187 of file DiagonalMatrix.h.

◆ resize()

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC void Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::resize ( Index size )

inline

Resizes to given size.

Definition at line 196 of file DiagonalMatrix.h.

◆ setIdentity() [1/2]

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC void Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setIdentity ( )

inline

Sets this matrix to be the identity matrix of the current size.

Definition at line 205 of file DiagonalMatrix.h.

◆ setIdentity() [2/2]

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC void Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setIdentity ( Index size )

inline

Sets this matrix to be the identity matrix of the given size.

Definition at line 208 of file DiagonalMatrix.h.

◆ setZero() [1/2]

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC void Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setZero ( )

inline

Sets all coefficients to zero.

Definition at line 199 of file DiagonalMatrix.h.

◆ setZero() [2/2]

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

EIGEN_DEVICE_FUNC void Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setZero ( Index size )

inline

Resizes and sets all coefficients to zero.

Definition at line 202 of file DiagonalMatrix.h.

Member Data Documentation

◆ m_diagonal

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

DiagonalVectorType Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal

protected

Definition at line 130 of file DiagonalMatrix.h.

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

DiagonalMatrix.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime> class Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >

Member Typedef Documentation

◆ DiagonalVectorType

◆ Nested

◆ Scalar

◆ StorageIndex

◆ StorageKind

Constructor & Destructor Documentation

◆ DiagonalMatrix() [1/7]

◆ DiagonalMatrix() [2/7]

◆ DiagonalMatrix() [3/7]

◆ DiagonalMatrix() [4/7]

◆ DiagonalMatrix() [5/7]

◆ DiagonalMatrix() [6/7]

◆ DiagonalMatrix() [7/7]

Member Function Documentation

◆ diagonal() [1/2]

◆ diagonal() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ resize()

◆ setIdentity() [1/2]

◆ setIdentity() [2/2]

◆ setZero() [1/2]

◆ setZero() [2/2]

Member Data Documentation

◆ m_diagonal

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
class Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >