Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > Class Template Reference

---

Detailed Description

template<typename _CoefficientsType, int _Rows, int _Cols, int _Supers, int _Subs, int _Options>
class Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >

Definition at line 276 of file Core.

Inheritance diagram for Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >:

List of all members.

Public Types
typedef internal::traits < BandMatrixWrapper >::Scalar	Scalar
typedef internal::traits < BandMatrixWrapper > ::CoefficientsType	CoefficientsType
typedef internal::traits < BandMatrixWrapper >::Index	Index
enum
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	DenseMatrixType
typedef EigenBase < BandMatrixWrapper < _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >	Base
typedef internal::traits < BandMatrixWrapper < _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::StorageKind	StorageKind
Public Member Functions
	BandMatrixWrapper (const CoefficientsType &coeffs, 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
BandMatrixWrapper < _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > &	derived ()
const BandMatrixWrapper < _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > &	derived () const
BandMatrixWrapper < _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > &	const_cast_derived () const
const BandMatrixWrapper < _CoefficientsType, _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
const 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<BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > > Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::Base [inherited]

Definition at line 52 of file Core.

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>

typedef internal::traits<BandMatrixWrapper>::CoefficientsType Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::CoefficientsType

Reimplemented from Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >.

Definition at line 281 of file Core.

typedef Matrix<Scalar,RowsAtCompileTime,ColsAtCompileTime> Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::DenseMatrixType [inherited]

Definition at line 49 of file Core.

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>

typedef internal::traits<BandMatrixWrapper>::Index Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::Index

Reimplemented from Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >.

Definition at line 282 of file Core.

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>

typedef internal::traits<BandMatrixWrapper>::Scalar Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::Scalar

Reimplemented from Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >.

Definition at line 280 of file Core.

typedef internal::traits<BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::StorageKind Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _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 _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>

Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::BandMatrixWrapper	(	const CoefficientsType &	coeffs,
		Index	rows = _Rows,
		Index	cols = _Cols,
		Index	supers = _Supers,
		Index	subs = _Subs
	)		[inline]

Definition at line 284 of file Core.

---

Member Function Documentation

void Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::addTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 71 of file Core.

void Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::applyThisOnTheLeft

(

Dest &

dst

)

const [inline, inherited]

Definition at line 99 of file Core.

void Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::applyThisOnTheRight

(

Dest &

dst

)

const [inline, inherited]

Definition at line 91 of file Core.

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>

const CoefficientsType& Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::coeffs

(

)

const [inline]

Returns:

an expression of the underlying coefficient matrix

Reimplemented from Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >.

Definition at line 304 of file Core.

CoefficientsType& Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::coeffs

(

)

[inline, inherited]

Returns:

an expression of the underlying coefficient matrix

Definition at line 78 of file Core.

Block<CoefficientsType,Dynamic,1> Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _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 _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>

Index Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::cols

(

void

)

const [inline]

Returns:

the number of rows

Reimplemented from Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >.

Definition at line 296 of file Core.

BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > & Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::const_cast_derived

(

)

const [inline, inherited]

Definition at line 53 of file Core.

const BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > & Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::const_derived

(

)

const [inline, inherited]

Definition at line 55 of file Core.

BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > & Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::derived

(

)

[inline, inherited]

Returns:

a reference to the derived object

Definition at line 49 of file Core.

const BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > & Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _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< BandMatrixWrapper< _CoefficientsType, _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< BandMatrixWrapper< _CoefficientsType, _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< BandMatrixWrapper< _CoefficientsType, _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< BandMatrixWrapper< _CoefficientsType, _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< BandMatrixWrapper< _CoefficientsType, _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< BandMatrixWrapper< _CoefficientsType, _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< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::diagonalLength

(

Index

i

)

const [inline, protected, inherited]

Definition at line 169 of file Core.

void Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::evalTo

(

Dest &

dst

)

const [inline, inherited]

Reimplemented from Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >.

Definition at line 149 of file Core.

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>

Index Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::rows

(

void

)

const [inline]

Returns:

the number of columns

Reimplemented from Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >.

Definition at line 293 of file Core.

Index Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _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 _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>

Index Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::subs

(

)

const [inline]

Returns:

the number of sub diagonals

Reimplemented from Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >.

Definition at line 302 of file Core.

void Eigen::EigenBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::subTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 81 of file Core.

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>

Index Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::supers

(

)

const [inline]

Returns:

the number of super diagonals

Reimplemented from Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >.

Definition at line 299 of file Core.

DenseMatrixType Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >::toDenseMatrix

(

)

const [inline, inherited]

Definition at line 160 of file Core.

---

Member Data Documentation

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>

const CoefficientsType& Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::m_coeffs [protected]

Definition at line 308 of file Core.

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>

internal::variable_if_dynamic<Index, _Rows> Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::m_rows [protected]

Definition at line 309 of file Core.

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>

internal::variable_if_dynamic<Index, _Subs> Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::m_subs [protected]

Definition at line 311 of file Core.

template<typename _CoefficientsType , int _Rows, int _Cols, int _Supers, int _Subs, int _Options>

internal::variable_if_dynamic<Index, _Supers> Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >::m_supers [protected]

Definition at line 310 of file Core.