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 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 represent a selfadjoint matrix in which case either Supers of Subs have to be null.

See also:

class TridiagonalMatrix

Definition at line 66 of file BandMatrix.h.

#include <src/Core/BandMatrix.h>

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

List of all members.

Classes
struct	DiagonalIntReturnType
Public Types
enum	{   Flags = internal::traits<BandMatrix>::Flags, CoeffReadCost = internal::traits<BandMatrix>::CoeffReadCost, RowsAtCompileTime = internal::traits<BandMatrix>::RowsAtCompileTime, ColsAtCompileTime = internal::traits<BandMatrix>::ColsAtCompileTime,   MaxRowsAtCompileTime = internal::traits<BandMatrix>::MaxRowsAtCompileTime, MaxColsAtCompileTime = internal::traits<BandMatrix>::MaxColsAtCompileTime }
typedef internal::traits < BandMatrix >::Scalar	Scalar
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	DenseMatrixType
typedef DenseMatrixType::Index	Index
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
Block< DataType, Dynamic, 1 >	col (Index i)
Block< DataType, 1, SizeAtCompileTime >	diagonal ()
const Block< const DataType, 1, SizeAtCompileTime >	diagonal () const
template<int N>
DiagonalIntReturnType< N >::Type	diagonal ()
template<int N>
const DiagonalIntReturnType< N > ::Type	diagonal () const
Block< DataType, 1, Dynamic >	diagonal (Index i)
const Block< const DataType, 1, Dynamic >	diagonal (Index i) const
template<typename Dest >
void	evalTo (Dest &dst) const
DenseMatrixType	toDenseMatrix () const
Protected Types
enum	{ DataRowsAtCompileTime, SizeAtCompileTime = EIGEN_SIZE_MIN_PREFER_DYNAMIC(Rows,Cols) }
typedef Matrix< Scalar, DataRowsAtCompileTime, ColsAtCompileTime, Options &RowMajor?RowMajor:ColMajor >	DataType
Protected Member Functions
Index	diagonalLength (Index i) const
Protected Attributes
DataType	m_data
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

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

typedef Matrix<Scalar,DataRowsAtCompileTime,ColsAtCompileTime,Options&RowMajor?RowMajor:ColMajor> internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::DataType [protected]

Definition at line 89 of file BandMatrix.h.

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

typedef Matrix<Scalar,RowsAtCompileTime,ColsAtCompileTime> internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::DenseMatrixType

Definition at line 79 of file BandMatrix.h.

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

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

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

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

Definition at line 80 of file BandMatrix.h.

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

Definition at line 78 of file BandMatrix.h.

---

Member Enumeration Documentation

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

anonymous enum

Enumerator:

Flags
CoeffReadCost
RowsAtCompileTime
ColsAtCompileTime
MaxRowsAtCompileTime
MaxColsAtCompileTime

Definition at line 70 of file BandMatrix.h.

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

anonymous enum [protected]

Enumerator:

DataRowsAtCompileTime
SizeAtCompileTime

Definition at line 83 of file BandMatrix.h.

---

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]

Definition at line 93 of file BandMatrix.h.

---

Member Function Documentation

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

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

(

Index

i )

[inline]

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 115 of file BandMatrix.h.

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 > >.

Definition at line 104 of file BandMatrix.h.

Referenced by internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::diagonal(), internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::diagonalLength(), internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::evalTo(), and internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::toDenseMatrix().

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

template<int N>

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

(

)

[inline]

Returns:

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

Definition at line 156 of file BandMatrix.h.

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

template<int N>

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

(

)

const [inline]

Returns:

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

Definition at line 162 of file BandMatrix.h.

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

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

(

Index

i )

[inline]

Returns:

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

Definition at line 168 of file BandMatrix.h.

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

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

(

Index

i )

const [inline]

Returns:

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

Definition at line 175 of file BandMatrix.h.

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

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

(

)

[inline]

Returns:

a vector expression of the main diagonal

Definition at line 131 of file BandMatrix.h.

Referenced by internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::evalTo(), and internal::TridiagonalMatrix< Scalar, Size, Options >::sub().

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

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

(

)

const [inline]

Returns:

a vector expression of the main diagonal (const version)

Definition at line 135 of file BandMatrix.h.

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

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

(

Index

i )

const [inline, protected]

Definition at line 201 of file BandMatrix.h.

Referenced by internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::diagonal().

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

template<typename Dest >

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

(

Dest &

dst )

const [inline]

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

Definition at line 181 of file BandMatrix.h.

Referenced by internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::toDenseMatrix().

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 > >.

Definition at line 101 of file BandMatrix.h.

Referenced by internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::col(), internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::diagonal(), internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::diagonalLength(), internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::evalTo(), and internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::toDenseMatrix().

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

Definition at line 110 of file BandMatrix.h.

Referenced by internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::col(), internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::diagonal(), and internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::evalTo().

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

Definition at line 107 of file BandMatrix.h.

Referenced by internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::col(), internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::diagonal(), and internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::evalTo().

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

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

(

)

const [inline]

Definition at line 192 of file BandMatrix.h.

---

Member Data Documentation

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

DataType internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_data [protected]

Definition at line 204 of file BandMatrix.h.

Referenced by internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::col(), internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::cols(), and internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::diagonal().

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]

Definition at line 205 of file BandMatrix.h.

Referenced by internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::rows().

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]

Definition at line 207 of file BandMatrix.h.

Referenced by internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::subs().

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]

Definition at line 206 of file BandMatrix.h.

Referenced by internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >::supers().