Eigen::Diagonal< MatrixType, DiagIndex > Class Template Reference

---

Detailed Description

template<typename MatrixType, int DiagIndex>
class Eigen::Diagonal< MatrixType, DiagIndex >

Expression of a diagonal/subdiagonal/superdiagonal in a matrix.

Parameters:

MatrixType	the type of the object in which we are taking a sub/main/super diagonal
DiagIndex	the index of the sub/super diagonal. The default is 0 and it means the main diagonal. A positive value means a superdiagonal, a negative value means a subdiagonal. You can also use Dynamic so the index can be set at runtime.

The matrix is not required to be square.

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

See also:

MatrixBase::diagonal(), MatrixBase::diagonal(Index)

Definition at line 78 of file Core.

Inheritance diagram for Eigen::Diagonal< MatrixType, DiagIndex >:

List of all members.

Public Types
typedef internal::dense_xpr_base < Diagonal >::type	Base
Public Member Functions
	Diagonal (MatrixType &matrix, Index index=DiagIndex)
Index	rows () const
Index	cols () const
Index	innerStride () const
Index	outerStride () const
Scalar &	coeffRef (Index row, Index)
const Scalar &	coeffRef (Index row, Index) const
CoeffReturnType	coeff (Index row, Index) const
Scalar &	coeffRef (Index index)
const Scalar &	coeffRef (Index index) const
CoeffReturnType	coeff (Index index) const
Protected Attributes
const MatrixType::Nested	m_matrix
const internal::variable_if_dynamic < Index, DiagIndex >	m_index
Private Member Functions
EIGEN_STRONG_INLINE Index	absDiagIndex () const
EIGEN_STRONG_INLINE Index	rowOffset () const
EIGEN_STRONG_INLINE Index	colOffset () const
template<int LoadMode>
MatrixType::PacketReturnType	packet (Index) const
template<int LoadMode>
MatrixType::PacketReturnType	packet (Index, Index) const

---

Member Typedef Documentation

template<typename MatrixType , int DiagIndex>

typedef internal::dense_xpr_base<Diagonal>::type Eigen::Diagonal< MatrixType, DiagIndex >::Base

Definition at line 83 of file Core.

---

Constructor & Destructor Documentation

template<typename MatrixType , int DiagIndex>

Eigen::Diagonal< MatrixType, DiagIndex >::Diagonal	(	MatrixType &	matrix,
		Index	index = DiagIndex
	)		[inline]

Definition at line 86 of file Core.

---

Member Function Documentation

template<typename MatrixType , int DiagIndex>

EIGEN_STRONG_INLINE Index Eigen::Diagonal< MatrixType, DiagIndex >::absDiagIndex

(

)

const [inline, private]

Definition at line 143 of file Core.

template<typename MatrixType , int DiagIndex>

CoeffReturnType Eigen::Diagonal< MatrixType, DiagIndex >::coeff	(	Index	row,
		Index
	)		const [inline]

Definition at line 116 of file Core.

template<typename MatrixType , int DiagIndex>

CoeffReturnType Eigen::Diagonal< MatrixType, DiagIndex >::coeff

(

Index

index

)

const [inline]

Definition at line 132 of file Core.

template<typename MatrixType , int DiagIndex>

const Scalar& Eigen::Diagonal< MatrixType, DiagIndex >::coeffRef

(

Index

index

)

const [inline]

Definition at line 127 of file Core.

template<typename MatrixType , int DiagIndex>

Scalar& Eigen::Diagonal< MatrixType, DiagIndex >::coeffRef

(

Index

index

)

[inline]

Definition at line 121 of file Core.

template<typename MatrixType , int DiagIndex>

Scalar& Eigen::Diagonal< MatrixType, DiagIndex >::coeffRef	(	Index	row,
		Index
	)		[inline]

Definition at line 105 of file Core.

template<typename MatrixType , int DiagIndex>

const Scalar& Eigen::Diagonal< MatrixType, DiagIndex >::coeffRef	(	Index	row,
		Index
	)		const [inline]

Definition at line 111 of file Core.

template<typename MatrixType , int DiagIndex>

EIGEN_STRONG_INLINE Index Eigen::Diagonal< MatrixType, DiagIndex >::colOffset

(

)

const [inline, private]

Definition at line 145 of file Core.

template<typename MatrixType , int DiagIndex>

Index Eigen::Diagonal< MatrixType, DiagIndex >::cols

(

void

)

const [inline]

Definition at line 93 of file Core.

template<typename MatrixType , int DiagIndex>

Index Eigen::Diagonal< MatrixType, DiagIndex >::innerStride

(

)

const [inline]

Definition at line 95 of file Core.

template<typename MatrixType , int DiagIndex>

Index Eigen::Diagonal< MatrixType, DiagIndex >::outerStride

(

)

const [inline]

Definition at line 100 of file Core.

template<typename MatrixType , int DiagIndex>

template<int LoadMode>

MatrixType::PacketReturnType Eigen::Diagonal< MatrixType, DiagIndex >::packet	(	Index	,
		Index
	)		const [private]

template<typename MatrixType , int DiagIndex>

template<int LoadMode>

MatrixType::PacketReturnType Eigen::Diagonal< MatrixType, DiagIndex >::packet

(

Index

)

const [private]

template<typename MatrixType , int DiagIndex>

EIGEN_STRONG_INLINE Index Eigen::Diagonal< MatrixType, DiagIndex >::rowOffset

(

)

const [inline, private]

Definition at line 144 of file Core.

template<typename MatrixType , int DiagIndex>

Index Eigen::Diagonal< MatrixType, DiagIndex >::rows

(

void

)

const [inline]

Definition at line 90 of file Core.

---

Member Data Documentation

template<typename MatrixType , int DiagIndex>

const internal::variable_if_dynamic<Index, DiagIndex> Eigen::Diagonal< MatrixType, DiagIndex >::m_index [protected]

Definition at line 139 of file Core.

template<typename MatrixType , int DiagIndex>

const MatrixType::Nested Eigen::Diagonal< MatrixType, DiagIndex >::m_matrix [protected]

Definition at line 138 of file Core.