Public Member Functions

EigenBase< Derived > Struct Template Reference

Inheritance diagram for EigenBase< Derived >:

List of all members.

Public Member Functions

Index cols () const
const Derived & derived () const
Derived & derived ()
Index rows () const
Index size () 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:
The class hierarchy

Member Function Documentation

Index cols ( ) const [inline]
Returns:
the number of columns.
See also:
rows(), ColsAtCompileTime

Reimplemented in PermutationBase< Derived >, TriangularView< _MatrixType, _Mode >, SelfAdjointView< MatrixType, UpLo >, BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >, HouseholderSequence< VectorsType, CoeffsType, Side >, SparseMatrixBase< Derived >, SparseMatrix< _Scalar, _Options, _Index >, DynamicSparseMatrix< _Scalar, _Options, _Index >, MappedSparseMatrix< _Scalar, _Flags, _Index >, SparseVector< _Scalar, _Options, _Index >, SparseSelfAdjointView< MatrixType, UpLo >, PermutationBase< PermutationWrapper< _IndicesType > >, PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >, BandMatrix< RealScalar, ColsAtCompileTime, ColsAtCompileTime, 1, 0 >, BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >, SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, SparseMatrixBase< Transpose< MatrixType > >, SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, SparseMatrixBase< SparseMatrix< Scalar, _Options, _Index > >, SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, SparseMatrixBase< SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseInnerVectorSet< SparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, SparseMatrixBase< SparseInnerVectorSet< MatrixType, Size > >, SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, SparseMatrixBase< SparseMatrix< Scalar, _Options, Index > >, SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseView< MatrixType > >, SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >, SparseMatrix< Scalar, ColMajor, Index >, and SparseMatrix< Scalar >.

const Derived& derived ( ) const [inline]
Returns:
a const reference to the derived object
Derived& derived ( ) [inline]
Returns:
a reference to the derived object
Index rows ( ) const [inline]
Returns:
the number of rows.
See also:
cols(), RowsAtCompileTime

Reimplemented in PermutationBase< Derived >, TriangularView< _MatrixType, _Mode >, SelfAdjointView< MatrixType, UpLo >, BandMatrix< _Scalar, Rows, Cols, Supers, Subs, Options >, HouseholderSequence< VectorsType, CoeffsType, Side >, SparseMatrixBase< Derived >, SparseMatrix< _Scalar, _Options, _Index >, DynamicSparseMatrix< _Scalar, _Options, _Index >, MappedSparseMatrix< _Scalar, _Flags, _Index >, SparseVector< _Scalar, _Options, _Index >, SparseSelfAdjointView< MatrixType, UpLo >, PermutationBase< PermutationWrapper< _IndicesType > >, PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >, BandMatrix< RealScalar, ColsAtCompileTime, ColsAtCompileTime, 1, 0 >, BandMatrix< Scalar, Size, Size, Options &SelfAdjoint?0:1, 1, Options|RowMajor >, SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, SparseMatrixBase< Transpose< MatrixType > >, SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, SparseMatrixBase< SparseMatrix< Scalar, _Options, _Index > >, SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, SparseMatrixBase< SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseInnerVectorSet< SparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, SparseMatrixBase< SparseInnerVectorSet< MatrixType, Size > >, SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, SparseMatrixBase< SparseMatrix< Scalar, _Options, Index > >, SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseView< MatrixType > >, SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >, SparseMatrix< Scalar, ColMajor, Index >, and SparseMatrix< Scalar >.

Index size ( ) const [inline]
Returns:
the number of coefficients, which is rows()*cols().
See also:
rows(), cols(), SizeAtCompileTime.

Reimplemented in PermutationBase< Derived >, SparseMatrixBase< Derived >, PermutationBase< PermutationWrapper< _IndicesType > >, PermutationBase< Map< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType >, _PacketAccess > >, PermutationBase< PermutationMatrix< SizeAtCompileTime, MaxSizeAtCompileTime, IndexType > >, SparseMatrixBase< CwiseUnaryOp< UnaryOp, MatrixType > >, SparseMatrixBase< Transpose< MatrixType > >, SparseMatrixBase< SparseDiagonalProduct< Lhs, Rhs > >, SparseMatrixBase< SparseMatrix< Scalar, _Options, _Index > >, SparseMatrixBase< CwiseUnaryView< ViewOp, MatrixType > >, SparseMatrixBase< SparseInnerVectorSet< DynamicSparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseMatrix< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseInnerVectorSet< SparseMatrix< _Scalar, _Options >, Size > >, SparseMatrixBase< SparseDenseOuterProduct< Lhs, Rhs, Tr > >, SparseMatrixBase< SparseInnerVectorSet< MatrixType, Size > >, SparseMatrixBase< MappedSparseMatrix< _Scalar, _Flags, _Index > >, SparseMatrixBase< SparseMatrix< Scalar, _Options, Index > >, SparseMatrixBase< SparseSparseProduct< LhsNested, RhsNested > >, SparseMatrixBase< SparseTriangularView< MatrixType, Mode > >, SparseMatrixBase< SparseVector< _Scalar, _Options, _Index > >, SparseMatrixBase< SparseView< MatrixType > >, SparseMatrixBase< CwiseBinaryOp< BinaryOp, Lhs, Rhs > >, and SparseMatrixBase< DynamicSparseMatrix< _Scalar, _Options, _Index > >.


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