Public Types | Public Member Functions

EigenBase< Derived > Struct Template Reference

#include <EigenBase.h>

Inheritance diagram for EigenBase< Derived >:
DenseCoeffsBase< Derived, ReadOnlyAccessors > DiagonalBase< Derived > internal::BandMatrixBase< Derived > PermutationBase< Derived > SparseMatrixBase< Derived > TriangularBase< Derived > DenseCoeffsBase< Derived, DirectAccessors > DenseCoeffsBase< Derived, WriteAccessors > internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor > DenseCoeffsBase< Derived, DirectWriteAccessors > internal::TridiagonalMatrix< Scalar, Size, Options >

List of all members.

Public Types

typedef internal::traits
< Derived >::StorageKind 		StorageKind
typedef internal::traits
< Derived >::Index 		Index

Public Member Functions

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
template<typename Dest >
void evalTo (Dest &dst) const
template<typename Dest >
void addTo (Dest &dst) const
template<typename Dest >
void subTo (Dest &dst) const
template<typename Dest >
void applyThisOnTheRight (Dest &dst) const
template<typename Dest >
void applyThisOnTheLeft (Dest &dst) const

Detailed Description

template<typename Derived>
struct EigenBase< Derived >

Common base class for all classes T such that MatrixBase has an operator=(T) and a constructor MatrixBase(T).

In other words, an EigenBase object is an object that can be copied into a MatrixBase.

Besides MatrixBase-derived classes, this also includes special matrix classes such as diagonal matrices, etc.

Notice that this class is trivial, it is only used to disambiguate overloaded functions.

See also:
TopicClassHierarchy

Member Typedef Documentation

template<typename Derived>
typedef internal::traits<Derived>::Index EigenBase< Derived >::Index

Reimplemented in internal::BandMatrixBase< Derived >, internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >, internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >, DenseCoeffsBase< Derived, ReadOnlyAccessors >, DenseCoeffsBase< Derived, WriteAccessors >, DenseCoeffsBase< Derived, DirectAccessors >, DenseCoeffsBase< Derived, DirectWriteAccessors >, DiagonalBase< Derived >, DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >, PermutationBase< Derived >, Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess >, SelfAdjointView< MatrixType, UpLo >, TriangularBase< Derived >, TriangularView< _MatrixType, _Mode >, SparseMatrixBase< Derived >, SparseSelfAdjointView< MatrixType, UpLo >, SparseSymmetricPermutationProduct< MatrixType, UpLo >, internal::BandMatrixBase< BandMatrix< RealScalar, Rows, Cols, Supers, Subs, Options > >, internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >, internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >, internal::BandMatrixBase< BandMatrix< Scalar, Rows, Cols, Supers, Subs, Options > >, internal::BandMatrix< RealScalar, ColsAtCompileTime, ColsAtCompileTime, 1, 0 >, internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >, DiagonalBase< DiagonalWrapper< _DiagonalVectorType > >, DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >, PermutationBase< PermutationWrapper< _IndicesType > >, PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >, TriangularBase< TriangularView< _MatrixType, _Mode > >, TriangularBase< SelfAdjointView< MatrixType, UpLo > >, SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, SparseMatrixBase< Transpose< MatrixType > >, SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseInnerVectorSet< SparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseInnerVectorSet< MatrixType, Size > >, SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, SparseMatrixBase< SparseView< MatrixType > >, and SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >.

template<typename Derived>
typedef internal::traits<Derived>::StorageKind EigenBase< Derived >::StorageKind

Reimplemented in DenseCoeffsBase< Derived, ReadOnlyAccessors >, DenseCoeffsBase< Derived, WriteAccessors >, DiagonalBase< Derived >, DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime >, TriangularBase< Derived >, TriangularView< _MatrixType, _Mode >, SparseMatrixBase< Derived >, DiagonalBase< DiagonalWrapper< _DiagonalVectorType > >, DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >, TriangularBase< TriangularView< _MatrixType, _Mode > >, TriangularBase< SelfAdjointView< MatrixType, UpLo > >, SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, SparseMatrixBase< Transpose< MatrixType > >, SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseInnerVectorSet< SparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseInnerVectorSet< MatrixType, Size > >, SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, SparseMatrixBase< SparseView< MatrixType > >, and SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >.

