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
constexpr Index	cols () const
constexpr Index	rows () const
constexpr Index	subs () const
constexpr 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

inlineconstexpr

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

inlineconstexpr

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

inlineconstexpr

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

inlineconstexpr

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