Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions
Eigen::internal::BandMatrixBase< Derived > Class Template Reference

#include <BandMatrix.h>

Inheritance diagram for Eigen::internal::BandMatrixBase< Derived >:
Inheritance graph
[legend]

List of all members.

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 DenseMatrixType::Index Index
typedef internal::traits
< Derived >::Scalar 
Scalar

Public Member Functions

const CoefficientsTypecoeffs () const
CoefficientsTypecoeffs ()
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
Index subs () const
Index supers () const
DenseMatrixType toDenseMatrix () 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

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

Reimplemented in Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >.

Definition at line 37 of file BandMatrix.h.

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

Definition at line 34 of file BandMatrix.h.

template<typename Derived>
typedef DenseMatrixType::Index Eigen::internal::BandMatrixBase< Derived >::Index
template<typename Derived>
typedef internal::traits<Derived>::Scalar Eigen::internal::BandMatrixBase< Derived >::Scalar

Member Enumeration Documentation

template<typename Derived>
anonymous enum
Enumerator:
Flags 
CoeffReadCost 
RowsAtCompileTime 
ColsAtCompileTime 
MaxRowsAtCompileTime 
MaxColsAtCompileTime 
Supers 
Subs 
Options 

Definition at line 22 of file BandMatrix.h.

template<typename Derived>
anonymous enum [protected]
Enumerator:
DataRowsAtCompileTime 
SizeAtCompileTime 

Definition at line 40 of file BandMatrix.h.


Member Function Documentation

template<typename Derived>
const CoefficientsType& Eigen::internal::BandMatrixBase< Derived >::coeffs ( ) const [inline]
template<typename Derived>
CoefficientsType& Eigen::internal::BandMatrixBase< Derived >::coeffs ( ) [inline]
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.

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.

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.

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.

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.

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.

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.

template<typename Derived>
Index Eigen::internal::BandMatrixBase< Derived >::diagonalLength ( Index  i) const [inline, protected]

Definition at line 154 of file BandMatrix.h.

template<typename Derived>
template<typename Dest >
void Eigen::internal::BandMatrixBase< Derived >::evalTo ( Dest &  dst) const [inline]

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 134 of file BandMatrix.h.

template<typename Derived>
Index Eigen::internal::BandMatrixBase< Derived >::subs ( ) const [inline]
template<typename Derived>
Index Eigen::internal::BandMatrixBase< Derived >::supers ( ) const [inline]
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:


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