Public Types | Public Member Functions | Protected Attributes | Private Member Functions | List of all members
Eigen::Diagonal< MatrixType, _DiagIndex > Class Template Reference

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

#include <Diagonal.h>

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

Public Types

enum  { DiagIndex = _DiagIndex }
 
typedef internal::dense_xpr_base< Diagonal >::type Base
 
typedef internal::conditional< internal::is_lvalue< MatrixType >::value, Scalar, const Scalar >::type ScalarWithConstIfNotLvalue
 

Public Member Functions

EIGEN_DEVICE_FUNC CoeffReturnType coeff (Index idx) const
 
EIGEN_DEVICE_FUNC CoeffReturnType coeff (Index row, Index) const
 
EIGEN_DEVICE_FUNC ScalarcoeffRef (Index idx)
 
const EIGEN_DEVICE_FUNC ScalarcoeffRef (Index idx) const
 
EIGEN_DEVICE_FUNC ScalarcoeffRef (Index row, Index)
 
const EIGEN_DEVICE_FUNC ScalarcoeffRef (Index row, Index) const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC ScalarWithConstIfNotLvaluedata ()
 
const EIGEN_DEVICE_FUNC Scalardata () const
 
EIGEN_DEVICE_FUNC Diagonal (MatrixType &matrix, Index a_index=DiagIndex)
 
EIGEN_DEVICE_FUNC Index index () const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index innerStride () const EIGEN_NOEXCEPT
 
const EIGEN_DEVICE_FUNC internal::remove_all< typename MatrixType::Nested >::typenestedExpression () const
 
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index outerStride () const EIGEN_NOEXCEPT
 
EIGEN_DEVICE_FUNC Index rows () const
 

Protected Attributes

const internal::variable_if_dynamicindex< Index, DiagIndexm_index
 
internal::ref_selector< MatrixType >::non_const_type m_matrix
 

Private Member Functions

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

Detailed Description

template<typename MatrixType, int _DiagIndex>
class Eigen::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 DynamicIndex 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 63 of file Diagonal.h.

Member Typedef Documentation

◆ Base

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

Definition at line 69 of file Diagonal.h.

◆ ScalarWithConstIfNotLvalue

template<typename MatrixType , int _DiagIndex>
typedef internal::conditional< internal::is_lvalue<MatrixType>::value, Scalar, const Scalar >::type Eigen::Diagonal< MatrixType, _DiagIndex >::ScalarWithConstIfNotLvalue

Definition at line 102 of file Diagonal.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename MatrixType , int _DiagIndex>
anonymous enum
Enumerator
DiagIndex 

Definition at line 68 of file Diagonal.h.

Constructor & Destructor Documentation

◆ Diagonal()

template<typename MatrixType , int _DiagIndex>
EIGEN_DEVICE_FUNC Eigen::Diagonal< MatrixType, _DiagIndex >::Diagonal ( MatrixType matrix,
Index  a_index = DiagIndex 
)
inlineexplicit

Definition at line 73 of file Diagonal.h.

Member Function Documentation

◆ absDiagIndex()

template<typename MatrixType , int _DiagIndex>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index Eigen::Diagonal< MatrixType, _DiagIndex >::absDiagIndex ( ) const
inlineprivate

Definition at line 167 of file Diagonal.h.

◆ coeff() [1/2]

template<typename MatrixType , int _DiagIndex>
EIGEN_DEVICE_FUNC CoeffReturnType Eigen::Diagonal< MatrixType, _DiagIndex >::coeff ( Index  idx) const
inline

Definition at line 142 of file Diagonal.h.

◆ coeff() [2/2]

template<typename MatrixType , int _DiagIndex>
EIGEN_DEVICE_FUNC CoeffReturnType Eigen::Diagonal< MatrixType, _DiagIndex >::coeff ( Index  row,
Index   
) const
inline

Definition at line 123 of file Diagonal.h.

◆ coeffRef() [1/4]

template<typename MatrixType , int _DiagIndex>
EIGEN_DEVICE_FUNC Scalar& Eigen::Diagonal< MatrixType, _DiagIndex >::coeffRef ( Index  idx)
inline

Definition at line 129 of file Diagonal.h.

◆ coeffRef() [2/4]

template<typename MatrixType , int _DiagIndex>
const EIGEN_DEVICE_FUNC Scalar& Eigen::Diagonal< MatrixType, _DiagIndex >::coeffRef ( Index  idx) const
inline

