Eigen  3.3.3
Eigen::EigenBase< Derived > Class Template Reference

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
+ Inheritance diagram for Eigen::EigenBase< Derived >:

List of all members.

Public Types

typedef Eigen::Index Index
 The interface type of indices.

Public Member Functions

Index cols () const
Derived & derived ()
const Derived & derived () const
Index rows () const
Index size () const

Member Typedef Documentation

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

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

Reimplemented in Eigen::FullPivLU< _MatrixType >, Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >, Eigen::PartialPivLU< _MatrixType >, Eigen::HouseholderSequence< VectorsType, CoeffsType, Side >, Eigen::SparseMatrixBase< Derived >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, int > >, Eigen::SparseMatrixBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >, Eigen::SparseMatrixBase< TriangularView< MatrixType, Mode > >, Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _StorageIndex > >, Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, _StorageIndex > >, Eigen::SparseMatrixBase< Block< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols, true > >, Eigen::SparseMatrixBase< Block< XprType, BlockRows, BlockCols, true > >, Eigen::SparseMatrixBase< Transpose< MatrixType > >, Eigen::SparseMatrixBase< Block< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols, true > >, Eigen::SparseMatrixBase< Block< XprType, BlockRows, BlockCols, InnerPanel > >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, StorageIndex > >, Eigen::SparseMatrixBase< SparseView< MatrixType > >, Eigen::SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >, Eigen::SparseMatrix< Scalar >, Eigen::SparseMatrix< Scalar, ColMajor, StorageIndex >, Eigen::SparseMatrix< Scalar, ColMajor, int >, Eigen::SparseMatrix< Scalar, RowMajor, StorageIndex >, Eigen::PermutationBase< Derived >, Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex > >, Eigen::PermutationBase< PermutationWrapper< _IndicesType > >, Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >, _PacketAccess > >, Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >, Eigen::SparseVector< _Scalar, _Options, _StorageIndex >, Eigen::SparseMapBase< Derived, ReadOnlyAccessors >, Eigen::SelfAdjointView< _MatrixType, UpLo >, Eigen::SparseSelfAdjointView< MatrixType, _Mode >, Eigen::TriangularBase< Derived >, Eigen::TriangularBase< TriangularView< _MatrixType, _Mode > >, Eigen::TriangularBase< SelfAdjointView< _MatrixType, UpLo > >, and Eigen::SparseView< MatrixType >.

template<typename Derived>
Derived& Eigen::EigenBase< Derived >::derived ( ) [inline]
Returns:
a reference to the derived object
template<typename Derived>
const Derived& Eigen::EigenBase< Derived >::derived ( ) const [inline]
Returns:
a const reference to the derived object
template<typename Derived>
Index Eigen::EigenBase< Derived >::rows ( void  ) const [inline]
Returns:
the number of rows.
See also:
cols(), RowsAtCompileTime

Reimplemented in Eigen::FullPivLU< _MatrixType >, Eigen::BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, Sparse >, Eigen::PartialPivLU< _MatrixType >, Eigen::HouseholderSequence< VectorsType, CoeffsType, Side >, Eigen::SparseMatrixBase< Derived >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, int > >, Eigen::SparseMatrixBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >, Eigen::SparseMatrixBase< TriangularView< MatrixType, Mode > >, Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _StorageIndex > >, Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, _StorageIndex > >, Eigen::SparseMatrixBase< Block< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols, true > >, Eigen::SparseMatrixBase< Block< XprType, BlockRows, BlockCols, true > >, Eigen::SparseMatrixBase< Transpose< MatrixType > >, Eigen::SparseMatrixBase< Block< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols, true > >, Eigen::SparseMatrixBase< Block< XprType, BlockRows, BlockCols, InnerPanel > >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, StorageIndex > >, Eigen::SparseMatrixBase< SparseView< MatrixType > >, Eigen::SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, Eigen::SparseMatrix< _Scalar, _Options, _StorageIndex >, Eigen::SparseMatrix< Scalar >, Eigen::SparseMatrix< Scalar, ColMajor, StorageIndex >, Eigen::SparseMatrix< Scalar, ColMajor, int >, Eigen::SparseMatrix< Scalar, RowMajor, StorageIndex >, Eigen::PermutationBase< Derived >, Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex > >, Eigen::PermutationBase< PermutationWrapper< _IndicesType > >, Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >, _PacketAccess > >, Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >, Eigen::SparseVector< _Scalar, _Options, _StorageIndex >, Eigen::SparseMapBase< Derived, ReadOnlyAccessors >, Eigen::SelfAdjointView< _MatrixType, UpLo >, Eigen::SparseSelfAdjointView< MatrixType, _Mode >, Eigen::TriangularBase< Derived >, Eigen::TriangularBase< TriangularView< _MatrixType, _Mode > >, Eigen::TriangularBase< SelfAdjointView< _MatrixType, UpLo > >, and Eigen::SparseView< MatrixType >.

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

Reimplemented in Eigen::SparseMatrixBase< Derived >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, int > >, Eigen::SparseMatrixBase< Block< SparseMatrixType, BlockRows, BlockCols, true > >, Eigen::SparseMatrixBase< TriangularView< MatrixType, Mode > >, Eigen::SparseMatrixBase< SparseVector< _Scalar, _Options, _StorageIndex > >, Eigen::SparseMatrixBase< SparseMatrix< _Scalar, _Options, _StorageIndex > >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, _StorageIndex > >, Eigen::SparseMatrixBase< Block< SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols, true > >, Eigen::SparseMatrixBase< Block< XprType, BlockRows, BlockCols, true > >, Eigen::SparseMatrixBase< Transpose< MatrixType > >, Eigen::SparseMatrixBase< Block< const SparseMatrix< _Scalar, _Options, _StorageIndex >, BlockRows, BlockCols, true > >, Eigen::SparseMatrixBase< Block< XprType, BlockRows, BlockCols, InnerPanel > >, Eigen::SparseMatrixBase< SparseMatrix< Scalar, _Options, StorageIndex > >, Eigen::SparseMatrixBase< SparseView< MatrixType > >, Eigen::SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, Eigen::PermutationBase< Derived >, Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, StorageIndex > >, Eigen::PermutationBase< PermutationWrapper< _IndicesType > >, Eigen::PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex >, _PacketAccess > >, and Eigen::PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, _StorageIndex > >.


The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Enumerations Enumerator Friends