Please, help us to better know about our user community by answering the following short survey: https://forms.gle/wpyrxWi18ox9Z5ae9
Eigen  3.4.0
Loading...
Searching...
No Matches
Eigen::SparseView< MatrixType > Class Template Reference

Detailed Description

template<typename MatrixType>
class Eigen::SparseView< MatrixType >

Expression of a dense or sparse matrix with zero or too small values removed.

Template Parameters
MatrixTypethe type of the object of which we are removing the small entries

This class represents an expression of a given dense or sparse matrix with entries smaller than reference * epsilon are removed. It is the return type of MatrixBase::sparseView() and SparseMatrixBase::pruned() and most of the time this is the only way it is used.

See also
MatrixBase::sparseView(), SparseMatrixBase::pruned()
Inheritance diagram for Eigen::SparseView< MatrixType >:

Public Member Functions

const internal::remove_all< MatrixTypeNested >::type & nestedExpression () const
Public Member Functions inherited from Eigen::SparseMatrixBase< SparseView< MatrixType > >
const CwiseBinaryOp< CustomBinaryOp, const SparseView< MatrixType >, const OtherDerived > binaryExpr (const Eigen::SparseMatrixBase< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const
FixedBlockXpr<...,... >::Type block (Index startRow, Index startCol, NRowsType blockRows, NColsType blockCols)
FixedBlockXpr<...,... >::Type bottomLeftCorner (NRowsType cRows, NColsType cCols)
FixedBlockXpr<...,... >::Type bottomRightCorner (NRowsType cRows, NColsType cCols)
NRowsBlockXpr<... >::Type bottomRows (NRowsType n)
CastXpr< NewType >::Type cast () const
ColXpr col (Index i)
Index cols () const
ConjugateReturnType conjugate () const
internal::conditional< Cond, ConjugateReturnType, constDerived & >::type conjugateIf () const
const CwiseAbsReturnType cwiseAbs () const
const CwiseAbs2ReturnType cwiseAbs2 () const
const CwiseArgReturnType cwiseArg () const
const CwiseBinaryOp< numext::equal_to< Scalar >, const SparseView< MatrixType >, const OtherDerived > cwiseEqual (const Eigen::SparseMatrixBase< OtherDerived > &other) const
const CwiseInverseReturnType cwiseInverse () const
const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar >, const SparseView< MatrixType >, const OtherDerived > cwiseMax (const Eigen::SparseMatrixBase< OtherDerived > &other) const
const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar >, const SparseView< MatrixType >, const OtherDerived > cwiseMin (const Eigen::SparseMatrixBase< OtherDerived > &other) const
const CwiseBinaryOp< numext::not_equal_to< Scalar >, const SparseView< MatrixType >, const OtherDerived > cwiseNotEqual (const Eigen::SparseMatrixBase< OtherDerived > &other) const
const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const SparseView< MatrixType >, const OtherDerived > cwiseQuotient (const Eigen::SparseMatrixBase< OtherDerived > &other) const
const CwiseSignReturnType cwiseSign () const
const CwiseSqrtReturnType cwiseSqrt () const
const internal::eval< SparseView< MatrixType > >::type eval () const
FixedSegmentReturnType<... >::Type head (NType n)
const ImagReturnType imag () const
Index innerSize () const
InnerVectorReturnType innerVector (Index outer)
InnerVectorsReturnType innerVectors (Index outerStart, Index outerSize)
bool isVector () const
NColsBlockXpr<... >::Type leftCols (NColsType n)
NColsBlockXpr<... >::Type middleCols (Index startCol, NColsType numCols)
NRowsBlockXpr<... >::Type middleRows (Index startRow, NRowsType n)
const CwiseBinaryOp< internal::scalar_boolean_and_op, const SparseView< MatrixType >, const OtherDerived > operator&& (const Eigen::SparseMatrixBase< OtherDerived > &other) const
const CwiseBinaryOp< internal::scalar_product_op< Scalar, T >, SparseView< MatrixType >, Constant< T > > operator* (const T &scalar) const
const CwiseBinaryOp< sum< Scalar >, const SparseView< MatrixType >, const OtherDerived > operator+ (const Eigen::SparseMatrixBase< OtherDerived > &other) const
const NegativeReturnType operator- () const
const CwiseBinaryOp< internal::scalar_quotient_op< Scalar, T >, SparseView< MatrixType >, Constant< T > > operator/ (const T &scalar) const
const CwiseBinaryOp< internal::scalar_boolean_or_op, const SparseView< MatrixType >, const OtherDerived > operator|| (const Eigen::SparseMatrixBase< OtherDerived > &other) const
Index outerSize () const
const SparseView< Derived > pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
RealReturnType real () const
NColsBlockXpr<... >::Type rightCols (NColsType n)
RowXpr row (Index i)
Index rows () const
FixedSegmentReturnType<... >::Type segment (Index start, NType n)
Index size () const
internal::conditional< Direction==Vertical, ColXpr, RowXpr >::type subVector (Index i)
EIGEN_CONSTEXPR Index subVectors () const
FixedSegmentReturnType<... >::Type tail (NType n)
FixedBlockXpr<...,... >::Type topLeftCorner (NRowsType cRows, NColsType cCols)
FixedBlockXpr<...,... >::Type topRightCorner (NRowsType cRows, NColsType cCols)
NRowsBlockXpr<... >::Type topRows (NRowsType n)
SparseSymmetricPermutationProduct< SparseView< MatrixType >, Upper|LowertwistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
const CwiseUnaryOp< CustomUnaryOp, const SparseView< MatrixType > > unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
 Apply a unary operator coefficient-wise.
const CwiseUnaryView< CustomViewOp, const SparseView< MatrixType > > unaryViewExpr (const CustomViewOp &func=CustomViewOp()) const
Public Member Functions inherited from Eigen::EigenBase< SparseView< MatrixType > >
EIGEN_CONSTEXPR Index cols () const EIGEN_NOEXCEPT
SparseView< MatrixType > & derived ()
EIGEN_CONSTEXPR Index rows () const EIGEN_NOEXCEPT
EIGEN_CONSTEXPR Index size () const EIGEN_NOEXCEPT

Additional Inherited Members

Public Types inherited from Eigen::SparseMatrixBase< SparseView< MatrixType > >
typedef internal::traits< SparseView< MatrixType > >::StorageIndex StorageIndex
typedef Scalar value_type
Public Types inherited from Eigen::EigenBase< SparseView< MatrixType > >
typedef Eigen::Index Index
 The interface type of indices.

Member Function Documentation

◆ nestedExpression()

template<typename MatrixType>
const internal::remove_all< MatrixTypeNested >::type & Eigen::SparseView< MatrixType >::nestedExpression ( ) const
inline
Returns
the nested expression

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