Eigen::EigenBase< Derived > Struct Template Reference

#include <EigenBase.h>

Inheritance diagram for Eigen::EigenBase< Derived >:

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 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 26 of file EigenBase.h.

Member Function Documentation

template<typename Derived>

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

inline

Returns

the number of columns.

See also

rows(), ColsAtCompileTime

Definition at line 46 of file EigenBase.h.

{ return derived().cols(); }

template<typename Derived>

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

inline

Returns

a reference to the derived object

Definition at line 34 of file EigenBase.h.

{ return *static_cast<Derived*>(this); }

template<typename Derived>

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

inline

Returns

a const reference to the derived object

Definition at line 36 of file EigenBase.h.

{ return *static_cast<const Derived*>(this); }

template<typename Derived>

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

inline

Returns

the number of rows.

See also

cols(), RowsAtCompileTime

Definition at line 44 of file EigenBase.h.

{ return derived().rows(); }

template<typename Derived>

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

inline

Returns

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

See also

rows(), cols(), SizeAtCompileTime.

Definition at line 49 of file EigenBase.h.

{ return rows() * cols(); }

---

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

• C:/Users/Brig/Documents/ShapeWorksStudio/src/Surfworks/Eigen/src/Core/EigenBase.h