Public Member Functions | List of all members
BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > Class Template Reference

Represents a rectangular matrix with a banded storage. More...

Inherits BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >.

Public Member Functions

Index cols () const
 
Index rows () const
 
Index subs () const
 
Index supers () const
 

Detailed Description

template<typename _Scalar, int Rows = Dynamic, int Cols = Dynamic, int Supers = Dynamic, int Subs = Dynamic, int Options = 0>
class Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >

Represents a rectangular matrix with a banded storage.

Parameters
_ScalarNumeric type, i.e. float, double, int
RowsNumber of rows, or Dynamic
ColsNumber of columns, or Dynamic
SupersNumber of super diagonal
SubsNumber of sub diagonal
_OptionsA 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
Returns
the number of rows
Index rows ( void  ) const
inline
Returns
the number of columns
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 files: