Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > Class Template Reference

Represents a rectangular matrix with a banded storage. More...

#include <src/eigen/Eigen/src/Core/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 >::StorageIndex	StorageIndex
typedef internal::traits< BandMatrix >::CoefficientsType	CoefficientsType
enum
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	DenseMatrixType
typedef EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >	Base
typedef Eigen::Index	Index
	The interface type of indices.
typedef internal::traits< Derived >::StorageKind	StorageKind

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 ()
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
EIGEN_DEVICE_FUNC BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > &	derived ()
EIGEN_DEVICE_FUNC const BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > &	derived () const
EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const
EIGEN_DEVICE_FUNC const Derived &	const_derived () const
EIGEN_DEVICE_FUNC Index	size () 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

Protected Member Functions
Index	diagonalLength (Index i) 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

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.

Template 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

Member Typedef Documentation

Base

typedef EigenBase<BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > > Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::Base

inherited

CoefficientsType

template<typename _Scalar , int Rows, int Cols, int Supers, int Subs, int Options>

typedef internal::traits<BandMatrix>::CoefficientsType Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::CoefficientsType

DenseMatrixType

typedef Matrix<Scalar,RowsAtCompileTime,ColsAtCompileTime> Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::DenseMatrixType

inherited

Index

template<typename Derived >

typedef Eigen::Index Eigen::EigenBase< Derived >::Index

inherited

The interface type of indices.

To change this, #define the preprocessor symbol EIGEN_DEFAULT_DENSE_INDEX_TYPE.

See also

StorageIndex, TopicPreprocessorDirectives.

Scalar

template<typename _Scalar , int Rows, int Cols, int Supers, int Subs, int Options>

typedef internal::traits<BandMatrix>::Scalar Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::Scalar

StorageIndex

template<typename _Scalar , int Rows, int Cols, int Supers, int Subs, int Options>

typedef internal::traits<BandMatrix>::StorageIndex Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::StorageIndex

StorageKind

template<typename Derived >

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

