DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > Class Template Reference

---

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

Inherits DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >.

List of all members.

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)
template<typename OtherDerived >
	DiagonalMatrix (const MatrixBase< OtherDerived > &other)
template<typename OtherDerived >
DiagonalMatrix &	operator= (const DiagonalBase< OtherDerived > &other)
void	resize (Index size)
void	setIdentity ()
void	setIdentity (Index size)
void	setZero ()
void	setZero (Index size)

---

Constructor & Destructor Documentation

DiagonalMatrix

(

)

[inline]

Default constructor without initialization

DiagonalMatrix

(

Index

dim

)

[inline]

Constructs a diagonal matrix with given dimension

DiagonalMatrix	(	const Scalar &	x,
		const Scalar &	y
	)		[inline]

2D constructor.

DiagonalMatrix	(	const Scalar &	x,
		const Scalar &	y,
		const Scalar &	z
	)		[inline]

3D constructor.

DiagonalMatrix

(

const DiagonalBase< OtherDerived > &

other

)

[inline]

Copy constructor.

DiagonalMatrix

(

const MatrixBase< OtherDerived > &

other

)

[inline, explicit]

generic constructor from expression of the diagonal coefficients

---

Member Function Documentation

const DiagonalVectorType& diagonal

(

)

const [inline]

const version of diagonal().

DiagonalVectorType& diagonal

(

)

[inline]

Returns:

a reference to the stored vector of diagonal coefficients.

DiagonalMatrix& operator=

(

const DiagonalBase< OtherDerived > &

other

)

[inline]

Copy operator.

void resize

(

Index

size

)

[inline]

Resizes to given size.

void setIdentity

(

)

[inline]

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

void setIdentity

(

Index

size

)

[inline]

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

void setZero

(

)

[inline]

Sets all coefficients to zero.

void setZero

(

Index

size

)

[inline]

Resizes and sets all coefficients to zero.

---

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

• DiagonalMatrix.h