Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > Class Template Reference

#include <Eigen/src/Core/BandMatrix.h>

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.

Template 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

Public Member Functions
Index	cols () const
Index	rows () const
Index	subs () const
Index	supers () const

Member Function Documentation

cols()

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>

Index Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::cols ( ) const

inline

Returns

the number of rows

rows()

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>

Index Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::rows ( ) const

inline

Returns

the number of columns

subs()

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>

Index Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::subs ( ) const

inline

Returns

the number of sub diagonals

supers()

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>

Index Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::supers ( ) const

inline

Returns

the number of super diagonals

---

The documentation for this class was generated from the following file:

• /builds/libeigen/eigen/Eigen/src/Core/BandMatrix.h