Member Function Documentation

template<typename Derived>
template<typename Dest >
void EigenBase< Derived >::addTo ( Dest &  dst  )  const [inline]
template<typename Derived>
template<typename Dest >
void EigenBase< Derived >::applyThisOnTheLeft ( Dest &  dst  )  const [inline]

Reimplemented in HouseholderSequence< VectorsType, CoeffsType, Side >.

template<typename Derived>
template<typename Dest >
void EigenBase< Derived >::applyThisOnTheRight ( Dest &  dst  )  const [inline]

Reimplemented in HouseholderSequence< VectorsType, CoeffsType, Side >.

template<typename Derived>
Index EigenBase< Derived >::cols ( void   )  const [inline]
Returns:
the number of columns.
See also:
rows(), ColsAtCompileTime

Reimplemented in internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >, internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >, DiagonalBase< Derived >, PermutationBase< Derived >, Transpose< PermutationBase< Derived > >, SelfAdjointView< MatrixType, UpLo >, TriangularBase< Derived >, TriangularView< _MatrixType, _Mode >, HouseholderSequence< VectorsType, CoeffsType, Side >, DynamicSparseMatrix< _Scalar, _Options, _Index >, MappedSparseMatrix< _Scalar, _Flags, _Index >, SparseInnerVectorSet< MatrixType, Size >, SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size >, SparseInnerVectorSet< SparseMatrix< _Scalar, _Options, _Index >, Size >, SparseDenseOuterProduct< Lhs, Rhs, Tr >, SparseMatrix< _Scalar, _Options, _Index >, SparseMatrixBase< Derived >, SparseSparseProduct< LhsNested, RhsNested >, SparseSelfAdjointView< MatrixType, UpLo >, SparseSymmetricPermutationProduct< MatrixType, UpLo >, SparseTriangularView< MatrixType, Mode >, SparseVector< _Scalar, _Options, _Index >, SparseView< MatrixType >, internal::BandMatrix< RealScalar, ColsAtCompileTime, ColsAtCompileTime, 1, 0 >, internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >, DiagonalBase< DiagonalWrapper< _DiagonalVectorType > >, DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >, PermutationBase< PermutationWrapper< _IndicesType > >, PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >, TriangularBase< TriangularView< _MatrixType, _Mode > >, TriangularBase< SelfAdjointView< MatrixType, UpLo > >, SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, SparseMatrixBase< Transpose< MatrixType > >, SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseInnerVectorSet< SparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseInnerVectorSet< MatrixType, Size > >, SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, SparseMatrixBase< SparseView< MatrixType > >, and SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >.

template<typename Derived>
Derived& EigenBase< Derived >::const_cast_derived (  )  const [inline]

Reimplemented in SparseMatrixBase< Derived >, SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, SparseMatrixBase< Transpose< MatrixType > >, SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseInnerVectorSet< SparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseInnerVectorSet< MatrixType, Size > >, SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, SparseMatrixBase< SparseView< MatrixType > >, and SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >.

template<typename Derived>
const Derived& EigenBase< Derived >::const_derived (  )  const [inline]
template<typename Derived>
const Derived& EigenBase< Derived >::derived (  )  const [inline]
Returns:
a const reference to the derived object

Reimplemented in DiagonalBase< Derived >, TriangularBase< Derived >, SparseMatrixBase< Derived >, DiagonalBase< DiagonalWrapper< _DiagonalVectorType > >, DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >, TriangularBase< TriangularView< _MatrixType, _Mode > >, TriangularBase< SelfAdjointView< MatrixType, UpLo > >, SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, SparseMatrixBase< Transpose< MatrixType > >, SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseInnerVectorSet< SparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseInnerVectorSet< MatrixType, Size > >, SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, SparseMatrixBase< SparseView< MatrixType > >, and SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >.

