Eigen::EigenBase< Derived > Class Template Reference

#include <EigenBase.h>

Inherited by 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< ColPivHouseholderQR< _MatrixType > >, Eigen::SolverBase< ColPivHouseholderQR< MatrixType > >, Eigen::SolverBase< ColPivHouseholderQR< TransposeTypeWithSameStorageOrder > >, Eigen::SolverBase< CompleteOrthogonalDecomposition< _MatrixType > >, Eigen::SolverBase< FullPivHouseholderQR< _MatrixType > >, Eigen::SolverBase< FullPivHouseholderQR< MatrixType > >, Eigen::SolverBase< FullPivHouseholderQR< TransposeTypeWithSameStorageOrder > >, Eigen::SolverBase< FullPivLU< _MatrixType > >, Eigen::SolverBase< HouseholderQR< _MatrixType > >, Eigen::SolverBase< HouseholderQR< MatrixType > >, Eigen::SolverBase< HouseholderQR< TransposeTypeWithSameStorageOrder > >, Eigen::SolverBase< LDLT< _MatrixType, _UpLo > >, Eigen::SolverBase< LLT< _MatrixType, _UpLo > >, Eigen::SolverBase< PartialPivLU< _MatrixType > >, Eigen::SolverBase< PartialPivLU< ComplexMatrix > >, Eigen::SolverBase< PartialPivLU< Matrix< Scalar, Dynamic, Dynamic > > >, Eigen::SolverBase< PartialPivLU< Matrix< Scalar, Eigen::Dynamic, Eigen::Dynamic > > >, Eigen::SolverBase< SVDBase< BDCSVD< _MatrixType > > >, Eigen::SolverBase< SVDBase< Derived > >, Eigen::SolverBase< SVDBase< JacobiSVD< _MatrixType, QRPreconditioner > > >, 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, _StorageIndex > >, Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _StorageIndex > >, Eigen::SparseMatrixBase< SparseVector< double, _Options, _StorageIndex > >, Eigen::SparseMatrixBase< SparseView< MatrixType > >, Eigen::SparseMatrixBase< Transpose< MatrixType > >, Eigen::SparseMatrixBase< TriangularView< MatrixType, Mode > >, Eigen::TriangularBase< SelfAdjointView< _MatrixType, UpLo > >, and 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
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 EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
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 EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
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

The class hierarchy

Definition at line 29 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.

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.

Definition at line 39 of file EigenBase.h.

StorageKind

template<typename Derived>

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

Definition at line 42 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 78 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 110 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 101 of file EigenBase.h.

cols()

template<typename Derived>

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

inline

Returns

the number of columns.

See also

rows(), ColsAtCompileTime

Definition at line 63 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 52 of file EigenBase.h.

const_derived()

template<typename Derived>

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

inline

Definition at line 55 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 46 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 49 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 72 of file EigenBase.h.

rows()

template<typename Derived>

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

inline

Returns

the number of rows.

See also

cols(), RowsAtCompileTime

Definition at line 60 of file EigenBase.h.

size()

template<typename Derived>

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

inline

Returns

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

See also

rows(), cols(), SizeAtCompileTime.

Definition at line 67 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 90 of file EigenBase.h.

---

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

• EigenBase.h