Definition at line 136 of file Diagonal.h.

◆ coeffRef() [3/4]

template<typename MatrixType , int _DiagIndex>
EIGEN_DEVICE_FUNC Scalar& Eigen::Diagonal< MatrixType, _DiagIndex >::coeffRef ( Index  row,
Index   
)
inline

Definition at line 110 of file Diagonal.h.

◆ coeffRef() [4/4]

template<typename MatrixType , int _DiagIndex>
const EIGEN_DEVICE_FUNC Scalar& Eigen::Diagonal< MatrixType, _DiagIndex >::coeffRef ( Index  row,
Index   
) const
inline

Definition at line 117 of file Diagonal.h.

◆ colOffset()

template<typename MatrixType , int _DiagIndex>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index Eigen::Diagonal< MatrixType, _DiagIndex >::colOffset ( ) const
inlineprivate

Definition at line 171 of file Diagonal.h.

◆ cols()

template<typename MatrixType , int _DiagIndex>
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::Diagonal< MatrixType, _DiagIndex >::cols ( ) const
inline

Definition at line 88 of file Diagonal.h.

◆ data() [1/2]

template<typename MatrixType , int _DiagIndex>
EIGEN_DEVICE_FUNC ScalarWithConstIfNotLvalue* Eigen::Diagonal< MatrixType, _DiagIndex >::data ( )
inline

Definition at line 105 of file Diagonal.h.

◆ data() [2/2]

template<typename MatrixType , int _DiagIndex>
const EIGEN_DEVICE_FUNC Scalar* Eigen::Diagonal< MatrixType, _DiagIndex >::data ( ) const
inline

Definition at line 107 of file Diagonal.h.

◆ index()

template<typename MatrixType , int _DiagIndex>
EIGEN_DEVICE_FUNC Index Eigen::Diagonal< MatrixType, _DiagIndex >::index ( ) const
inline

Definition at line 155 of file Diagonal.h.

◆ innerStride()

template<typename MatrixType , int _DiagIndex>
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::Diagonal< MatrixType, _DiagIndex >::innerStride ( ) const
inline

Definition at line 91 of file Diagonal.h.

◆ nestedExpression()

template<typename MatrixType , int _DiagIndex>
const EIGEN_DEVICE_FUNC internal::remove_all<typename MatrixType::Nested>::type& Eigen::Diagonal< MatrixType, _DiagIndex >::nestedExpression ( ) const
inline

Definition at line 149 of file Diagonal.h.

◆ outerStride()

template<typename MatrixType , int _DiagIndex>
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::Diagonal< MatrixType, _DiagIndex >::outerStride ( ) const
inline

Definition at line 96 of file Diagonal.h.

◆ packet() [1/2]

template<typename MatrixType , int _DiagIndex>
template<int LoadMode>
MatrixType::PacketReturnType Eigen::Diagonal< MatrixType, _DiagIndex >::packet ( Index  ) const
private

◆ packet() [2/2]

template<typename MatrixType , int _DiagIndex>
template<int LoadMode>
MatrixType::PacketReturnType Eigen::Diagonal< MatrixType, _DiagIndex >::packet ( Index  ,
Index   
) const
private

◆ rowOffset()

template<typename MatrixType , int _DiagIndex>
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE EIGEN_CONSTEXPR Index Eigen::Diagonal< MatrixType, _DiagIndex >::rowOffset ( ) const
inlineprivate

Definition at line 169 of file Diagonal.h.

◆ rows()

template<typename MatrixType , int _DiagIndex>
EIGEN_DEVICE_FUNC Index Eigen::Diagonal< MatrixType, _DiagIndex >::rows ( ) const
inline

Definition at line 81 of file Diagonal.h.

Member Data Documentation

◆ m_index

template<typename MatrixType , int _DiagIndex>
const internal::variable_if_dynamicindex<Index, DiagIndex> Eigen::Diagonal< MatrixType, _DiagIndex >::m_index
protected

Definition at line 162 of file Diagonal.h.

◆ m_matrix

template<typename MatrixType , int _DiagIndex>
internal::ref_selector<MatrixType>::non_const_type Eigen::Diagonal< MatrixType, _DiagIndex >::m_matrix
protected

Definition at line 161 of file Diagonal.h.


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


gtsam
Author(s):
autogenerated on Fri Nov 1 2024 03:44:41