Eigne Matrix Class Library
Dependents: Eigen_test Odometry_test AttitudeEstimation_usingTicker MPU9250_Quaternion_Binary_Serial ... more
BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > Class Template Reference
[Core module]
Represents a rectangular matrix with a banded storage. More...
#include <BandMatrix.h>
Inherits Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >.
Public Member Functions | |
Index | rows () const |
Index | cols () const |
Index | supers () const |
Index | subs () const |
Block< CoefficientsType, Dynamic, 1 > | col (Index i) |
Block< CoefficientsType, 1, SizeAtCompileTime > | diagonal () |
const Block< const CoefficientsType, 1, SizeAtCompileTime > | diagonal () const |
template<int N> | |
DiagonalIntReturnType< N >::Type | diagonal () |
template<int N> | |
const DiagonalIntReturnType< N > ::Type | diagonal () const |
Block< CoefficientsType, 1, Dynamic > | diagonal (Index i) |
const Block< const CoefficientsType, 1, Dynamic > | diagonal (Index i) const |
Derived & | derived () |
const Derived & | derived () const |
Index | size () const |
Detailed Description
template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
class Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >
Represents a rectangular matrix with a banded storage.
- Parameters:
-
_Scalar Numeric type, i.e. float, double, int Rows Number of rows, or Dynamic Cols Number of columns, or Dynamic Supers Number of super diagonal Subs Number of sub diagonal _Options A combination of either RowMajor or ColMajor, and of SelfAdjoint The former controls storage order, and defaults to column-major. The latter controls whether the matrix represents a selfadjoint matrix in which case either Supers of Subs have to be null.
- See also:
- class TridiagonalMatrix
Definition at line 199 of file BandMatrix.h.
Member Function Documentation
- Returns:
- a vector expression of the i -th column, only the meaningful part is returned.
- Warning:
- the internal storage must be column major.
Definition at line 68 of file BandMatrix.h.
Index cols | ( | ) | const |
- Returns:
- the number of rows
Reimplemented from EigenBase< Derived >.
Definition at line 217 of file BandMatrix.h.
Derived& derived | ( | ) | [inherited] |
- Returns:
- a reference to the derived object
Definition at line 34 of file EigenBase.h.
const Derived& derived | ( | ) | const [inherited] |
- Returns:
- a const reference to the derived object
Definition at line 36 of file EigenBase.h.
Block<CoefficientsType,1,SizeAtCompileTime> diagonal | ( | ) | [inherited] |
- Returns:
- a vector expression of the main diagonal
Definition at line 84 of file BandMatrix.h.
const Block<const CoefficientsType,1,SizeAtCompileTime> diagonal | ( | ) | const [inherited] |
- Returns:
- a vector expression of the main diagonal (const version)
Definition at line 88 of file BandMatrix.h.
DiagonalIntReturnType<N>::Type diagonal | ( | ) | [inherited] |
- Returns:
- a vector expression of the N -th sub or super diagonal
Definition at line 109 of file BandMatrix.h.
const DiagonalIntReturnType<N>::Type diagonal | ( | ) | const [inherited] |
- Returns:
- a vector expression of the N -th sub or super diagonal
Definition at line 115 of file BandMatrix.h.
- Returns:
- a vector expression of the i -th sub or super diagonal
Definition at line 121 of file BandMatrix.h.
- Returns:
- a vector expression of the i -th sub or super diagonal
Definition at line 128 of file BandMatrix.h.
Index rows | ( | ) | const |
- Returns:
- the number of columns
Reimplemented from EigenBase< Derived >.
Definition at line 214 of file BandMatrix.h.
Index size | ( | ) | const [inherited] |
- Returns:
- the number of coefficients, which is rows()*cols().
Reimplemented in PermutationBase< Derived >, PermutationBase< PermutationWrapper< _IndicesType > >, PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, and PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >.
Definition at line 49 of file EigenBase.h.
Index subs | ( | ) | const |
- Returns:
- the number of sub diagonals
Definition at line 223 of file BandMatrix.h.
Index supers | ( | ) | const |
- Returns:
- the number of super diagonals
Definition at line 220 of file BandMatrix.h.
Generated on Tue Jul 12 2022 17:47:06 by
![doxygen](doxygen.png)