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 | Diagonal (MatrixType &matrix, Index a_index=DiagIndex) |
| EIGEN_DEVICE_FUNC Index | rows () const |
| EIGEN_DEVICE_FUNC Index | cols () const |
| EIGEN_DEVICE_FUNC Index | innerStride () const |
| EIGEN_DEVICE_FUNC Index | outerStride () const |
| EIGEN_DEVICE_FUNC ScalarWithConstIfNotLvalue * | data () |
| EIGEN_DEVICE_FUNC const Scalar * | data () const |
| EIGEN_DEVICE_FUNC Scalar & | coeffRef (Index row, Index) |
| EIGEN_DEVICE_FUNC const Scalar & | coeffRef (Index row, Index) const |
| EIGEN_DEVICE_FUNC CoeffReturnType | coeff (Index row, Index) const |
| EIGEN_DEVICE_FUNC Scalar & | coeffRef (Index idx) |
| EIGEN_DEVICE_FUNC const Scalar & | coeffRef (Index idx) const |
| EIGEN_DEVICE_FUNC CoeffReturnType | coeff (Index idx) const |
| EIGEN_DEVICE_FUNC const internal::remove_all< typename MatrixType::Nested >::type & | nestedExpression () const |
| EIGEN_DEVICE_FUNC Index | index () const |
Protected Attributes | |
| internal::ref_selector< MatrixType >::non_const_type | m_matrix |
| const internal::variable_if_dynamicindex< Index, DiagIndex > | m_index |
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.
The documentation for this class was generated from the following file:
- third-party-libs/eigen3/Eigen/src/Core/Diagonal.h
