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

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 EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT

constexpr EIGEN_DEVICE_FUNC Derived &	derived ()

constexpr EIGEN_DEVICE_FUNC const Derived &	derived () const

EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT

Public Member Functions inherited from Eigen::EigenBase< Derived >
constexpr EIGEN_DEVICE_FUNC Derived &	derived ()

constexpr 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

template<typename Device >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE DeviceWrapper< Derived, Device >	device (Device &device)

template<typename Device >
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE DeviceWrapper< const Derived, Device >	device (Device &device) const

Protected Types
enum	{ DataRowsAtCompileTime = ((Supers != Dynamic) && (Subs != Dynamic)) ? 1 + Supers + Subs : Dynamic , SizeAtCompileTime = min_size_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

        {
     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
   };

◆ anonymous enum

template<typename Derived >

anonymous enum

protected

Enumerator
DataRowsAtCompileTime
SizeAtCompileTime

        {
     DataRowsAtCompileTime = ((Supers != Dynamic) && (Subs != Dynamic)) ? 1 + Supers + Subs : Dynamic,
     SizeAtCompileTime = min_size_prefer_dynamic(RowsAtCompileTime, ColsAtCompileTime)
   };

Member Function Documentation

◆ coeffs() [1/2]

template<typename Derived >

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

inline

Returns: an expression of the underlying coefficient matrix

61 { return derived().coeffs(); }

Eigen::internal::BandMatrixBase::derived

constexpr EIGEN_DEVICE_FUNC Derived & derived()

Definition: EigenBase.h:49

References Eigen::internal::BandMatrixBase< Derived >::derived().

◆ coeffs() [2/2]

template<typename Derived >

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

inline

Returns: an expression of the underlying coefficient matrix

58 { return derived().coeffs(); }

References Eigen::internal::BandMatrixBase< Derived >::derived().

Referenced by Eigen::internal::BandMatrixBase< Derived >::col(), and Eigen::internal::BandMatrixBase< Derived >::diagonal().

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

                                                           {
     EIGEN_STATIC_ASSERT((int(Options) & int(RowMajor)) == 0, THIS_METHOD_IS_ONLY_FOR_COLUMN_MAJOR_MATRICES);
     Index start = 0;
     Index len = coeffs().rows();
     if (i <= supers()) {
       start = supers() - i;
       len = (std::min)(rows(), std::max<Index>(0, coeffs().rows() - (supers() - i)));
     } else if (i >= rows() - subs())
       len = std::max<Index>(0, coeffs().rows() - (i + 1 - rows() + subs()));
     return Block<CoefficientsType, Dynamic, 1>(coeffs(), start, i, len, 1);
   }

References Eigen::internal::BandMatrixBase< Derived >::coeffs(), EIGEN_STATIC_ASSERT, i, min, Eigen::internal::BandMatrixBase< Derived >::Options, Eigen::RowMajor, Eigen::internal::BandMatrixBase< Derived >::rows(), oomph::CumulativeTimings::start(), Eigen::internal::BandMatrixBase< Derived >::subs(), and Eigen::internal::BandMatrixBase< Derived >::supers().

◆ cols()

template<typename Derived >

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

inline

Returns: the number of columns.

See also: rows(), ColsAtCompileTime

61 { return derived().cols(); }

Referenced by gdb.printers._MatrixEntryIterator::__next__(), Eigen::internal::BandMatrixWrapper< CoefficientsType_, Rows_, Cols_, Supers_, Subs_, Options_ >::BandMatrixWrapper(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), Eigen::internal::BandMatrixBase< Derived >::diagonal(), Eigen::internal::BandMatrixBase< Derived >::diagonalLength(), Eigen::internal::BandMatrixBase< Derived >::evalTo(), gdb.printers.EigenMatrixPrinter::to_string(), gdb.printers.EigenSparseMatrixPrinter::to_string(), and Eigen::internal::BandMatrixBase< Derived >::toDenseMatrix().

◆ derived() [1/2]

template<typename Derived >

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

inlineconstexpr

Returns: a reference to the derived object

49 { return *static_cast<Derived*>(this); }

Referenced by Eigen::internal::BandMatrixBase< Derived >::coeffs(), Eigen::internal::BandMatrixBase< Derived >::subs(), and Eigen::internal::BandMatrixBase< Derived >::supers().

◆ derived() [2/2]

template<typename Derived >

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

inlineconstexpr

Returns: a const reference to the derived object

51 { return *static_cast<const Derived*>(this); }

◆ diagonal() [1/6]

template<typename Derived >

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

inline

Returns: a vector expression of the main diagonal

                                                                   {
     return Block<CoefficientsType, 1, SizeAtCompileTime>(coeffs(), supers(), 0, 1, (std::min)(rows(), cols()));
   }

References Eigen::internal::BandMatrixBase< Derived >::coeffs(), Eigen::internal::BandMatrixBase< Derived >::cols(), min, Eigen::internal::BandMatrixBase< Derived >::rows(), and Eigen::internal::BandMatrixBase< Derived >::supers().

Referenced by Eigen::internal::BandMatrixBase< Derived >::evalTo(), and Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >::sub().

◆ 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

                                                           {
     return typename DiagonalIntReturnType<N>::BuildType(coeffs(), supers() - N, (std::max)(0, N), 1, diagonalLength(N));
   }

References Eigen::internal::BandMatrixBase< Derived >::coeffs(), Eigen::internal::BandMatrixBase< Derived >::diagonalLength(), max, N, and Eigen::internal::BandMatrixBase< Derived >::supers().

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

