Public Types | Public Member Functions | List of all members
Eigen::EigenBase< Derived > Struct Template Reference

#include <EigenBase.h>

Inheritance diagram for Eigen::EigenBase< Derived >:
Inheritance graph
[legend]

Public Types

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

Public Member Functions

template<typename Dest >
void addTo (Dest &dst) const
 
template<typename Dest >
void applyThisOnTheLeft (Dest &dst) const
 
template<typename Dest >
void applyThisOnTheRight (Dest &dst) const
 
Index cols () const
 
Derived & const_cast_derived () const
 
const Derived & const_derived () const
 
Derived & derived ()
 
const Derived & derived () const
 
template<typename Dest >
void evalTo (Dest &dst) const
 
Index rows () const
 
Index size () const
 
template<typename Dest >
void subTo (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 Typedef Documentation

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

Definition at line 31 of file EigenBase.h.

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

Definition at line 30 of file EigenBase.h.

Member Function Documentation

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

Definition at line 56 of file EigenBase.h.

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

Definition at line 84 of file EigenBase.h.

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

Definition at line 76 of file EigenBase.h.

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.

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

Definition at line 38 of file EigenBase.h.

template<typename Derived>
const Derived& Eigen::EigenBase< Derived >::const_derived ( ) const
inline

Definition at line 40 of file EigenBase.h.

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

Definition at line 34 of file EigenBase.h.

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.

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

Definition at line 52 of file EigenBase.h.

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.

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

Definition at line 49 of file EigenBase.h.

template<typename Derived>
template<typename Dest >
void Eigen::EigenBase< Derived >::subTo ( Dest &  dst) const
inline

Definition at line 66 of file EigenBase.h.


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


acado
Author(s): Milan Vukov, Rien Quirynen
autogenerated on Mon Jun 10 2019 12:35:33