Public Types | Public Member Functions | Protected Attributes | Private Member Functions
Diagonal< MatrixType, DiagIndex > Class Template Reference

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

#include <Diagonal.h>

Inheritance diagram for Diagonal< MatrixType, DiagIndex >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef
internal::dense_xpr_base
< Diagonal >::type 
Base

Public Member Functions

CoeffReturnType coeff (Index row, Index) const
CoeffReturnType coeff (Index index) const
ScalarcoeffRef (Index row, Index)
const ScalarcoeffRef (Index row, Index) const
ScalarcoeffRef (Index index)
const ScalarcoeffRef (Index index) const
Index cols () const
 Diagonal (MatrixType &matrix, Index index=DiagIndex)
Index innerStride () const
Index outerStride () const
Index rows () const

Protected Attributes

const
internal::variable_if_dynamic
< Index, DiagIndex > 
m_index
const MatrixType::Nested m_matrix

Private Member Functions

EIGEN_STRONG_INLINE Index absDiagIndex () const
EIGEN_STRONG_INLINE Index colOffset () const
template<int LoadMode>
MatrixType::PacketReturnType packet (Index) const
template<int LoadMode>
MatrixType::PacketReturnType packet (Index, Index) const
EIGEN_STRONG_INLINE Index rowOffset () const

Detailed Description

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

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

Parameters:
MatrixTypethe type of the object in which we are taking a sub/main/super diagonal
DiagIndexthe 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 77 of file Diagonal.h.


Member Typedef Documentation

template<typename MatrixType, int DiagIndex>
typedef internal::dense_xpr_base<Diagonal>::type Diagonal< MatrixType, DiagIndex >::Base

Definition at line 82 of file Diagonal.h.


Constructor & Destructor Documentation

template<typename MatrixType, int DiagIndex>
Diagonal< MatrixType, DiagIndex >::Diagonal ( MatrixType matrix,
Index  index = DiagIndex 
) [inline]

Definition at line 85 of file Diagonal.h.


Member Function Documentation

template<typename MatrixType, int DiagIndex>
EIGEN_STRONG_INLINE Index Diagonal< MatrixType, DiagIndex >::absDiagIndex ( ) const [inline, private]

Definition at line 142 of file Diagonal.h.

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

Definition at line 115 of file Diagonal.h.

template<typename MatrixType, int DiagIndex>
CoeffReturnType Diagonal< MatrixType, DiagIndex >::coeff ( Index  index) const [inline]

Definition at line 131 of file Diagonal.h.

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

Definition at line 104 of file Diagonal.h.

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

Definition at line 110 of file Diagonal.h.

template<typename MatrixType, int DiagIndex>
Scalar& Diagonal< MatrixType, DiagIndex >::coeffRef ( Index  index) [inline]

Definition at line 120 of file Diagonal.h.

template<typename MatrixType, int DiagIndex>
const Scalar& Diagonal< MatrixType, DiagIndex >::coeffRef ( Index  index) const [inline]

Definition at line 126 of file Diagonal.h.

template<typename MatrixType, int DiagIndex>
EIGEN_STRONG_INLINE Index Diagonal< MatrixType, DiagIndex >::colOffset ( ) const [inline, private]

Definition at line 144 of file Diagonal.h.

template<typename MatrixType, int DiagIndex>
Index Diagonal< MatrixType, DiagIndex >::cols ( void  ) const [inline]

Definition at line 92 of file Diagonal.h.

template<typename MatrixType, int DiagIndex>
Index Diagonal< MatrixType, DiagIndex >::innerStride ( ) const [inline]

Definition at line 94 of file Diagonal.h.

template<typename MatrixType, int DiagIndex>
Index Diagonal< MatrixType, DiagIndex >::outerStride ( ) const [inline]

Definition at line 99 of file Diagonal.h.

template<typename MatrixType, int DiagIndex>
template<int LoadMode>
MatrixType::PacketReturnType Diagonal< MatrixType, DiagIndex >::packet ( Index  ) const [private]
template<typename MatrixType, int DiagIndex>
template<int LoadMode>
MatrixType::PacketReturnType Diagonal< MatrixType, DiagIndex >::packet ( Index  ,
Index   
) const [private]
template<typename MatrixType, int DiagIndex>
EIGEN_STRONG_INLINE Index Diagonal< MatrixType, DiagIndex >::rowOffset ( ) const [inline, private]

Definition at line 143 of file Diagonal.h.

template<typename MatrixType, int DiagIndex>
Index Diagonal< MatrixType, DiagIndex >::rows ( void  ) const [inline]

Definition at line 89 of file Diagonal.h.


Member Data Documentation

template<typename MatrixType, int DiagIndex>
const internal::variable_if_dynamic<Index, DiagIndex> Diagonal< MatrixType, DiagIndex >::m_index [protected]

Definition at line 138 of file Diagonal.h.

template<typename MatrixType, int DiagIndex>
const MatrixType::Nested Diagonal< MatrixType, DiagIndex >::m_matrix [protected]

Definition at line 137 of file Diagonal.h.


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


libicr
Author(s): Robert Krug
autogenerated on Mon Jan 6 2014 11:34:15