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

Common base class for all classes T such that MatrixBase has an operator=(T) and a constructor MatrixBase(T). More...

#include <EigenBase.h>

Inheritance diagram for Eigen::EigenBase< Derived >:
Eigen::DiagonalBase< DiagonalMatrix< _Scalar, SizeAtCompileTime, MaxSizeAtCompileTime > > Eigen::DiagonalBase< DiagonalWrapper< _DiagonalVectorType > > Eigen::DenseCoeffsBase< Derived, ReadOnlyAccessors > Eigen::DiagonalBase< Derived > Eigen::internal::BandMatrixBase< Derived > Eigen::PermutationBase< Derived > Eigen::SkylineMatrixBase< Derived > Eigen::SolverBase< Derived > Eigen::SparseMatrixBase< Derived > Eigen::TriangularBase< Derived > Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >, _PacketAccess > > Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > > Eigen::PermutationBase< PermutationWrapper< _IndicesType > > Eigen::SkylineMatrixBase< SkylineMatrix< _Scalar, _Options > > Eigen::SolverBase< FullPivLU< _MatrixType > > Eigen::SolverBase< PartialPivLU< _MatrixType > > Eigen::SolverBase< PartialPivLU< Matrix< Scalar, Dynamic, Dynamic > > > Eigen::SparseMatrixBase< Block< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols, true > > Eigen::SparseMatrixBase< Block< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols, true > > Eigen::SparseMatrixBase< Block< SparseMatrixType, BlockRows, BlockCols, true > > Eigen::SparseMatrixBase< Block< XprType, BlockRows, BlockCols, InnerPanel > > Eigen::SparseMatrixBase< Block< XprType, BlockRows, BlockCols, true > > Eigen::SparseMatrixBase< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, _StorageIndex > > Eigen::SparseMatrixBase< BlockSparseMatrix< _Scalar, _BlockAtCompileTime, _Options, StorageIndex > > Eigen::SparseMatrixBase< BlockSparseMatrixT > Eigen::SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > > Eigen::SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _StorageIndex > > Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > > Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _StorageIndex > > Eigen::SparseMatrixBase< SparseView< MatrixType > > Eigen::SparseMatrixBase< Transpose< MatrixType > > Eigen::SparseMatrixBase< TriangularView< MatrixType, Mode > > Eigen::TriangularBase< SelfAdjointView< _MatrixType, UpLo > > Eigen::TriangularBase< TriangularView< _MatrixType, _Mode > >

Public Types

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

Public Member Functions

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

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, Preprocessor directives.

Member Function Documentation

§ cols()

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

§ derived() [1/2]

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

§ 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

§ rows()

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

§ 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.
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.12