                                                                                     {
     return Block<const CoefficientsType, 1, SizeAtCompileTime>(coeffs(), supers(), 0, 1, (std::min)(rows(), cols()));
   }

References Eigen::internal::BandMatrixBase< Derived >::coeffs(), Eigen::internal::BandMatrixBase< Derived >::cols(), min, Eigen::internal::BandMatrixBase< Derived >::rows(), and Eigen::internal::BandMatrixBase< Derived >::supers().

◆ 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

                                                                       {
     return typename DiagonalIntReturnType<N>::BuildType(coeffs(), supers() - N, (std::max)(0, N), 1, diagonalLength(N));
   }

References Eigen::internal::BandMatrixBase< Derived >::coeffs(), Eigen::internal::BandMatrixBase< Derived >::diagonalLength(), max, N, and Eigen::internal::BandMatrixBase< Derived >::supers().

◆ 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

                                                                {
     eigen_assert((i < 0 && -i <= subs()) || (i >= 0 && i <= supers()));
     return Block<CoefficientsType, 1, Dynamic>(coeffs(), supers() - i, std::max<Index>(0, i), 1, diagonalLength(i));
   }

References Eigen::internal::BandMatrixBase< Derived >::coeffs(), Eigen::internal::BandMatrixBase< Derived >::diagonalLength(), eigen_assert, i, Eigen::internal::BandMatrixBase< Derived >::subs(), and Eigen::internal::BandMatrixBase< Derived >::supers().

◆ 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

                                                                                  {
     eigen_assert((i < 0 && -i <= subs()) || (i >= 0 && i <= supers()));
     return Block<const CoefficientsType, 1, Dynamic>(coeffs(), supers() - i, std::max<Index>(0, i), 1,
                                                      diagonalLength(i));
   }

References Eigen::internal::BandMatrixBase< Derived >::coeffs(), Eigen::internal::BandMatrixBase< Derived >::diagonalLength(), eigen_assert, i, Eigen::internal::BandMatrixBase< Derived >::subs(), and Eigen::internal::BandMatrixBase< Derived >::supers().

◆ diagonalLength()

template<typename Derived >

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

inlineprotected

                                              {
     return i < 0 ? (std::min)(cols(), rows() + i) : (std::min)(rows(), cols() - i);
   }

References Eigen::internal::BandMatrixBase< Derived >::cols(), i, min, and Eigen::internal::BandMatrixBase< Derived >::rows().

Referenced by Eigen::internal::BandMatrixBase< Derived >::diagonal().

◆ evalTo()

template<typename Derived >

template<typename Dest >

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

inline

                                       {
     dst.resize(rows(), cols());
     dst.setZero();
     dst.diagonal() = diagonal();
     for (Index i = 1; i <= supers(); ++i) dst.diagonal(i) = diagonal(i);
     for (Index i = 1; i <= subs(); ++i) dst.diagonal(-i) = diagonal(-i);
   }

References Eigen::internal::BandMatrixBase< Derived >::cols(), Eigen::internal::BandMatrixBase< Derived >::diagonal(), i, Eigen::internal::BandMatrixBase< Derived >::rows(), Eigen::internal::BandMatrixBase< Derived >::subs(), and Eigen::internal::BandMatrixBase< Derived >::supers().

Referenced by Eigen::internal::BandMatrixBase< Derived >::toDenseMatrix().

◆ rows()

template<typename Derived >

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

inline

Returns: the number of rows.

See also: cols(), RowsAtCompileTime

59 { return derived().rows(); }

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), Eigen::internal::BandMatrixBase< Derived >::col(), Eigen::internal::BandMatrixBase< Derived >::diagonal(), Eigen::internal::BandMatrixBase< Derived >::diagonalLength(), Eigen::internal::BandMatrixBase< Derived >::evalTo(), gdb.printers.EigenMatrixPrinter::to_string(), gdb.printers.EigenSparseMatrixPrinter::to_string(), and Eigen::internal::BandMatrixBase< Derived >::toDenseMatrix().

◆ subs()

template<typename Derived >

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

inline

Returns: the number of sub diagonals

55 { return derived().subs(); }

References Eigen::internal::BandMatrixBase< Derived >::derived().

Referenced by Eigen::internal::BandMatrixBase< Derived >::col(), Eigen::internal::BandMatrixBase< Derived >::diagonal(), and Eigen::internal::BandMatrixBase< Derived >::evalTo().

◆ supers()

template<typename Derived >

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

inline

Returns: the number of super diagonals

52 { return derived().supers(); }

References Eigen::internal::BandMatrixBase< Derived >::derived().

Referenced by Eigen::internal::BandMatrixBase< Derived >::col(), Eigen::internal::BandMatrixBase< Derived >::diagonal(), and Eigen::internal::BandMatrixBase< Derived >::evalTo().

◆ toDenseMatrix()

template<typename Derived >

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

inline

                                         {
     DenseMatrixType res(rows(), cols());
     evalTo(res);
     return res;
   }

References Eigen::internal::BandMatrixBase< Derived >::cols(), Eigen::internal::BandMatrixBase< Derived >::evalTo(), res, and Eigen::internal::BandMatrixBase< Derived >::rows().

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

BandMatrix.h

Classes

Public Types

Public Member Functions

Protected Types

Protected Member Functions

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