Eigen::EigenBase Struct Reference

---

Detailed Description

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

Inheritance diagram for Eigen::EigenBase:

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

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

Reimplemented in Eigen::DenseCoeffsBase< Derived, DirectWriteAccessors >, Eigen::DenseCoeffsBase< Derived, DirectAccessors >, Eigen::SparseSymmetricPermutationProduct, Eigen::DenseCoeffsBase< Derived, WriteAccessors >, Eigen::HouseholderSequence, Eigen::SparseSelfAdjointView, Eigen::TriangularBase, Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors >, Eigen::internal::BandMatrixBase, and Eigen::SparseMatrixBase.

Definition at line 46 of file Core.

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

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

Definition at line 45 of file Core.

---

Member Function Documentation

template<typename Dest >

void Eigen::EigenBase::addTo

(

Dest &

dst

)

const [inline]

Definition at line 71 of file Core.

template<typename Dest >

void Eigen::EigenBase::applyThisOnTheLeft

(

Dest &

dst

)

const [inline]

Reimplemented in Eigen::HouseholderSequence.

Definition at line 99 of file Core.

template<typename Dest >

void Eigen::EigenBase::applyThisOnTheRight

(

Dest &

dst

)

const [inline]

Reimplemented in Eigen::HouseholderSequence.

Definition at line 91 of file Core.

Index Eigen::EigenBase::cols

(

)

const [inline]

Returns:

the number of columns.

See also:

rows(), ColsAtCompileTime

Reimplemented in Eigen::Transpose< PermutationBase< Derived > >, Eigen::SparseSymmetricPermutationProduct, Eigen::HouseholderSequence, Eigen::SparseMatrixBase, Eigen::PermutationBase, Eigen::SparseSelfAdjointView, and Eigen::TriangularBase.

Definition at line 61 of file Core.

Derived& Eigen::EigenBase::const_cast_derived

(

)

const [inline]

Definition at line 53 of file Core.

const Derived& Eigen::EigenBase::const_derived

(

)

const [inline]

Definition at line 55 of file Core.

Derived& Eigen::EigenBase::derived

(

)

[inline]

Returns:

a reference to the derived object

Definition at line 49 of file Core.

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

const Derived& Eigen::EigenBase::derived

(

)

const [inline]

Returns:

a const reference to the derived object

Definition at line 51 of file Core.

template<typename Dest >

void Eigen::EigenBase::evalTo

(

Dest &

dst

)

const [inline]

Reimplemented in Eigen::internal::BandMatrixBase.

Definition at line 67 of file Core.

Index Eigen::EigenBase::rows

(

)

const [inline]

Returns:

the number of rows.

See also:

cols(), RowsAtCompileTime

Reimplemented in Eigen::Transpose< PermutationBase< Derived > >, Eigen::SparseSymmetricPermutationProduct, Eigen::HouseholderSequence, Eigen::SparseMatrixBase, Eigen::PermutationBase, Eigen::SparseSelfAdjointView, and Eigen::TriangularBase.

Definition at line 59 of file Core.

Index Eigen::EigenBase::size

(

)

const [inline]

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.

template<typename Dest >

void Eigen::EigenBase::subTo

(

Dest &

dst

)

const [inline]

Definition at line 81 of file Core.