Expression of a diagonal/subdiagonal/superdiagonal in a matrix. More...
#include <Diagonal.h>
Public Types | |
| typedef internal::dense_xpr_base < Diagonal >::type | Base |
| typedef internal::conditional < internal::is_lvalue < MatrixType >::value, Scalar, const Scalar >::type | ScalarWithConstIfNotLvalue |
Public Member Functions | |
| CoeffReturnType | coeff (Index row, Index) const |
| CoeffReturnType | coeff (Index index) const |
| Scalar & | coeffRef (Index row, Index) |
| const Scalar & | coeffRef (Index row, Index) const |
| Scalar & | coeffRef (Index index) |
| const Scalar & | coeffRef (Index index) const |
| Index | cols () const |
| ScalarWithConstIfNotLvalue * | data () |
| const Scalar * | data () const |
| Diagonal (MatrixType &matrix, Index index=DiagIndex) | |
| int | index () const |
| Index | innerStride () const |
| const internal::remove_all < typename MatrixType::Nested > ::type & | nestedExpression () const |
| Index | outerStride () const |
| Index | rows () const |
Protected Attributes | |
| const internal::variable_if_dynamic < Index, DiagIndex > | m_index |
| 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 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 64 of file Diagonal.h.
Member Typedef Documentation
| typedef internal::dense_xpr_base<Diagonal>::type Eigen::Diagonal< MatrixType, DiagIndex >::Base |
Definition at line 69 of file Diagonal.h.
| typedef internal::conditional< internal::is_lvalue<MatrixType>::value, Scalar, const Scalar >::type Eigen::Diagonal< MatrixType, DiagIndex >::ScalarWithConstIfNotLvalue |
Definition at line 95 of file Diagonal.h.
Constructor & Destructor Documentation
| Eigen::Diagonal< MatrixType, DiagIndex >::Diagonal | ( | MatrixType & | matrix, |
| Index | index = DiagIndex |
||
| ) | [inline] |
Definition at line 72 of file Diagonal.h.
Member Function Documentation
| EIGEN_STRONG_INLINE Index Eigen::Diagonal< MatrixType, DiagIndex >::absDiagIndex | ( | ) | const [inline, private] |
Definition at line 149 of file Diagonal.h.
| CoeffReturnType Eigen::Diagonal< MatrixType, DiagIndex >::coeff | ( | Index | row, |
| Index | |||
| ) | const [inline] |
Definition at line 111 of file Diagonal.h.
| CoeffReturnType Eigen::Diagonal< MatrixType, DiagIndex >::coeff | ( | Index | index | ) | const [inline] |
Definition at line 127 of file Diagonal.h.
| Scalar& Eigen::Diagonal< MatrixType, DiagIndex >::coeffRef | ( | Index | row, |
| Index | |||
| ) | [inline] |
Definition at line 100 of file Diagonal.h.
| const Scalar& Eigen::Diagonal< MatrixType, DiagIndex >::coeffRef | ( | Index | row, |
| Index | |||
| ) | const [inline] |
Definition at line 106 of file Diagonal.h.
| Scalar& Eigen::Diagonal< MatrixType, DiagIndex >::coeffRef | ( | Index | index | ) | [inline] |
Definition at line 116 of file Diagonal.h.
| const Scalar& Eigen::Diagonal< MatrixType, DiagIndex >::coeffRef | ( | Index | index | ) | const [inline] |
Definition at line 122 of file Diagonal.h.
| EIGEN_STRONG_INLINE Index Eigen::Diagonal< MatrixType, DiagIndex >::colOffset | ( | ) | const [inline, private] |
Definition at line 151 of file Diagonal.h.
| Index Eigen::Diagonal< MatrixType, DiagIndex >::cols | ( | void | ) | const [inline] |
Definition at line 79 of file Diagonal.h.
| ScalarWithConstIfNotLvalue* Eigen::Diagonal< MatrixType, DiagIndex >::data | ( | ) | [inline] |
Definition at line 97 of file Diagonal.h.
| const Scalar* Eigen::Diagonal< MatrixType, DiagIndex >::data | ( | ) | const [inline] |
Definition at line 98 of file Diagonal.h.
| int Eigen::Diagonal< MatrixType, DiagIndex >::index | ( | ) | const [inline] |
Definition at line 138 of file Diagonal.h.
| Index Eigen::Diagonal< MatrixType, DiagIndex >::innerStride | ( | ) | const [inline] |
Definition at line 81 of file Diagonal.h.
| const internal::remove_all<typename MatrixType::Nested>::type& Eigen::Diagonal< MatrixType, DiagIndex >::nestedExpression | ( | ) | const [inline] |
Definition at line 133 of file Diagonal.h.
| Index Eigen::Diagonal< MatrixType, DiagIndex >::outerStride | ( | ) | const [inline] |
Definition at line 86 of file Diagonal.h.
| MatrixType::PacketReturnType Eigen::Diagonal< MatrixType, DiagIndex >::packet | ( | Index | ) | const [private] |
| MatrixType::PacketReturnType Eigen::Diagonal< MatrixType, DiagIndex >::packet | ( | Index | , |
| Index | |||
| ) | const [private] |
| EIGEN_STRONG_INLINE Index Eigen::Diagonal< MatrixType, DiagIndex >::rowOffset | ( | ) | const [inline, private] |
Definition at line 150 of file Diagonal.h.
| Index Eigen::Diagonal< MatrixType, DiagIndex >::rows | ( | void | ) | const [inline] |
Definition at line 76 of file Diagonal.h.
Member Data Documentation
const internal::variable_if_dynamic<Index, DiagIndex> Eigen::Diagonal< MatrixType, DiagIndex >::m_index [protected] |
Definition at line 145 of file Diagonal.h.
MatrixType::Nested Eigen::Diagonal< MatrixType, DiagIndex >::m_matrix [protected] |
Definition at line 144 of file Diagonal.h.
The documentation for this class was generated from the following file: