Expression of a diagonal/subdiagonal/superdiagonal in a matrix. More...
#include <Diagonal.h>
Inheritance diagram for Eigen::Diagonal< MatrixType, _DiagIndex >:
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 row, Index) const |
| EIGEN_DEVICE_FUNC CoeffReturnType | coeff (Index idx) const |
| EIGEN_DEVICE_FUNC Scalar & | coeffRef (Index row, Index) |
| EIGEN_DEVICE_FUNC const Scalar & | coeffRef (Index row, Index) const |
| EIGEN_DEVICE_FUNC Scalar & | coeffRef (Index idx) |
| EIGEN_DEVICE_FUNC const Scalar & | coeffRef (Index idx) const |
| EIGEN_DEVICE_FUNC Index | cols () const |
| EIGEN_DEVICE_FUNC ScalarWithConstIfNotLvalue * | data () |
| EIGEN_DEVICE_FUNC const Scalar * | data () const |
| EIGEN_DEVICE_FUNC | Diagonal (MatrixType &matrix, Index a_index=DiagIndex) |
| EIGEN_DEVICE_FUNC Index | index () const |
| EIGEN_DEVICE_FUNC Index | innerStride () const |
| EIGEN_DEVICE_FUNC const internal::remove_all< typename MatrixType::Nested >::type & | nestedExpression () const |
| EIGEN_DEVICE_FUNC Index | outerStride () const |
| EIGEN_DEVICE_FUNC Index | rows () const |
Protected Attributes | |
| const internal::variable_if_dynamicindex< Index, DiagIndex > | m_index |
| internal::ref_selector< MatrixType >::non_const_type | m_matrix |
Private Member Functions | |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index | absDiagIndex () const |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index | colOffset () const |
| template<int LoadMode> | |
| MatrixType::PacketReturnType | packet (Index) const |
| template<int LoadMode> | |
| MatrixType::PacketReturnType | packet (Index, Index) const |
| EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE Index | rowOffset () const |
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.
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 103 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>
|
inlineexplicit |
Definition at line 73 of file Diagonal.h.
Member Function Documentation
◆ absDiagIndex()
template<typename MatrixType, int _DiagIndex>
|
inlineprivate |
Definition at line 168 of file Diagonal.h.
◆ coeff() [1/2]
template<typename MatrixType, int _DiagIndex>
|
inline |
Definition at line 124 of file Diagonal.h.
◆ coeff() [2/2]
template<typename MatrixType, int _DiagIndex>
|
inline |
Definition at line 143 of file Diagonal.h.
◆ coeffRef() [1/4]
template<typename MatrixType, int _DiagIndex>
|
inline |
Definition at line 111 of file Diagonal.h.
◆ coeffRef() [2/4]
template<typename MatrixType, int _DiagIndex>
|
inline |
Definition at line 118 of file Diagonal.h.
◆ coeffRef() [3/4]
template<typename MatrixType, int _DiagIndex>
|
inline |
Definition at line 130 of file Diagonal.h.
◆ coeffRef() [4/4]
template<typename MatrixType, int _DiagIndex>
|
inline |
Definition at line 137 of file Diagonal.h.
◆ colOffset()
template<typename MatrixType, int _DiagIndex>
|
inlineprivate |
Definition at line 172 of file Diagonal.h.
◆ cols()
template<typename MatrixType, int _DiagIndex>
|
inline |
Definition at line 85 of file Diagonal.h.
◆ data() [1/2]
template<typename MatrixType, int _DiagIndex>
|
inline |
Definition at line 106 of file Diagonal.h.
◆ data() [2/2]
template<typename MatrixType, int _DiagIndex>
|
inline |
Definition at line 108 of file Diagonal.h.
◆ index()
template<typename MatrixType, int _DiagIndex>
|
inline |
Definition at line 156 of file Diagonal.h.
◆ innerStride()
template<typename MatrixType, int _DiagIndex>
|
inline |
Definition at line 88 of file Diagonal.h.
◆ nestedExpression()
template<typename MatrixType, int _DiagIndex>
|
inline |
Definition at line 150 of file Diagonal.h.
◆ outerStride()
template<typename MatrixType, int _DiagIndex>
|
inline |
Definition at line 94 of file Diagonal.h.
◆ packet() [1/2]
template<typename MatrixType, int _DiagIndex>
template<int LoadMode>
|
private |
◆ packet() [2/2]
template<typename MatrixType, int _DiagIndex>
template<int LoadMode>
|
private |
◆ rowOffset()
template<typename MatrixType, int _DiagIndex>
|
inlineprivate |
Definition at line 170 of file Diagonal.h.
◆ rows()
template<typename MatrixType, int _DiagIndex>
|
inline |
Definition at line 78 of file Diagonal.h.
Member Data Documentation
◆ m_index
template<typename MatrixType, int _DiagIndex>
|
protected |
Definition at line 163 of file Diagonal.h.
◆ m_matrix
template<typename MatrixType, int _DiagIndex>
|
protected |
Definition at line 162 of file Diagonal.h.
The documentation for this class was generated from the following file: