Eigen: Eigen::SparseView< MatrixType > Class Template Reference

Searching...

No Matches

#include <Eigen/src/SparseCore/SparseView.h>

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

MatrixType the 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_t< MatrixTypeNested > &	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< NRows, NCols >::Type	block (Index startRow, Index startCol)

const ConstFixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol) const
	This is the const version of block<>(Index, Index). *‍/.

FixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol, Index blockRows, Index blockCols)

const ConstFixedBlockXpr< NRows, NCols >::Type	block (Index startRow, Index startCol, Index blockRows, Index blockCols) const
	This is the const version of block<>(Index, Index, Index, Index).

FixedBlockXpr<...,... >::Type	block (Index startRow, Index startCol, NRowsType blockRows, NColsType blockCols)

const ConstFixedBlockXpr<...,... >::Type	block (Index startRow, Index startCol, NRowsType blockRows, NColsType blockCols) const
	This is the const version of block(Index,Index,NRowsType,NColsType)

FixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner ()

const ConstFixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner () const
	This is the const version of bottomLeftCorner<int, int>().

FixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner (Index cRows, Index cCols)

const ConstFixedBlockXpr< CRows, CCols >::Type	bottomLeftCorner (Index cRows, Index cCols) const
	This is the const version of bottomLeftCorner<int, int>(Index, Index).

FixedBlockXpr<...,... >::Type	bottomLeftCorner (NRowsType cRows, NColsType cCols)

ConstFixedBlockXpr<...,... >::Type	bottomLeftCorner (NRowsType cRows, NColsType cCols) const
	This is the const version of bottomLeftCorner(NRowsType, NColsType).

FixedBlockXpr< CRows, CCols >::Type	bottomRightCorner ()

const ConstFixedBlockXpr< CRows, CCols >::Type	bottomRightCorner () const
	This is the const version of bottomRightCorner<int, int>().

FixedBlockXpr< CRows, CCols >::Type	bottomRightCorner (Index cRows, Index cCols)

const ConstFixedBlockXpr< CRows, CCols >::Type	bottomRightCorner (Index cRows, Index cCols) const
	This is the const version of bottomRightCorner<int, int>(Index, Index).

FixedBlockXpr<...,... >::Type	bottomRightCorner (NRowsType cRows, NColsType cCols)

const ConstFixedBlockXpr<...,... >::Type	bottomRightCorner (NRowsType cRows, NColsType cCols) const
	This is the const version of bottomRightCorner(NRowsType, NColsType).

NRowsBlockXpr< N >::Type	bottomRows (Index n=N)

ConstNRowsBlockXpr< N >::Type	bottomRows (Index n=N) const
	This is the const version of bottomRows<int>().

NRowsBlockXpr<... >::Type	bottomRows (NRowsType n)

const ConstNRowsBlockXpr<... >::Type	bottomRows (NRowsType n) const
	This is the const version of bottomRows(NRowsType).

CastXpr< NewType >::Type	cast () const

ColXpr	col (Index i)

ConstColXpr	col (Index i) const
	This is the const version of col().

Index	cols () const

ConjugateReturnType	conjugate () const

std::conditional_t< Cond, ConjugateReturnType, const SparseView< MatrixType > & >	conjugateIf () const

const CwiseAbsReturnType	cwiseAbs () const

const CwiseAbs2ReturnType	cwiseAbs2 () const

const CwiseArgReturnType	cwiseArg () const

const CwiseCbrtReturnType	cwiseCbrt () const

const CwiseBinaryEqualReturnType< OtherDerived >	cwiseEqual (const Eigen::SparseMatrixBase< OtherDerived > &other) const

const CwiseScalarEqualReturnType	cwiseEqual (const Scalar &s) const

const CwiseBinaryGreaterReturnType< OtherDerived >	cwiseGreater (const Eigen::SparseMatrixBase< OtherDerived > &other) const

const CwiseScalarGreaterReturnType	cwiseGreater (const Scalar &s) const

const CwiseBinaryGreaterOrEqualReturnType< OtherDerived >	cwiseGreaterOrEqual (const Eigen::SparseMatrixBase< OtherDerived > &other) const

const CwiseScalarGreaterOrEqualReturnType	cwiseGreaterOrEqual (const Scalar &s) const

const CwiseInverseReturnType	cwiseInverse () const

const CwiseBinaryLessReturnType< OtherDerived >	cwiseLess (const Eigen::SparseMatrixBase< OtherDerived > &other) const

const CwiseScalarLessReturnType	cwiseLess (const Scalar &s) const

const CwiseBinaryLessOrEqualReturnType< OtherDerived >	cwiseLessOrEqual (const Eigen::SparseMatrixBase< OtherDerived > &other) const

