Eigen::EigenBase< Derived > Class Template Reference

#include <EigenBase.h>

Inheritance diagram for Eigen::EigenBase< Derived >:

Public Types
typedef Eigen::Index	Index
	The interface type of indices. More...
typedef internal::traits< Derived >::StorageKind	StorageKind

Public Member Functions
template<typename Dest >
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const
template<typename Dest >
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const
EIGEN_DEVICE_FUNC Index	cols () const
EIGEN_DEVICE_FUNC Derived &	const_cast_derived () const
EIGEN_DEVICE_FUNC const Derived &	const_derived () const
EIGEN_DEVICE_FUNC Derived &	derived ()
EIGEN_DEVICE_FUNC const Derived &	derived () const
template<typename Dest >
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const
EIGEN_DEVICE_FUNC Index	rows () const
EIGEN_DEVICE_FUNC Index	size () const
template<typename Dest >
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const

Detailed Description

template<typename Derived>
class 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 28 of file EigenBase.h.

Member Typedef Documentation

Index

template<typename Derived>

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

The interface type of indices.

To change this, #define the preprocessor symbol EIGEN_DEFAULT_DENSE_INDEX_TYPE.

Deprecated:

Since Eigen 3.3, its usage is deprecated. Use Eigen::Index instead.

See also

StorageIndex, TopicPreprocessorDirectives.

Definition at line 37 of file EigenBase.h.

StorageKind

template<typename Derived>

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

Definition at line 40 of file EigenBase.h.

Member Function Documentation

addTo()

template<typename Derived>

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::addTo ( Dest &  dst ) const

inline

Definition at line 76 of file EigenBase.h.

applyThisOnTheLeft()

template<typename Derived>

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::applyThisOnTheLeft ( Dest &  dst ) const

inline

Definition at line 108 of file EigenBase.h.

applyThisOnTheRight()

template<typename Derived>

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::applyThisOnTheRight ( Dest &  dst ) const

inline

Definition at line 99 of file EigenBase.h.

cols()

template<typename Derived>

EIGEN_DEVICE_FUNC Index Eigen::EigenBase< Derived >::cols ( void  ) const

inline

Returns

the number of columns.

See also

rows(), ColsAtCompileTime

Definition at line 61 of file EigenBase.h.

const_cast_derived()

template<typename Derived>

EIGEN_DEVICE_FUNC Derived& Eigen::EigenBase< Derived >::const_cast_derived ( ) const

inline

Definition at line 50 of file EigenBase.h.

const_derived()

template<typename Derived>

EIGEN_DEVICE_FUNC const Derived& Eigen::EigenBase< Derived >::const_derived ( ) const

inline

Definition at line 53 of file EigenBase.h.

derived() [1/2]

template<typename Derived>

EIGEN_DEVICE_FUNC Derived& Eigen::EigenBase< Derived >::derived ( )

inline

Returns

a reference to the derived object

Definition at line 44 of file EigenBase.h.

derived() [2/2]

template<typename Derived>

EIGEN_DEVICE_FUNC const Derived& Eigen::EigenBase< Derived >::derived ( ) const

inline

Returns

a const reference to the derived object

Definition at line 47 of file EigenBase.h.

evalTo()

template<typename Derived>

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::evalTo ( Dest &  dst ) const

inline

Definition at line 70 of file EigenBase.h.

rows()

template<typename Derived>

EIGEN_DEVICE_FUNC Index Eigen::EigenBase< Derived >::rows ( void  ) const

inline

Returns

the number of rows.

See also

cols(), RowsAtCompileTime

Definition at line 58 of file EigenBase.h.

size()

template<typename Derived>

EIGEN_DEVICE_FUNC Index Eigen::EigenBase< Derived >::size ( ) const

inline

Returns

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

See also

rows(), cols(), SizeAtCompileTime.

Definition at line 65 of file EigenBase.h.

subTo()

template<typename Derived>

template<typename Dest >

EIGEN_DEVICE_FUNC void Eigen::EigenBase< Derived >::subTo ( Dest &  dst ) const

inline

Definition at line 88 of file EigenBase.h.

---

The documentation for this class was generated from the following file:

• EigenBase.h