Public Types | Public Member Functions | Protected Attributes

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

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

#include <BandMatrix.h>

Inheritance diagram for internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >:
internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > > EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >

List of all members.

Public Types

typedef internal::traits
< BandMatrix >::Scalar 
Scalar
typedef internal::traits
< BandMatrix >::Index 
Index
typedef internal::traits
< BandMatrix >
::CoefficientsType 
CoefficientsType

Public Member Functions

 BandMatrix (Index rows=Rows, Index cols=Cols, Index supers=Supers, Index subs=Subs)
Index rows () const
Index cols () const
Index supers () const
Index subs () const
const CoefficientsTypecoeffs () const
CoefficientsTypecoeffs ()

Protected Attributes

CoefficientsType m_coeffs
internal::variable_if_dynamic
< Index, Rows > 
m_rows
internal::variable_if_dynamic
< Index, Supers > 
m_supers
internal::variable_if_dynamic
< Index, Subs > 
m_subs

Detailed Description

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
class 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 Typedef Documentation

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
typedef internal::traits<BandMatrix>::CoefficientsType internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::CoefficientsType
template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
typedef internal::traits<BandMatrix>::Index internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::Index
template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
typedef internal::traits<BandMatrix>::Scalar internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::Scalar

Constructor & Destructor Documentation

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::BandMatrix ( Index  rows = Rows,
Index  cols = Cols,
Index  supers = Supers,
Index  subs = Subs 
) [inline]

Member Function Documentation

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
const CoefficientsType& internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::coeffs (  )  const [inline]
Returns:
an expression of the underlying coefficient matrix

Reimplemented from internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >.

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
CoefficientsType& internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::coeffs (  )  [inline]
Returns:
an expression of the underlying coefficient matrix

Reimplemented from internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >.

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
Index internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::cols (  )  const [inline]
Returns:
the number of rows

Reimplemented from EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >.

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
Index internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::rows (  )  const [inline]
Returns:
the number of columns

Reimplemented from EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >.

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
Index internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::subs (  )  const [inline]
Returns:
the number of sub diagonals

Reimplemented from internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >.

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
Index internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::supers (  )  const [inline]
Returns:
the number of super diagonals

Reimplemented from internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >.


Member Data Documentation

template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
CoefficientsType internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_coeffs [protected]
template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
internal::variable_if_dynamic<Index, Rows> internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_rows [protected]
template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
internal::variable_if_dynamic<Index, Subs> internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_subs [protected]
template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
internal::variable_if_dynamic<Index, Supers> internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_supers [protected]

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