BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > Class Template Reference
[Core module]
Represents a rectangular matrix with a banded storage.
More...
Inherits BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >.
List of all members.
Public Member Functions |
Index | cols () const |
Index | rows () const |
Index | subs () const |
Index | supers () 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
Member Function Documentation
Index cols |
( |
void |
|
) |
const [inline] |
Index rows |
( |
void |
|
) |
const [inline] |
Index subs |
( |
|
) |
const [inline] |
- Returns:
- the number of sub diagonals
Index supers |
( |
|
) |
const [inline] |
- Returns:
- the number of super diagonals
The documentation for this class was generated from the following file: