DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > Class Template Reference

---

Detailed Description

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>
class 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 117 of file DiagonalMatrix.h.

#include <src/Core/DiagonalMatrix.h>

List of all members.

Public Member Functions
const DiagonalVectorType &	diagonal () const
	const version of diagonal().
DiagonalVectorType &	diagonal ()
	DiagonalMatrix ()
	Default constructor without initialization.
	DiagonalMatrix (Index dim)
	Constructs a diagonal matrix with given dimension.
	DiagonalMatrix (const Scalar &x, const Scalar &y)
	2D constructor.
	DiagonalMatrix (const Scalar &x, const Scalar &y, const Scalar &z)
	3D constructor.
template<typename OtherDerived >
	DiagonalMatrix (const DiagonalBase< OtherDerived > &other)
	Copy constructor.
template<typename OtherDerived >
	DiagonalMatrix (const MatrixBase< OtherDerived > &other)
	generic constructor from expression of the diagonal coefficients
template<typename OtherDerived >
DiagonalMatrix &	operator= (const DiagonalBase< OtherDerived > &other)
	Copy operator.
void	resize (Index size)
	Resizes to given size.
void	setZero ()
	Sets all coefficients to zero.
void	setZero (Index size)
	Resizes and sets all coefficients to zero.
void	setIdentity ()
	Sets this matrix to be the identity matrix of the current size.
void	setIdentity (Index size)
	Sets this matrix to be the identity matrix of the given size.
Protected Attributes
DiagonalVectorType	m_diagonal

---

Constructor & Destructor Documentation

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix

(

)

[inline]

Default constructor without initialization.

Definition at line 141 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix

(

Index

dim )

[inline]

Constructs a diagonal matrix with given dimension.

Definition at line 144 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix	(	const Scalar &	x,
		const Scalar &	y
	)		[inline]

2D constructor.

Definition at line 147 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

3D constructor.

Definition at line 150 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

template<typename OtherDerived >

DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix

(

const DiagonalBase< OtherDerived > &

other )

[inline]

Copy constructor.

Definition at line 154 of file DiagonalMatrix.h.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

template<typename OtherDerived >

DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::DiagonalMatrix

(

const MatrixBase< OtherDerived > &

other )

[inline, explicit]

generic constructor from expression of the diagonal coefficients

Definition at line 163 of file DiagonalMatrix.h.

---

Member Function Documentation

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

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

(

)

const [inline]

const version of diagonal().

Definition at line 136 of file DiagonalMatrix.h.

References DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

DiagonalVectorType& DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::diagonal

(

)

[inline]

Returns:

a reference to the stored vector of diagonal coefficients.

Definition at line 138 of file DiagonalMatrix.h.

References DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

template<typename OtherDerived >

DiagonalMatrix& DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::operator=

(

const DiagonalBase< OtherDerived > &

other )

[inline]

Copy operator.

Definition at line 168 of file DiagonalMatrix.h.

References DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

void DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::resize

(

Index

size )

[inline]

Resizes to given size.

Definition at line 186 of file DiagonalMatrix.h.

References DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

void DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setIdentity

(

Index

size )

[inline]

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

Definition at line 194 of file DiagonalMatrix.h.

References DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

void DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setIdentity

(

)

[inline]

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

Definition at line 192 of file DiagonalMatrix.h.

References DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

void DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setZero

(

Index

size )

[inline]

Resizes and sets all coefficients to zero.

Definition at line 190 of file DiagonalMatrix.h.

References DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal.

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

void DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setZero

(

)

[inline]

Sets all coefficients to zero.

Definition at line 188 of file DiagonalMatrix.h.

References DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal.

---

Member Data Documentation

template<typename _Scalar, int SizeAtCompileTime, int MaxSizeAtCompileTime>

DiagonalVectorType DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::m_diagonal [protected]

Definition at line 131 of file DiagonalMatrix.h.

Referenced by DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::diagonal(), DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::operator=(), DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::resize(), DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setIdentity(), and DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setZero().