DiagonalCoeffs< MatrixType > Class Template Reference

Expression of the main diagonal of a matrix. More...

#include <DiagonalCoeffs.h>

Inheritance diagram for DiagonalCoeffs< MatrixType >:

[legend]

List of all members.

Public Member Functions
const Scalar	coeff (int index) const
const Scalar	coeff (int row, int) const
Scalar &	coeffRef (int index)
Scalar &	coeffRef (int row, int)
int	cols () const
	DiagonalCoeffs (const MatrixType &matrix)
int	rows () const
Protected Attributes
const MatrixType::Nested	m_matrix

---

Detailed Description

template<typename MatrixType>
class DiagonalCoeffs< MatrixType >

Expression of the main diagonal of a matrix.

Parameters:

MatrixType

the type of the object in which we are taking the main diagonal

The matrix is not required to be square.

This class represents an expression of the main diagonal of a square matrix. It is the return type of MatrixBase::diagonal() and most of the time this is the only way it is used.

See also:

MatrixBase::diagonal()

Definition at line 62 of file DiagonalCoeffs.h.

---

Constructor & Destructor Documentation

template<typename MatrixType>

DiagonalCoeffs< MatrixType >::DiagonalCoeffs

(

const MatrixType &

matrix

)

[inline]

Definition at line 69 of file DiagonalCoeffs.h.

---

Member Function Documentation

template<typename MatrixType>

const Scalar DiagonalCoeffs< MatrixType >::coeff

(

int

index

)

const [inline]

Reimplemented from MatrixBase< DiagonalCoeffs< MatrixType > >.

Definition at line 91 of file DiagonalCoeffs.h.

template<typename MatrixType>

const Scalar DiagonalCoeffs< MatrixType >::coeff	(	int	row,
		int
	)			const [inline]

Reimplemented from MatrixBase< DiagonalCoeffs< MatrixType > >.

Definition at line 81 of file DiagonalCoeffs.h.

template<typename MatrixType>

Scalar& DiagonalCoeffs< MatrixType >::coeffRef

(

int

index

)

[inline]

Reimplemented from MatrixBase< DiagonalCoeffs< MatrixType > >.

Definition at line 86 of file DiagonalCoeffs.h.

template<typename MatrixType>

Scalar& DiagonalCoeffs< MatrixType >::coeffRef	(	int	row,
		int
	)			[inline]

Reimplemented from MatrixBase< DiagonalCoeffs< MatrixType > >.

Definition at line 76 of file DiagonalCoeffs.h.

template<typename MatrixType>

int DiagonalCoeffs< MatrixType >::cols

(

)

const [inline]

Returns:

the number of columns.

See also:

rows(), ColsAtCompileTime

Reimplemented from MatrixBase< DiagonalCoeffs< MatrixType > >.

Definition at line 74 of file DiagonalCoeffs.h.

template<typename MatrixType>

int DiagonalCoeffs< MatrixType >::rows

(

)

const [inline]

Returns:

the number of rows.

See also:

cols(), RowsAtCompileTime

Reimplemented from MatrixBase< DiagonalCoeffs< MatrixType > >.

Definition at line 73 of file DiagonalCoeffs.h.

---

Member Data Documentation

template<typename MatrixType>

const MatrixType::Nested DiagonalCoeffs< MatrixType >::m_matrix [protected]

Definition at line 98 of file DiagonalCoeffs.h.

---

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

• DiagonalCoeffs.h