Eigen::EigenBase< Derived > Struct Template Reference

---

Detailed Description

template<typename Derived>
struct Eigen::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

Definition at line 41 of file Core.

Inheritance diagram for Eigen::EigenBase< Derived >:

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

---

Member Typedef Documentation

template<typename Derived>

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

Reimplemented in Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >, Eigen::DenseCoeffsBase< Derived, WriteAccessors >, Eigen::DenseCoeffsBase< Derived, DirectAccessors >, Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >, Eigen::TriangularBase< Derived >, Eigen::TriangularView< _MatrixType, _Mode >, Eigen::SelfAdjointView< MatrixType, UpLo >, Eigen::internal::BandMatrixBase< Derived >, Eigen::internal::BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >, Eigen::internal::BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options >, Eigen::internal::TridiagonalMatrix< Scalar, Size, Options >, Eigen::HouseholderSequence< VectorsType, CoeffsType, Side >, Eigen::SparseMatrixBase< Derived >, Eigen::SparseSelfAdjointView< MatrixType, UpLo >, Eigen::SparseSymmetricPermutationProduct< MatrixType, UpLo >, Eigen::SkylineMatrixBase< Derived >, Eigen::SkylineMatrixBase< Derived >, Eigen::TriangularBase< TriangularView< _MatrixType, _Mode > >, Eigen::TriangularBase< SelfAdjointView< MatrixType, UpLo > >, Eigen::internal::BandMatrixBase< BandMatrix< RealScalar, Rows, Cols, Supers, Subs, Options > >, Eigen::internal::BandMatrixBase< BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options > >, Eigen::internal::BandMatrixBase< BandMatrixWrapper< _CoefficientsType, _Rows, _Cols, _Supers, _Subs, _Options > >, Eigen::internal::BandMatrixBase< BandMatrix< Scalar, Rows, Cols, Supers, Subs, Options > >, Eigen::internal::BandMatrix< RealScalar, ColsAtCompileTime, ColsAtCompileTime, 1, 0 >, Eigen::internal::BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >, Eigen::SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, Eigen::SparseMatrixBase< Transpose< MatrixType > >, Eigen::SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, Eigen::SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, Eigen::SparseMatrixBase< SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size > >, Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, _Index > >, Eigen::SparseMatrixBase< SparseInnerVectorSet< SparseMatrix< _Scalar, _Options >, Size > >, Eigen::SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, Eigen::SparseMatrixBase< SparseInnerVectorSet< MatrixType, Size > >, Eigen::SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, Index > >, Eigen::SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, Eigen::SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, Eigen::SparseMatrixBase< SparseView< MatrixType > >, Eigen::SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, Eigen::SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >, Eigen::SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >, and Eigen::SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.

Definition at line 46 of file Core.

template<typename Derived>

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

Reimplemented in Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >, Eigen::DenseCoeffsBase< Derived, WriteAccessors >, Eigen::TriangularBase< Derived >, Eigen::TriangularView< _MatrixType, _Mode >, Eigen::SparseMatrixBase< Derived >, Eigen::SkylineMatrixBase< Derived >, Eigen::SkylineMatrixBase< Derived >, Eigen::TriangularBase< TriangularView< _MatrixType, _Mode > >, Eigen::TriangularBase< SelfAdjointView< MatrixType, UpLo > >, Eigen::SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, Eigen::SparseMatrixBase< Transpose< MatrixType > >, Eigen::SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, Eigen::SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, Eigen::SparseMatrixBase< SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size > >, Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, _Index > >, Eigen::SparseMatrixBase< SparseInnerVectorSet< SparseMatrix< _Scalar, _Options >, Size > >, Eigen::SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, Eigen::SparseMatrixBase< SparseInnerVectorSet< MatrixType, Size > >, Eigen::SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, Index > >, Eigen::SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, Eigen::SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, Eigen::SparseMatrixBase< SparseView< MatrixType > >, Eigen::SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, Eigen::SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >, Eigen::SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >, and Eigen::SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > >.

Definition at line 45 of file Core.

---

Member Function Documentation

template<typename Derived>

template<typename Dest >

void Eigen::EigenBase< Derived >::addTo

(

Dest &

dst

)

const [inline]

Definition at line 71 of file Core.

template<typename Derived>

template<typename Dest >

void Eigen::EigenBase< Derived >::applyThisOnTheLeft

(

Dest &

dst

)

const [inline]

Reimplemented in Eigen::HouseholderSequence< VectorsType, CoeffsType, Side >.

Definition at line 99 of file Core.

template<typename Derived>

template<typename Dest >

void Eigen::EigenBase< Derived >::applyThisOnTheRight

(

Dest &

dst

)

const [inline]

Reimplemented in Eigen::HouseholderSequence< VectorsType, CoeffsType, Side >.

Definition at line 91 of file Core.

template<typename Derived>

Index Eigen::EigenBase< Derived >::cols

(

)

const [inline]

Returns:

the number of columns.

See also:

rows(), ColsAtCompileTime

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

Definition at line 61 of file Core.

template<typename Derived>

Derived& Eigen::EigenBase< Derived >::const_cast_derived

(

)

const [inline]

Definition at line 53 of file Core.

template<typename Derived>

const Derived& Eigen::EigenBase< Derived >::const_derived

(

)

const [inline]

Definition at line 55 of file Core.

template<typename Derived>

const Derived& Eigen::EigenBase< Derived >::derived

(

)

const [inline]

Returns:

a const reference to the derived object

Definition at line 51 of file Core.

template<typename Derived>

Derived& Eigen::EigenBase< Derived >::derived

(

)

[inline]

Returns:

a reference to the derived object

Definition at line 49 of file Core.

Referenced by mrpt::math::loadVector().

template<typename Derived>

template<typename Dest >

void Eigen::EigenBase< Derived >::evalTo

(

Dest &

dst

)

const [inline]

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

Definition at line 67 of file Core.

template<typename Derived>

Index Eigen::EigenBase< Derived >::rows

(

)

const [inline]

Returns:

the number of rows.

See also:

cols(), RowsAtCompileTime

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

Definition at line 59 of file Core.

template<typename Derived>

Index Eigen::EigenBase< Derived >::size

(

)

const [inline]

Returns:

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

See also:

rows(), cols(), SizeAtCompileTime.

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

Definition at line 64 of file Core.

template<typename Derived>

template<typename Dest >

void Eigen::EigenBase< Derived >::subTo

(

Dest &

dst

)

const [inline]

Definition at line 81 of file Core.