Eigen::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 Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >:

Collaboration diagram for Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >:

List of all members.

Public Types
typedef internal::traits < BandMatrix >::Scalar	Scalar
typedef internal::traits < BandMatrix >::StorageIndex	StorageIndex
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 CoefficientsType &	coeffs () const
CoefficientsType &	coeffs ()
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 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

Definition at line 199 of file BandMatrix.h.

---

Member Typedef Documentation

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

typedef internal::traits<BandMatrix>::CoefficientsType Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::CoefficientsType

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

Definition at line 205 of file BandMatrix.h.

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

typedef internal::traits<BandMatrix>::Scalar Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::Scalar

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

Definition at line 203 of file BandMatrix.h.

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

typedef internal::traits<BandMatrix>::StorageIndex Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::StorageIndex

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

Reimplemented in Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >.

Definition at line 204 of file BandMatrix.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 207 of file BandMatrix.h.

      : m_coeffs(1+supers+subs,cols),
        m_rows(rows), m_supers(supers), m_subs(subs)
    {
    }

---

Member Function Documentation

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

const CoefficientsType& Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::coeffs

(

)

const [inline]

Returns:

an expression of the underlying coefficient matrix

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

Definition at line 225 of file BandMatrix.h.

{ return m_coeffs; }

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

CoefficientsType& Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::coeffs

(

)

[inline]

Returns:

an expression of the underlying coefficient matrix

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

Definition at line 226 of file BandMatrix.h.

{ return m_coeffs; }

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

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

Definition at line 217 of file BandMatrix.h.

{ return m_coeffs.cols(); }

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

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

Definition at line 214 of file BandMatrix.h.

{ return m_rows.value(); }

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

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

Definition at line 223 of file BandMatrix.h.

{ return m_subs.value(); }

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

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

Definition at line 220 of file BandMatrix.h.

{ return m_supers.value(); }

---

Member Data Documentation

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

CoefficientsType Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_coeffs [protected]

Definition at line 230 of file BandMatrix.h.

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

internal::variable_if_dynamic<Index, Rows> Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_rows [protected]

Definition at line 231 of file BandMatrix.h.

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

internal::variable_if_dynamic<Index, Subs> Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_subs [protected]

Definition at line 233 of file BandMatrix.h.

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

internal::variable_if_dynamic<Index, Supers> Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_supers [protected]

Definition at line 232 of file BandMatrix.h.

---

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

• BandMatrix.h