template<typename Derived>
Derived& EigenBase< Derived >::derived (  )  [inline]
Returns:
a reference to the derived object

Reimplemented in DiagonalBase< Derived >, TriangularBase< Derived >, SparseMatrixBase< Derived >, DiagonalBase< DiagonalWrapper< _DiagonalVectorType > >, DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >, TriangularBase< TriangularView< _MatrixType, _Mode > >, TriangularBase< SelfAdjointView< MatrixType, UpLo > >, SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, SparseMatrixBase< Transpose< MatrixType > >, SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseInnerVectorSet< SparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseInnerVectorSet< MatrixType, Size > >, SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, SparseMatrixBase< SparseView< MatrixType > >, and SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >.

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

Reimplemented in internal::BandMatrixBase< Derived >, internal::BandMatrixBase< BandMatrix< RealScalar, Rows, Cols, Supers, Subs, Options > >, internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >, internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >, and internal::BandMatrixBase< BandMatrix< Scalar, Rows, Cols, Supers, Subs, Options > >.

template<typename Derived>
Index EigenBase< Derived >::rows ( void   )  const [inline]
Returns:
the number of rows.
See also:
cols(), RowsAtCompileTime

Reimplemented in internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >, internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >, DiagonalBase< Derived >, PermutationBase< Derived >, Transpose< PermutationBase< Derived > >, SelfAdjointView< MatrixType, UpLo >, TriangularBase< Derived >, TriangularView< _MatrixType, _Mode >, HouseholderSequence< VectorsType, CoeffsType, Side >, DynamicSparseMatrix< _Scalar, _Options, _Index >, MappedSparseMatrix< _Scalar, _Flags, _Index >, SparseInnerVectorSet< MatrixType, Size >, SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size >, SparseInnerVectorSet< SparseMatrix< _Scalar, _Options, _Index >, Size >, SparseDenseOuterProduct< Lhs, Rhs, Tr >, SparseMatrix< _Scalar, _Options, _Index >, SparseMatrixBase< Derived >, SparseSparseProduct< LhsNested, RhsNested >, SparseSelfAdjointView< MatrixType, UpLo >, SparseSymmetricPermutationProduct< MatrixType, UpLo >, SparseTriangularView< MatrixType, Mode >, SparseVector< _Scalar, _Options, _Index >, SparseView< MatrixType >, internal::BandMatrix< RealScalar, ColsAtCompileTime, ColsAtCompileTime, 1, 0 >, internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >, DiagonalBase< DiagonalWrapper< _DiagonalVectorType > >, DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > >, PermutationBase< PermutationWrapper< _IndicesType > >, PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >, TriangularBase< TriangularView< _MatrixType, _Mode > >, TriangularBase< SelfAdjointView< MatrixType, UpLo > >, SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, SparseMatrixBase< Transpose< MatrixType > >, SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseInnerVectorSet< SparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseInnerVectorSet< MatrixType, Size > >, SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, SparseMatrixBase< SparseView< MatrixType > >, and SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >.

template<typename Derived>
Index EigenBase< Derived >::size (  )  const [inline]
Returns:
the number of coefficients, which is rows()*cols().
See also:
rows(), cols(), SizeAtCompileTime.

Reimplemented in PermutationBase< Derived >, SparseMatrixBase< Derived >, PermutationBase< PermutationWrapper< _IndicesType > >, PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >, SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, SparseMatrixBase< Transpose< MatrixType > >, SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseInnerVectorSet< SparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseInnerVectorSet< MatrixType, Size > >, SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, SparseMatrixBase< SparseView< MatrixType > >, and SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >.

template<typename Derived>
template<typename Dest >
void EigenBase< Derived >::subTo ( Dest &  dst  )  const [inline]
The documentation for this struct was generated from the following file:
Generated on Thu Dec 1 2011 12:54:22 for HUMIM Tracker by  doxygen 1.7.1