Eigen::internal::BandMatrixBase Class Reference

Inheritance diagram for Eigen::internal::BandMatrixBase:

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 internal::traits < Derived >::Scalar	Scalar
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	DenseMatrixType
typedef DenseMatrixType::Index	Index
typedef internal::traits < Derived >::CoefficientsType	CoefficientsType
typedef EigenBase< Derived >	Base
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
Derived &	derived ()
const Derived &	derived () const
Derived &	const_cast_derived () const
const Derived &	const_derived () const
Index	rows () const
Index	cols () const
Index	size () const
void	addTo (Dest &dst) const
void	subTo (Dest &dst) const
void	applyThisOnTheRight (Dest &dst) const
void	applyThisOnTheLeft (Dest &dst) const
Protected Types
enum	{ DataRowsAtCompileTime, SizeAtCompileTime = EIGEN_SIZE_MIN_PREFER_DYNAMIC(RowsAtCompileTime,ColsAtCompileTime) }
Protected Member Functions
Index	diagonalLength (Index i) const

---

Member Typedef Documentation

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

Definition at line 52 of file Core.

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

Reimplemented in Eigen::internal::BandMatrixWrapper, and Eigen::internal::BandMatrix.

Definition at line 51 of file Core.

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

Definition at line 49 of file Core.

typedef DenseMatrixType::Index Eigen::internal::BandMatrixBase::Index

Reimplemented from Eigen::EigenBase< Derived >.

Reimplemented in Eigen::internal::BandMatrixWrapper, and Eigen::internal::BandMatrix.

Definition at line 50 of file Core.

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

Reimplemented in Eigen::internal::BandMatrixWrapper, and Eigen::internal::BandMatrix.

Definition at line 48 of file Core.

typedef internal::traits<Derived>::StorageKind Eigen::EigenBase::StorageKind [inherited]

Reimplemented in Eigen::DenseCoeffsBase< Derived, WriteAccessors >, Eigen::TriangularBase, Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >, and Eigen::SparseMatrixBase.

Definition at line 45 of file Core.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

Flags
CoeffReadCost
RowsAtCompileTime
ColsAtCompileTime
MaxRowsAtCompileTime
MaxColsAtCompileTime
Supers
Subs
Options

Definition at line 37 of file Core.

anonymous enum [protected]

Enumerator:

DataRowsAtCompileTime
SizeAtCompileTime

Definition at line 55 of file Core.

---

Member Function Documentation

void Eigen::EigenBase::addTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 71 of file Core.

void Eigen::EigenBase::applyThisOnTheLeft

(

Dest &

dst

)

const [inline, inherited]

Definition at line 99 of file Core.

void Eigen::EigenBase::applyThisOnTheRight

(

Dest &

dst

)

const [inline, inherited]

Definition at line 91 of file Core.

const CoefficientsType& Eigen::internal::BandMatrixBase::coeffs

(

)

const [inline]

Returns:

an expression of the underlying coefficient matrix

Reimplemented in Eigen::internal::BandMatrixWrapper, and Eigen::internal::BandMatrix.

Definition at line 75 of file Core.

CoefficientsType& Eigen::internal::BandMatrixBase::coeffs

(

)

[inline]

Returns:

an expression of the underlying coefficient matrix

Reimplemented in Eigen::internal::BandMatrix.

Definition at line 78 of file Core.

Block<CoefficientsType,Dynamic,1> Eigen::internal::BandMatrixBase::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 83 of file Core.

Index Eigen::EigenBase::cols

(

void

)

const [inline, inherited]

Returns:

the number of columns.

See also:

rows(), ColsAtCompileTime

Reimplemented in Eigen::SparseMatrixBase, Eigen::PermutationBase, and Eigen::TriangularBase.

Definition at line 61 of file Core.

Derived& Eigen::EigenBase::const_cast_derived

(

)

const [inline, inherited]

Definition at line 53 of file Core.

const Derived& Eigen::EigenBase::const_derived

(

)

const [inline, inherited]

Definition at line 55 of file Core.

Derived& Eigen::EigenBase::derived

(

)

[inline, inherited]

Returns:

a reference to the derived object

Definition at line 49 of file Core.

const Derived& Eigen::EigenBase::derived

(

)

const [inline, inherited]

Returns:

a const reference to the derived object

Definition at line 51 of file Core.

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

(

)

[inline]

Returns:

a vector expression of the main diagonal

Definition at line 99 of file Core.

const Block<const CoefficientsType,1,SizeAtCompileTime> Eigen::internal::BandMatrixBase::diagonal

(

)

const [inline]

Returns:

a vector expression of the main diagonal (const version)

Definition at line 103 of file Core.

template<int N>

DiagonalIntReturnType<N>::Type Eigen::internal::BandMatrixBase::diagonal

(

)

[inline]

Returns:

a vector expression of the N -th sub or super diagonal

Definition at line 124 of file Core.

template<int N>

const DiagonalIntReturnType<N>::Type Eigen::internal::BandMatrixBase::diagonal

(

)

const [inline]

Returns:

a vector expression of the N -th sub or super diagonal

Definition at line 130 of file Core.

Block<CoefficientsType,1,Dynamic> Eigen::internal::BandMatrixBase::diagonal

(

Index

i

)

[inline]

Returns:

a vector expression of the i -th sub or super diagonal

Definition at line 136 of file Core.

const Block<const CoefficientsType,1,Dynamic> Eigen::internal::BandMatrixBase::diagonal

(

Index

i

)

const [inline]

Returns:

a vector expression of the i -th sub or super diagonal

Definition at line 143 of file Core.

Index Eigen::internal::BandMatrixBase::diagonalLength

(

Index

i

)

const [inline, protected]

Definition at line 169 of file Core.

template<typename Dest >

void Eigen::internal::BandMatrixBase::evalTo

(

Dest &

dst

)

const [inline]

Reimplemented from Eigen::EigenBase< Derived >.

Definition at line 149 of file Core.

Index Eigen::EigenBase::rows

(

void

)

const [inline, inherited]

Returns:

the number of rows.

See also:

cols(), RowsAtCompileTime

Reimplemented in Eigen::SparseMatrixBase, Eigen::PermutationBase, and Eigen::TriangularBase.

Definition at line 59 of file Core.

Index Eigen::EigenBase::size

(

)

const [inline, inherited]

Returns:

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

See also:

rows(), cols(), SizeAtCompileTime.

Reimplemented in Eigen::SparseMatrixBase, and Eigen::PermutationBase.

Definition at line 64 of file Core.

Index Eigen::internal::BandMatrixBase::subs

(

)

const [inline]

Returns:

the number of sub diagonals

Reimplemented in Eigen::internal::BandMatrixWrapper, and Eigen::internal::BandMatrix.

Definition at line 72 of file Core.

void Eigen::EigenBase::subTo

(

Dest &

dst

)

const [inline, inherited]

Definition at line 81 of file Core.

Index Eigen::internal::BandMatrixBase::supers

(

)

const [inline]

Returns:

the number of super diagonals

Reimplemented in Eigen::internal::BandMatrixWrapper, and Eigen::internal::BandMatrix.

Definition at line 69 of file Core.

DenseMatrixType Eigen::internal::BandMatrixBase::toDenseMatrix

(

)

const [inline]

Definition at line 160 of file Core.