W3cubDocs

/Eigen3

Eigen::EigenBase

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
The class hierarchy
typedef Eigen::Index Index
The interface type of indices. More...
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
Derived & derived ()
const Derived & derived () const
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT

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.

See also
StorageIndex, Preprocessor directives. DEPRECATED: Since Eigen 3.3, its usage is deprecated. Use Eigen::Index instead. Deprecation is not marked with a doxygen comment because there are too many existing usages to add the deprecation attribute.

cols()

template<typename Derived >
EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::cols ( void ) const
inline
Returns
the number of columns.
See also
rows(), ColsAtCompileTime

derived() [1/2]

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

derived() [2/2]

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

rows()

template<typename Derived >
EIGEN_CONSTEXPR Index Eigen::EigenBase< Derived >::rows ( void ) const
inline
Returns
the number of rows.
See also
cols(), RowsAtCompileTime

size()

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

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

© Eigen.
Licensed under the MPL2 License.
https://eigen.tuxfamily.org/dox/structEigen_1_1EigenBase.html