#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 EigenBase< Derived >	Base

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

typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	DenseMatrixType

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

typedef DenseMatrixType::StorageIndex	StorageIndex

Public Types inherited from Eigen::EigenBase< Derived >
typedef Eigen::Index	Index
	The interface type of indices. More...

typedef internal::traits< Derived >::StorageKind	StorageKind

Public Member Functions
CoefficientsType &	coeffs ()

const CoefficientsType &	coeffs () const

Block< CoefficientsType, Dynamic, 1 >	col (Index i)

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC Derived &	derived ()

const EIGEN_DEVICE_FUNC Derived &	derived () const

Block< CoefficientsType, 1, SizeAtCompileTime >	diagonal ()

template<int N>
DiagonalIntReturnType< N >::Type	diagonal ()

const Block< const CoefficientsType, 1, SizeAtCompileTime >	diagonal () const

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

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

Index	subs () const

Index	supers () const

DenseMatrixType	toDenseMatrix () const

Public Member Functions inherited from Eigen::EigenBase< Derived >
template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const

template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const

const EIGEN_DEVICE_FUNC Derived &	const_derived () const

EIGEN_DEVICE_FUNC Derived &	derived ()

const EIGEN_DEVICE_FUNC Derived &	derived () const

template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT

template<typename Dest >
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const

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

Protected Member Functions
Index	diagonalLength (Index i) const

Detailed Description

template<typename Derived>
class Eigen::internal::BandMatrixBase< Derived >

Definition at line 18 of file BandMatrix.h.

Member Typedef Documentation

◆ Base

template<typename Derived >

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

Definition at line 37 of file BandMatrix.h.

◆ CoefficientsType

template<typename Derived >

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

Definition at line 36 of file BandMatrix.h.

◆ DenseMatrixType

template<typename Derived >

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

Definition at line 34 of file BandMatrix.h.

◆ Scalar

template<typename Derived >

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

Definition at line 33 of file BandMatrix.h.

◆ StorageIndex

template<typename Derived >

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

Definition at line 35 of file BandMatrix.h.

Member Enumeration Documentation

◆ anonymous enum

template<typename Derived >

anonymous enum

Enumerator
Flags
CoeffReadCost
RowsAtCompileTime
ColsAtCompileTime
MaxRowsAtCompileTime
MaxColsAtCompileTime
Supers
Subs
Options

Definition at line 22 of file BandMatrix.h.

◆ anonymous enum

template<typename Derived >

anonymous enum

protected

Enumerator
DataRowsAtCompileTime
SizeAtCompileTime

Definition at line 40 of file BandMatrix.h.

Member Function Documentation

◆ coeffs() [1/2]

template<typename Derived >

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

inline

Returns: an expression of the underlying coefficient matrix

Definition at line 63 of file BandMatrix.h.

◆ coeffs() [2/2]

template<typename Derived >

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

inline

Returns: an expression of the underlying coefficient matrix

Definition at line 60 of file BandMatrix.h.

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

Definition at line 68 of file BandMatrix.h.

◆ cols()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::cols

inline

Returns: the number of columns.

See also: rows(), ColsAtCompileTime

Definition at line 63 of file EigenBase.h.

◆ derived() [1/2]

template<typename Derived >

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

inline

Returns: a reference to the derived object

Definition at line 46 of file EigenBase.h.

◆ derived() [2/2]

template<typename Derived >

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

inline

Returns: a const reference to the derived object

Definition at line 49 of file EigenBase.h.

◆ diagonal() [1/6]

template<typename Derived >

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

inline

Returns: a vector expression of the main diagonal

Definition at line 84 of file BandMatrix.h.

◆ 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

Definition at line 109 of file BandMatrix.h.

◆ 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)

Definition at line 88 of file BandMatrix.h.

◆ 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

Definition at line 115 of file BandMatrix.h.

◆ 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

Definition at line 121 of file BandMatrix.h.

◆ 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

Definition at line 128 of file BandMatrix.h.

◆ diagonalLength()

template<typename Derived >

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

inlineprotected

Definition at line 154 of file BandMatrix.h.

◆ evalTo()

template<typename Derived >

template<typename Dest >

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

inline

Definition at line 134 of file BandMatrix.h.

◆ rows()

template<typename Derived >

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::rows

inline

Returns: the number of rows.

See also: cols(), RowsAtCompileTime

Definition at line 60 of file EigenBase.h.

◆ subs()

template<typename Derived >

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

inline

Returns: the number of sub diagonals

Definition at line 57 of file BandMatrix.h.

◆ supers()

template<typename Derived >

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

inline

Returns: the number of super diagonals

Definition at line 54 of file BandMatrix.h.

◆ toDenseMatrix()

template<typename Derived >

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

inline

Definition at line 145 of file BandMatrix.h.

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

BandMatrix.h

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Detailed Description

template<typename Derived> class Eigen::internal::BandMatrixBase< Derived >

Member Typedef Documentation

◆ Base

◆ CoefficientsType

◆ DenseMatrixType

◆ Scalar

◆ StorageIndex

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Member Function Documentation

◆ coeffs() [1/2]

◆ coeffs() [2/2]

◆ col()

◆ cols()

◆ derived() [1/2]

◆ derived() [2/2]

◆ diagonal() [1/6]

◆ diagonal() [2/6]

◆ diagonal() [3/6]

◆ diagonal() [4/6]

◆ diagonal() [5/6]

◆ diagonal() [6/6]

◆ diagonalLength()

◆ evalTo()

◆ rows()

◆ subs()

◆ supers()

◆ toDenseMatrix()

template<typename Derived>
class Eigen::internal::BandMatrixBase< Derived >