DiagonalMatrix< CoeffsVectorType > Class Template Reference

Expression of a diagonal matrix. More...

#include <DiagonalMatrix.h>

Inheritance diagram for DiagonalMatrix< CoeffsVectorType >:

[legend]

List of all members.

Public Types
typedef CoeffsVectorType	_CoeffsVectorType
Public Member Functions
const Scalar	coeff (int row, int col) const
int	cols () const
const CoeffsVectorType &	diagonal () const
	DiagonalMatrix (const CoeffsVectorType &coeffs)
template<typename OtherCoeffsVectorType >
	DiagonalMatrix (const DiagonalMatrix< OtherCoeffsVectorType > &other)
int	rows () const
Protected Attributes
const CoeffsVectorType::Nested	m_coeffs

---

Detailed Description

template<typename CoeffsVectorType>
class DiagonalMatrix< CoeffsVectorType >

Expression of a diagonal matrix.

Parameters:

CoeffsVectorType

the type of the vector of diagonal coefficients

This class is an expression of a diagonal matrix with given vector of diagonal coefficients. It is the return type of MatrixBase::diagonal(const OtherDerived&) and most of the time this is the only way it is used.

See also:

MatrixBase::diagonal(const OtherDerived&)

Definition at line 59 of file DiagonalMatrix.h.

---

Member Typedef Documentation

template<typename CoeffsVectorType>

typedef CoeffsVectorType DiagonalMatrix< CoeffsVectorType >::_CoeffsVectorType

Definition at line 65 of file DiagonalMatrix.h.

---

Constructor & Destructor Documentation

template<typename CoeffsVectorType>

template<typename OtherCoeffsVectorType >

DiagonalMatrix< CoeffsVectorType >::DiagonalMatrix

(

const DiagonalMatrix< OtherCoeffsVectorType > &

other

)

[inline]

Definition at line 69 of file DiagonalMatrix.h.

template<typename CoeffsVectorType>

DiagonalMatrix< CoeffsVectorType >::DiagonalMatrix

(

const CoeffsVectorType &

coeffs

)

[inline]

Definition at line 76 of file DiagonalMatrix.h.

---

Member Function Documentation

template<typename CoeffsVectorType>

const Scalar DiagonalMatrix< CoeffsVectorType >::coeff	(	int	row,
		int	col
	)			const [inline]

Reimplemented from MatrixBase< DiagonalMatrix< CoeffsVectorType > >.

Definition at line 85 of file DiagonalMatrix.h.

template<typename CoeffsVectorType>

int DiagonalMatrix< CoeffsVectorType >::cols

(

)

const [inline]

Returns:

the number of columns.

See also:

rows(), ColsAtCompileTime

Reimplemented from MatrixBase< DiagonalMatrix< CoeffsVectorType > >.

Definition at line 83 of file DiagonalMatrix.h.

template<typename CoeffsVectorType>

const CoeffsVectorType& DiagonalMatrix< CoeffsVectorType >::diagonal

(

)

const [inline]

Reimplemented from MatrixBase< DiagonalMatrix< CoeffsVectorType > >.

Definition at line 90 of file DiagonalMatrix.h.

template<typename CoeffsVectorType>

int DiagonalMatrix< CoeffsVectorType >::rows

(

)

const [inline]

Returns:

the number of rows.

See also:

cols(), RowsAtCompileTime

Reimplemented from MatrixBase< DiagonalMatrix< CoeffsVectorType > >.

Definition at line 82 of file DiagonalMatrix.h.

---

Member Data Documentation

template<typename CoeffsVectorType>

const CoeffsVectorType::Nested DiagonalMatrix< CoeffsVectorType >::m_coeffs [protected]

Definition at line 93 of file DiagonalMatrix.h.

---

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

• DiagonalMatrix.h