Eigen::internal::BandMatrixBase< Derived > Class Template Reference

#include <BandMatrix.h>

Inheritance diagram for Eigen::internal::BandMatrixBase< Derived >:

Classes
struct	DiagonalIntReturnType

Public Types
enum	{   Flags = internal::traits<Derived>::Flags , CoeffReadCost = internal::traits<Derived>::CoeffReadCost , RowsAtCompileTime = internal::traits<Derived>::RowsAtCompileTime , ColsAtCompileTime = internal::traits<Derived>::ColsAtCompileTime ,   MaxRowsAtCompileTime = internal::traits<Derived>::MaxRowsAtCompileTime , MaxColsAtCompileTime = internal::traits<Derived>::MaxColsAtCompileTime , Supers = internal::traits<Derived>::Supers , Subs = internal::traits<Derived>::Subs ,   Options = internal::traits<Derived>::Options }
typedef internal::traits< Derived >::Scalar	Scalar
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	DenseMatrixType
typedef DenseMatrixType::StorageIndex	StorageIndex
typedef internal::traits< Derived >::CoefficientsType	CoefficientsType
typedef EigenBase< Derived >	Base
Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices.
typedef internal::traits< Derived >::StorageKind	StorageKind

Public Member Functions
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
template<int N>
DiagonalIntReturnType< N >::Type	diagonal ()
template<int N>
const DiagonalIntReturnType< N >::Type	diagonal () const
Block< CoefficientsType, 1, Dynamic >	diagonal (Index i)
const Block< const CoefficientsType, 1, Dynamic >	diagonal (Index i) const
template<typename Dest >
void	evalTo (Dest &dst) const
DenseMatrixType	toDenseMatrix () const
EIGEN_DEVICE_FUNC Derived &	derived ()
EIGEN_DEVICE_FUNC const Derived &	derived () const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
Public Member Functions inherited from Eigen::EigenBase< Derived >
EIGEN_DEVICE_FUNC Derived &	derived ()
EIGEN_DEVICE_FUNC const Derived &	derived () const
EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const
EIGEN_DEVICE_FUNC const Derived &	const_derived () const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const

Protected Types
enum	{ DataRowsAtCompileTime , SizeAtCompileTime = EIGEN_SIZE_MIN_PREFER_DYNAMIC(RowsAtCompileTime,ColsAtCompileTime) }

Protected Member Functions
Index	diagonalLength (Index i) const

Member Typedef Documentation

Base

template<typename Derived >

typedef EigenBase<Derived> Eigen::internal::BandMatrixBase< Derived >::Base

CoefficientsType

template<typename Derived >

typedef internal::traits<Derived>::CoefficientsType Eigen::internal::BandMatrixBase< Derived >::CoefficientsType

DenseMatrixType

template<typename Derived >

typedef Matrix<Scalar,RowsAtCompileTime,ColsAtCompileTime> Eigen::internal::BandMatrixBase< Derived >::DenseMatrixType

Scalar

template<typename Derived >

typedef internal::traits<Derived>::Scalar Eigen::internal::BandMatrixBase< Derived >::Scalar

StorageIndex

template<typename Derived >

typedef DenseMatrixType::StorageIndex Eigen::internal::BandMatrixBase< Derived >::StorageIndex

Member Enumeration Documentation

anonymous enum

template<typename Derived >

anonymous enum

Enumerator
Flags
CoeffReadCost
RowsAtCompileTime
ColsAtCompileTime
MaxRowsAtCompileTime
MaxColsAtCompileTime
Supers
Subs
Options

anonymous enum

template<typename Derived >

anonymous enum

protected

Enumerator
DataRowsAtCompileTime
SizeAtCompileTime

Member Function Documentation

coeffs() [1/2]

template<typename Derived >

CoefficientsType & Eigen::internal::BandMatrixBase< Derived >::coeffs ( )

inline

Returns

an expression of the underlying coefficient matrix

coeffs() [2/2]

template<typename Derived >

const CoefficientsType & Eigen::internal::BandMatrixBase< Derived >::coeffs ( ) const

inline

Returns

an expression of the underlying coefficient matrix

col()

template<typename Derived >

Block< CoefficientsType, Dynamic, 1 > Eigen::internal::BandMatrixBase< Derived >::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.

cols()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::cols ( ) const

inline

Returns

the number of columns.

See also

rows(), ColsAtCompileTime

derived() [1/2]

template<typename Derived >

EIGEN_DEVICE_FUNC Derived & Eigen::EigenBase< Derived >::derived ( )

inline

Returns

a reference to the derived object

derived() [2/2]

template<typename Derived >

EIGEN_DEVICE_FUNC const Derived & Eigen::EigenBase< Derived >::derived ( ) const

inline

Returns

a const reference to the derived object

diagonal() [1/6]

template<typename Derived >

Block< CoefficientsType, 1, SizeAtCompileTime > Eigen::internal::BandMatrixBase< Derived >::diagonal ( )

inline

Returns

a vector expression of the main diagonal

diagonal() [2/6]

template<typename Derived >

template<int N>

DiagonalIntReturnType< N >::Type Eigen::internal::BandMatrixBase< Derived >::diagonal ( )

inline

Returns

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

diagonal() [3/6]

template<typename Derived >

const Block< const CoefficientsType, 1, SizeAtCompileTime > Eigen::internal::BandMatrixBase< Derived >::diagonal ( ) const

inline

Returns

a vector expression of the main diagonal (const version)

diagonal() [4/6]

template<typename Derived >

template<int N>

const DiagonalIntReturnType< N >::Type Eigen::internal::BandMatrixBase< Derived >::diagonal ( ) const

inline

Returns

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

diagonal() [5/6]

template<typename Derived >

Block< CoefficientsType, 1, Dynamic > Eigen::internal::BandMatrixBase< Derived >::diagonal ( Index  i )

inline

Returns

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

diagonal() [6/6]

template<typename Derived >

const Block< const CoefficientsType, 1, Dynamic > Eigen::internal::BandMatrixBase< Derived >::diagonal ( Index  i ) const

inline

Returns

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

diagonalLength()

template<typename Derived >

Index Eigen::internal::BandMatrixBase< Derived >::diagonalLength ( Index  i ) const

inlineprotected

evalTo()

template<typename Derived >

template<typename Dest >

void Eigen::internal::BandMatrixBase< Derived >::evalTo ( Dest &  dst ) const

inline

rows()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::rows ( ) const

inline

Returns

the number of rows.

See also

cols(), RowsAtCompileTime

subs()

template<typename Derived >

Index Eigen::internal::BandMatrixBase< Derived >::subs ( ) const

inline

Returns

the number of sub diagonals

supers()

template<typename Derived >

Index Eigen::internal::BandMatrixBase< Derived >::supers ( ) const

inline

Returns

the number of super diagonals

toDenseMatrix()

template<typename Derived >

DenseMatrixType Eigen::internal::BandMatrixBase< Derived >::toDenseMatrix ( ) const

inline

---

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

• core/util/algorithms/eigen-3.4.0/Eigen/src/Core/BandMatrix.h