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

---

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.

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 214 of file Core.

Inheritance 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 >::Index	Index
typedef internal::traits < BandMatrix > ::CoefficientsType	CoefficientsType
enum
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	DenseMatrixType
typedef EigenBase< BandMatrix < _Scalar, Rows, Cols, Supers, Subs, Options > >	Base
typedef internal::traits < BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::StorageKind	StorageKind
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 ()
Block< CoefficientsType, Dynamic, 1 >	col (Index i)
Block< CoefficientsType, 1, SizeAtCompileTime >	diagonal ()
const Block< const CoefficientsType, 1, SizeAtCompileTime >	diagonal () const
DiagonalIntReturnType< N >::Type	diagonal ()
const DiagonalIntReturnType< N > ::Type	diagonal () const
Block< CoefficientsType, 1, Dynamic >	diagonal (Index i)
const Block< const CoefficientsType, 1, Dynamic >	diagonal (Index i) const
void	evalTo (Dest &dst) const
DenseMatrixType	toDenseMatrix () const
BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > &	derived ()
const BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > &	derived () const
BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > &	const_cast_derived () const
const BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > &	const_derived () const
Index	size () const
void	addTo (Dest &dst) const
void	subTo (Dest &dst) const
void	applyThisOnTheRight (Dest &dst) const
void	applyThisOnTheLeft (Dest &dst) const
Protected Types
enum
Protected Member Functions
Index	diagonalLength (Index i) const
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

---

Member Typedef Documentation

typedef EigenBase<BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > > Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::Base [inherited]

Definition at line 52 of file Core.

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 220 of file Core.

typedef Matrix<Scalar,RowsAtCompileTime,ColsAtCompileTime> Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::DenseMatrixType [inherited]

Definition at line 49 of file Core.

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

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

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

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

Definition at line 219 of file Core.

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 218 of file Core.

typedef internal::traits<BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::StorageKind Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::StorageKind [inherited]

Definition at line 45 of file Core.

---

Member Enumeration Documentation

anonymous enum [inherited]

Definition at line 37 of file Core.

anonymous enum [protected, inherited]

Definition at line 55 of file Core.

---

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]

Definition at line 222 of file Core.

---

Member Function Documentation

void Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::addTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 71 of file Core.

void Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::applyThisOnTheLeft

(

Dest &

dst

)

const [inline, inherited]

Definition at line 99 of file Core.

void Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::applyThisOnTheRight

(

Dest &

dst

)

const [inline, inherited]

Definition at line 91 of file Core.

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 240 of file Core.

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 241 of file Core.

Block<CoefficientsType,Dynamic,1> Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::col

(

Index

i

)

[inline, inherited]

Returns:

a vector expression of the i -th column, only the meaningful part is returned.

Warning:

the internal storage must be column major.

Definition at line 83 of file Core.

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

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

(

void

)

const [inline]

Returns:

the number of rows

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

Definition at line 232 of file Core.

BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > & Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::const_cast_derived

(

)

const [inline, inherited]

Definition at line 53 of file Core.

const BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > & Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::const_derived

(

)

const [inline, inherited]

Definition at line 55 of file Core.

BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > & Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::derived

(

)

[inline, inherited]

Returns:

a reference to the derived object

Definition at line 49 of file Core.

const BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > & Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::derived

(

)

const [inline, inherited]

Returns:

a const reference to the derived object

Definition at line 51 of file Core.

Block<CoefficientsType,1,SizeAtCompileTime> Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::diagonal

(

)

[inline, inherited]

Returns:

a vector expression of the main diagonal

Definition at line 99 of file Core.

const Block<const CoefficientsType,1,SizeAtCompileTime> Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::diagonal

(

)

const [inline, inherited]

Returns:

a vector expression of the main diagonal (const version)

Definition at line 103 of file Core.

DiagonalIntReturnType<N>::Type Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::diagonal

(

)

[inline, inherited]

Returns:

a vector expression of the N -th sub or super diagonal

Definition at line 124 of file Core.

const DiagonalIntReturnType<N>::Type Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::diagonal

(

)

const [inline, inherited]

Returns:

a vector expression of the N -th sub or super diagonal

Definition at line 130 of file Core.

Block<CoefficientsType,1,Dynamic> Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::diagonal

(

Index

i

)

[inline, inherited]

Returns:

a vector expression of the i -th sub or super diagonal

Definition at line 136 of file Core.

const Block<const CoefficientsType,1,Dynamic> Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::diagonal

(

Index

i

)

const [inline, inherited]

Returns:

a vector expression of the i -th sub or super diagonal

Definition at line 143 of file Core.

Index Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::diagonalLength

(

Index

i

)

const [inline, protected, inherited]

Definition at line 169 of file Core.

void Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::evalTo

(

Dest &

dst

)

const [inline, inherited]

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

Definition at line 149 of file Core.

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

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

(

void

)

const [inline]

Returns:

the number of columns

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

Definition at line 229 of file Core.

Index Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::size

(

)

const [inline, inherited]

Returns:

the number of coefficients, which is rows()*cols().

See also:

rows(), cols(), SizeAtCompileTime.

Definition at line 64 of file Core.

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 238 of file Core.

void Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::subTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 81 of file Core.

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 235 of file Core.

DenseMatrixType Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::toDenseMatrix

(

)

const [inline, inherited]

Definition at line 160 of file Core.

---

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 245 of file Core.

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 246 of file Core.

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 248 of file Core.

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 247 of file Core.