inherited

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

         {
      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

anonymous enum

protectedinherited

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

Constructor & Destructor Documentation

BandMatrix()

template<typename _Scalar , int Rows, int Cols, int Supers, int Subs, int Options>

Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::BandMatrix ( Index  rows = Rows, Index  cols = Cols, Index  supers = Supers, Index  subs = Subs  )

inlineexplicit

      : m_coeffs(1+supers+subs,cols),
        m_rows(rows), m_supers(supers), m_subs(subs)
    {
    }

Member Function Documentation

addTo()

template<typename Derived >

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::addTo ( Dest &  dst ) const

inlineinherited

  {
    // This is the default implementation,
    // derived class can reimplement it in a more optimized way.
    typename Dest::PlainObject res(rows(),cols());
    evalTo(res);
    dst += res;
  }

applyThisOnTheLeft()

template<typename Derived >

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::applyThisOnTheLeft ( Dest &  dst ) const

inlineinherited

  {
    // This is the default implementation,
    // derived class can reimplement it in a more optimized way.
    dst = this->derived() * dst;
  }

References Eigen::EigenBase< Derived >::derived().

Here is the call graph for this function:

applyThisOnTheRight()

template<typename Derived >

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::applyThisOnTheRight ( Dest &  dst ) const

inlineinherited

  {
    // This is the default implementation,
    // derived class can reimplement it in a more optimized way.
    dst = dst * this->derived();
  }

References Eigen::EigenBase< Derived >::derived().

Here is the call graph for this function:

coeffs() [1/2]

template<typename _Scalar , int Rows, int Cols, int Supers, int Subs, int Options>

CoefficientsType & Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::coeffs ( )

inline

{ return m_coeffs; }

coeffs() [2/2]

template<typename _Scalar , int Rows, int Cols, int Supers, int Subs, int Options>

const CoefficientsType & Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::coeffs ( ) const

inline

{ return m_coeffs; }

col()

Block< CoefficientsType, Dynamic, 1 > Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::col ( Index  i )

inlineinherited

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((Options&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);
    }

cols()

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

{ return m_coeffs.cols(); }

const_cast_derived()

template<typename Derived >

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

inlineinherited

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

Referenced by Eigen::TriangularViewImpl< _MatrixType, _Mode, Dense >::swap().

Here is the caller graph for this function:

const_derived()

template<typename Derived >

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

inlineinherited

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

derived() [1/2]

EIGEN_DEVICE_FUNC BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > & Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::derived ( )

inlineinherited

Returns

a reference to the derived object

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

derived() [2/2]

EIGEN_DEVICE_FUNC const BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > & Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::derived ( ) const

inlineinherited

Returns

a const reference to the derived object

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

diagonal() [1/6]

Block< CoefficientsType, 1, SizeAtCompileTime > Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::diagonal ( )

inlineinherited

Returns

a vector expression of the main diagonal

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

diagonal() [2/6]

DiagonalIntReturnType< N >::Type Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::diagonal ( )

inlineinherited

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

diagonal() [3/6]

const Block< const CoefficientsType, 1, SizeAtCompileTime > Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::diagonal ( ) const

inlineinherited

Returns

a vector expression of the main diagonal (const version)

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

diagonal() [4/6]

const DiagonalIntReturnType< N >::Type Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::diagonal ( ) const

inlineinherited

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

diagonal() [5/6]

Block< CoefficientsType, 1, Dynamic > Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::diagonal ( Index  i )

inlineinherited

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

diagonal() [6/6]

const Block< const CoefficientsType, 1, Dynamic > Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::diagonal ( Index  i ) const

inlineinherited

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

diagonalLength()

Index Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::diagonalLength ( Index  i ) const

inlineprotectedinherited

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

evalTo()

void Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::evalTo ( Dest &  dst ) const

inlineinherited

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

rows()

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

{ return m_rows.value(); }

size()

template<typename Derived >

EIGEN_DEVICE_FUNC Index Eigen::EigenBase< Derived >::size ( ) const

inlineinherited

Returns

the number of coefficients, which is rows()*cols().

See also

rows(), cols(), SizeAtCompileTime.

{ return rows() * cols(); }

References Eigen::EigenBase< Derived >::cols(), and Eigen::EigenBase< Derived >::rows().

Referenced by Eigen::PlainObjectBase< Derived >::_resize_to_match(), Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::resize(), Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setIdentity(), and Eigen::DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >::setZero().

Here is the call graph for this function:

Here is the caller graph for this function:

subs()

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

{ return m_subs.value(); }

subTo()

template<typename Derived >

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::subTo ( Dest &  dst ) const

inlineinherited

  {
    // This is the default implementation,
    // derived class can reimplement it in a more optimized way.
    typename Dest::PlainObject res(rows(),cols());
    evalTo(res);
    dst -= res;
  }

References Eigen::EigenBase< Derived >::cols(), Eigen::EigenBase< Derived >::evalTo(), and Eigen::EigenBase< Derived >::rows().

Here is the call graph for this function:

supers()

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

{ return m_supers.value(); }

toDenseMatrix()

DenseMatrixType Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >::toDenseMatrix ( ) const

inlineinherited

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

Member Data Documentation

m_coeffs

template<typename _Scalar , int Rows, int Cols, int Supers, int Subs, int Options>

CoefficientsType Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_coeffs

protected

m_rows

template<typename _Scalar , int Rows, int Cols, int Supers, int Subs, int Options>

internal::variable_if_dynamic<Index, Rows> Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_rows

protected

m_subs

template<typename _Scalar , int Rows, int Cols, int Supers, int Subs, int Options>

internal::variable_if_dynamic<Index, Subs> Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_subs

protected

m_supers

template<typename _Scalar , int Rows, int Cols, int Supers, int Subs, int Options>

internal::variable_if_dynamic<Index, Supers> Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::m_supers

protected

---

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

• src/eigen/Eigen/src/Core/BandMatrix.h