Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > Class Template Reference

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 internal::traits< DiagonalMatrix >::Index	Index
typedef const DiagonalMatrix &	Nested
typedef _Scalar	Scalar
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 internal::traits< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::Index	Index
typedef DiagonalMatrix< Scalar, DiagonalVectorType::SizeAtCompileTime, DiagonalVectorType::MaxSizeAtCompileTime >	PlainObject
typedef DiagonalVectorType::RealScalar	RealScalar
typedef DiagonalVectorType::Scalar	Scalar
typedef internal::traits< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >::StorageKind	StorageKind
Public Types inherited from Eigen::EigenBase< Derived >
typedef internal::traits< Derived >::Index	Index
typedef internal::traits< Derived >::StorageKind	StorageKind

Public Member Functions
const DiagonalVectorType &	diagonal () const
DiagonalVectorType &	diagonal ()
	DiagonalMatrix ()
	DiagonalMatrix (Index dim)
	DiagonalMatrix (const Scalar &x, const Scalar &y)
	DiagonalMatrix (const Scalar &x, const Scalar &y, const Scalar &z)
template<typename OtherDerived >
	DiagonalMatrix (const DiagonalBase< OtherDerived > &other)
	DiagonalMatrix (const DiagonalMatrix &other)
template<typename OtherDerived >
	DiagonalMatrix (const MatrixBase< OtherDerived > &other)
template<typename OtherDerived >
DiagonalMatrix &	operator= (const DiagonalBase< OtherDerived > &other)
DiagonalMatrix &	operator= (const DiagonalMatrix &other)
void	resize (Index size)
void	setIdentity ()
void	setIdentity (Index size)
void	setZero ()
void	setZero (Index size)
Public Member Functions inherited from Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >
void	addTo (MatrixBase< DenseDerived > &other) const
Index	cols () const
const DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > &	derived () const
DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > &	derived ()
const DiagonalVectorType &	diagonal () const
DiagonalVectorType &	diagonal ()
void	evalTo (MatrixBase< DenseDerived > &other) const
const DiagonalWrapper< const CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const DiagonalVectorType > >	inverse () const
const DiagonalProduct< MatrixDerived, DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >, OnTheLeft >	operator* (const MatrixBase< MatrixDerived > &matrix) const
const DiagonalWrapper< const CwiseUnaryOp< internal::scalar_multiple_op< Scalar >, const DiagonalVectorType > >	operator* (const Scalar &scalar) const
Index	rows () const
void	subTo (MatrixBase< DenseDerived > &other) const
DenseMatrixType	toDenseMatrix () const
Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
void	addTo (Dest &dst) const
template<typename Dest >
void	applyThisOnTheLeft (Dest &dst) const
template<typename Dest >
void	applyThisOnTheRight (Dest &dst) const
Index	cols () const
Derived &	const_cast_derived () const
const Derived &	const_derived () const
Derived &	derived ()
const Derived &	derived () const
template<typename Dest >
void	evalTo (Dest &dst) const
Index	rows () const
Index	size () const
template<typename Dest >
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 135 of file DiagonalMatrix.h.

Member Typedef Documentation

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

Definition at line 140 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

Definition at line 144 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

Definition at line 141 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

Definition at line 142 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

Definition at line 143 of file DiagonalMatrix.h.

Constructor & Destructor Documentation

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

inline

Default constructor without initialization

Definition at line 159 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

inline

Constructs a diagonal matrix with given dimension

Definition at line 162 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

inline

2D constructor.

Definition at line 165 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

inline

3D constructor.

Definition at line 168 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

template<typename OtherDerived >

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

inline

Copy constructor.

Definition at line 172 of file DiagonalMatrix.h.

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 176 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

template<typename OtherDerived >

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

inlineexplicit

generic constructor from expression of the diagonal coefficients

Definition at line 181 of file DiagonalMatrix.h.

Member Function Documentation

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

inline

const version of diagonal().

Definition at line 154 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

inline

Returns

a reference to the stored vector of diagonal coefficients.

Definition at line 156 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

template<typename OtherDerived >

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

inline

Copy operator.

Definition at line 186 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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 196 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

inline

Resizes to given size.

Definition at line 204 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

inline

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

Definition at line 210 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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 212 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

inline

Sets all coefficients to zero.

Definition at line 206 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

inline

Resizes and sets all coefficients to zero.

Definition at line 208 of file DiagonalMatrix.h.

Member Data Documentation

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

protected

Definition at line 149 of file DiagonalMatrix.h.

---

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

• DiagonalMatrix.h