Public Types | Public Member Functions | Protected Attributes
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 >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef internal::traits
< BandMatrix >
::CoefficientsType 
CoefficientsType
typedef internal::traits
< BandMatrix >::Index 
Index
typedef internal::traits
< BandMatrix >::Scalar 
Scalar

Public Member Functions

 BandMatrix (Index rows=Rows, Index cols=Cols, Index supers=Supers, Index subs=Subs)
const CoefficientsTypecoeffs () const
CoefficientsTypecoeffs ()
Index cols () const
Index rows () const
Index subs () const
Index supers () const

Protected Attributes

CoefficientsType m_coeffs
internal::variable_if_dynamic
< Index, Rows > 
m_rows
internal::variable_if_dynamic
< Index, Subs
m_subs
internal::variable_if_dynamic
< Index, Supers
m_supers

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:
_ScalarNumeric type, i.e. float, double, int
RowsNumber of rows, or Dynamic
ColsNumber of columns, or Dynamic
SupersNumber of super diagonal
SubsNumber of sub diagonal
_OptionsA 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 Typedef Documentation

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
template<typename _Scalar, int Rows, int Cols, int Supers, int Subs, int Options>
typedef internal::traits<BandMatrix>::Index Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >::Index
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

Constructor & Destructor Documentation

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 
) [inline]

Definition at line 207 of file BandMatrix.h.


Member Function Documentation

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]
Returns:
an expression of the underlying coefficient matrix

Reimplemented from Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >.

Definition at line 225 of file BandMatrix.h.

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]
Returns:
an expression of the underlying coefficient matrix

Reimplemented from Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >.

Definition at line 226 of file BandMatrix.h.

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

Reimplemented from Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >.

Definition at line 217 of file BandMatrix.h.

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

Reimplemented from Eigen::EigenBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >.

Definition at line 214 of file BandMatrix.h.

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

Reimplemented from Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >.

Definition at line 223 of file BandMatrix.h.

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

Reimplemented from Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >.

Definition at line 220 of file BandMatrix.h.


Member Data Documentation

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]

Definition at line 230 of file BandMatrix.h.

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]

Definition at line 231 of file BandMatrix.h.

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]

Definition at line 233 of file BandMatrix.h.

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]

Definition at line 232 of file BandMatrix.h.


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


win_eigen
Author(s): Daniel Stonier
autogenerated on Wed Sep 16 2015 07:12:59