const CwiseScalarLessOrEqualReturnType	cwiseLessOrEqual (const Scalar &s) const

const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar, NaNPropagation >, const SparseView< MatrixType >, const OtherDerived >	cwiseMax (const Eigen::SparseMatrixBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_max_op< Scalar, Scalar, NaNPropagation >, const SparseView< MatrixType >, const ConstantReturnType >	cwiseMax (const Scalar &other) const

const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar, NaNPropagation >, const SparseView< MatrixType >, const OtherDerived >	cwiseMin (const Eigen::SparseMatrixBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_min_op< Scalar, Scalar, NaNPropagation >, const SparseView< MatrixType >, const ConstantReturnType >	cwiseMin (const Scalar &other) const

const CwiseBinaryNotEqualReturnType< OtherDerived >	cwiseNotEqual (const Eigen::SparseMatrixBase< OtherDerived > &other) const

const CwiseScalarNotEqualReturnType	cwiseNotEqual (const Scalar &s) const

const CwiseBinaryOp< internal::scalar_product_op< SparseView< MatrixType > ::Scalar, OtherDerived ::Scalar >, const SparseView< MatrixType >, const OtherDerived >	cwiseProduct (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 CwiseSquareReturnType	cwiseSquare () const

const internal::eval< SparseView< MatrixType > >::type	eval () const

FixedSegmentReturnType< N >::Type	head (Index n=N)

ConstFixedSegmentReturnType< N >::Type	head (Index n=N) const
	This is the const version of head<int>().

FixedSegmentReturnType<... >::Type	head (NType n)

const ConstFixedSegmentReturnType<... >::Type	head (NType n) const
	This is the const version of head(NType).

NonConstImagReturnType	imag ()

const ImagReturnType	imag () const

Index	innerSize () const

InnerVectorReturnType	innerVector (Index outer)

const ConstInnerVectorReturnType	innerVector (Index outer) const

InnerVectorsReturnType	innerVectors (Index outerStart, Index outerSize)

const ConstInnerVectorsReturnType	innerVectors (Index outerStart, Index outerSize) const

bool	isVector () const

NColsBlockXpr< N >::Type	leftCols (Index n=N)

ConstNColsBlockXpr< N >::Type	leftCols (Index n=N) const
	This is the const version of leftCols<int>().

NColsBlockXpr<... >::Type	leftCols (NColsType n)

const ConstNColsBlockXpr<... >::Type	leftCols (NColsType n) const
	This is the const version of leftCols(NColsType).

NColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N)

ConstNColsBlockXpr< N >::Type	middleCols (Index startCol, Index n=N) const
	This is the const version of middleCols<int>().

NColsBlockXpr<... >::Type	middleCols (Index startCol, NColsType numCols)

const ConstNColsBlockXpr<... >::Type	middleCols (Index startCol, NColsType numCols) const
	This is the const version of middleCols(Index,NColsType).

NRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N)

ConstNRowsBlockXpr< N >::Type	middleRows (Index startRow, Index n=N) const
	This is the const version of middleRows<int>().

NRowsBlockXpr<... >::Type	middleRows (Index startRow, NRowsType n)

const ConstNRowsBlockXpr<... >::Type	middleRows (Index startRow, NRowsType n) const
	This is the const version of middleRows(Index,NRowsType).

const CwiseBinaryOp< internal::scalar_bitwise_and_op< Scalar >, const SparseView< MatrixType >, const OtherDerived >	operator& (const Eigen::SparseMatrixBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_boolean_and_op< Scalar >, const SparseView< MatrixType >, const OtherDerived >	operator&& (const Eigen::SparseMatrixBase< OtherDerived > &other) const

const Product< SparseView< MatrixType >, OtherDerived, AliasFreeProduct >	operator* (const SparseMatrixBase< OtherDerived > &other) const

const CwiseBinaryOp< sum< Scalar >, const SparseView< MatrixType >, const OtherDerived >	operator+ (const Eigen::SparseMatrixBase< OtherDerived > &other) const

const NegativeReturnType	operator- () const

const CwiseBinaryOp< difference< Scalar >, const SparseView< MatrixType >, const OtherDerived >	operator- (const Eigen::SparseMatrixBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_bitwise_xor_op< Scalar >, const SparseView< MatrixType >, const OtherDerived >	operator^ (const Eigen::SparseMatrixBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_bitwise_or_op< Scalar >, const SparseView< MatrixType >, const OtherDerived >	operator\| (const Eigen::SparseMatrixBase< OtherDerived > &other) const

const CwiseBinaryOp< internal::scalar_boolean_or_op< Scalar >, 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

NonConstRealReturnType	real ()

RealReturnType	real () const

NColsBlockXpr< N >::Type	rightCols (Index n=N)

ConstNColsBlockXpr< N >::Type	rightCols (Index n=N) const
	This is the const version of rightCols<int>().

NColsBlockXpr<... >::Type	rightCols (NColsType n)

const ConstNColsBlockXpr<... >::Type	rightCols (NColsType n) const
	This is the const version of rightCols(NColsType).

RowXpr	row (Index i)

ConstRowXpr	row (Index i) const
	This is the const version of row(). *‍/.

Index	rows () const

FixedSegmentReturnType< N >::Type	segment (Index start, Index n=N)

ConstFixedSegmentReturnType< N >::Type	segment (Index start, Index n=N) const
	This is the const version of segment<int>(Index).

FixedSegmentReturnType<... >::Type	segment (Index start, NType n)

const ConstFixedSegmentReturnType<... >::Type	segment (Index start, NType n) const
	This is the const version of segment(Index,NType).

Index	size () const

std::conditional_t< Direction==Vertical, ColXpr, RowXpr >	subVector (Index i)

std::conditional_t< Direction==Vertical, ConstColXpr, ConstRowXpr >	subVector (Index i) const

EIGEN_CONSTEXPR Index	subVectors () const

FixedSegmentReturnType< N >::Type	tail (Index n=N)

ConstFixedSegmentReturnType< N >::Type	tail (Index n=N) const
	This is the const version of tail<int>.

FixedSegmentReturnType<... >::Type	tail (NType n)

const ConstFixedSegmentReturnType<... >::Type	tail (NType n) const
	This is the const version of tail(Index).

FixedBlockXpr< CRows, CCols >::Type	topLeftCorner ()

const ConstFixedBlockXpr< CRows, CCols >::Type	topLeftCorner () const
	This is the const version of topLeftCorner<int, int>().

FixedBlockXpr< CRows, CCols >::Type	topLeftCorner (Index cRows, Index cCols)

const ConstFixedBlockXpr< CRows, CCols >::Type	topLeftCorner (Index cRows, Index cCols) const
	This is the const version of topLeftCorner<int, int>(Index, Index).

FixedBlockXpr<...,... >::Type	topLeftCorner (NRowsType cRows, NColsType cCols)

const ConstFixedBlockXpr<...,... >::Type	topLeftCorner (NRowsType cRows, NColsType cCols) const
	This is the const version of topLeftCorner(Index, Index).

FixedBlockXpr< CRows, CCols >::Type	topRightCorner ()

const ConstFixedBlockXpr< CRows, CCols >::Type	topRightCorner () const
	This is the const version of topRightCorner<int, int>().

FixedBlockXpr< CRows, CCols >::Type	topRightCorner (Index cRows, Index cCols)

const ConstFixedBlockXpr< CRows, CCols >::Type	topRightCorner (Index cRows, Index cCols) const
	This is the const version of topRightCorner<int, int>(Index, Index).

FixedBlockXpr<...,... >::Type	topRightCorner (NRowsType cRows, NColsType cCols)

const ConstFixedBlockXpr<...,... >::Type	topRightCorner (NRowsType cRows, NColsType cCols) const
	This is the const version of topRightCorner(NRowsType, NColsType).

NRowsBlockXpr< N >::Type	topRows (Index n=N)

ConstNRowsBlockXpr< N >::Type	topRows (Index n=N) const
	This is the const version of topRows<int>().

NRowsBlockXpr<... >::Type	topRows (NRowsType n)

const ConstNRowsBlockXpr<... >::Type	topRows (NRowsType n) const
	This is the const version of topRows(NRowsType).

SparseSymmetricPermutationProduct< SparseView< MatrixType >, Upper\|Lower >	twistedBy (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.

CwiseUnaryView< CustomViewOp, SparseView< MatrixType > >	unaryViewExpr (const CustomViewOp &func=CustomViewOp())

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

constexpr SparseView< MatrixType > &	derived ()

constexpr const SparseView< MatrixType > &	derived () const

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 NumTraits< Scalar >::Real	RealScalar

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_t< MatrixTypeNested > & Eigen::SparseView< MatrixType >::nestedExpression ( ) const

inline

Returns: the nested expression

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

/usr/local/google/home/cantonios/dev/eigen/Eigen/src/Core/util/ForwardDeclarations.h
/usr/local/google/home/cantonios/dev/eigen/Eigen/src/SparseCore/SparseUtil.h
/usr/local/google/home/cantonios/dev/eigen/Eigen/src/SparseCore/SparseView.h

Detailed Description

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ nestedExpression()