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

Public Types
typedef internal::traits< BandMatrix >::Scalar	Scalar
typedef internal::traits< BandMatrix >::Index	Index
typedef internal::traits< BandMatrix >::CoefficientsType	CoefficientsType
Public Types inherited from Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >
enum
typedef internal::traits< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::Scalar	Scalar
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	DenseMatrixType
typedef DenseMatrixType::Index	Index
typedef internal::traits< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::CoefficientsType	CoefficientsType
typedef EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >	Base
Public Types inherited from Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >
typedef internal::traits< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::StorageKind	StorageKind
typedef internal::traits< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::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
const CoefficientsType &	coeffs () const
CoefficientsType &	coeffs ()
Public Member Functions inherited from Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >
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
Public Member Functions inherited from Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >
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	rows () const
Index	cols () const
Index	size () const
void	evalTo (Dest &dst) const
void	addTo (Dest &dst) const
void	subTo (Dest &dst) const
void	applyThisOnTheRight (Dest &dst) const
void	applyThisOnTheLeft (Dest &dst) 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

Additional Inherited Members
Protected Types inherited from Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >
enum
Protected Member Functions inherited from Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >
Index	diagonalLength (Index i) const

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

Member Function Documentation

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

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

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

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

Definition at line 220 of file BandMatrix.h.

{ return m_supers.value(); }

---

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

• C:/Users/Brig/Documents/ShapeWorksStudio/src/Surfworks/Eigen/src/Core/BandMatrix.h