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 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 > >
constexpr const CwiseBinaryOp< CustomBinaryOp, const SparseView< MatrixType >, const OtherDerived >	binaryExpr (const Eigen::SparseMatrixBase< OtherDerived > &other, const CustomBinaryOp &func=CustomBinaryOp()) const

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

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

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

constexpr 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).

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

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

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

constexpr 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).

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

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

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

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

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

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

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

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

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

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

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

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

constexpr CastXpr< NewType >::Type	cast () const

constexpr ColXpr	col (Index i)

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

Index	cols () const

constexpr ConjugateReturnType	conjugate () const

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

const CwiseUnaryOp< internal::scalar_abs_op< Scalar >, const SparseView< MatrixType > >	cwiseAbs () const

const CwiseUnaryOp< internal::scalar_abs2_op< Scalar >, const SparseView< MatrixType > >	cwiseAbs2 () const

const CwiseUnaryOp< internal::scalar_arg_op< Scalar >, const SparseView< MatrixType > >	cwiseArg () const

const CwiseUnaryOp< internal::scalar_cbrt_op< Scalar >, const SparseView< MatrixType > >	cwiseCbrt () const

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

constexpr const CwiseScalarEqualReturnType	cwiseEqual (const Scalar &s) const

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

constexpr const CwiseScalarGreaterReturnType	cwiseGreater (const Scalar &s) const

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

constexpr const CwiseScalarGreaterOrEqualReturnType	cwiseGreaterOrEqual (const Scalar &s) const

const CwiseUnaryOp< internal::scalar_inverse_op< Scalar >, const SparseView< MatrixType > >	cwiseInverse () const

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

constexpr const CwiseScalarLessReturnType	cwiseLess (const Scalar &s) const

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

constexpr const CwiseScalarLessOrEqualReturnType	cwiseLessOrEqual (const Scalar &s) const

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

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

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

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

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

constexpr const CwiseScalarNotEqualReturnType	cwiseNotEqual (const Scalar &s) const

constexpr const CwiseBinaryOp< internal::scalar_product_op< SparseView< MatrixType > ::Scalar, OtherDerived ::Scalar >, const SparseView< MatrixType >, const OtherDerived >	cwiseProduct (const Eigen::SparseMatrixBase< OtherDerived > &other) const

constexpr const CwiseBinaryOp< internal::scalar_quotient_op< Scalar >, const SparseView< MatrixType >, const OtherDerived >	cwiseQuotient (const Eigen::SparseMatrixBase< OtherDerived > &other) const

const CwiseUnaryOp< internal::scalar_sign_op< Scalar >, const SparseView< MatrixType > >	cwiseSign () const

const CwiseUnaryOp< internal::scalar_sqrt_op< Scalar >, const SparseView< MatrixType > >	cwiseSqrt () const

const CwiseUnaryOp< internal::scalar_square_op< Scalar >, const SparseView< MatrixType > >	cwiseSquare () const

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

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

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

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

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

constexpr NonConstImagReturnType	imag ()

constexpr const ImagReturnType	imag () const

Index	innerSize () const

constexpr InnerVectorReturnType	innerVector (Index outer)

constexpr const ConstInnerVectorReturnType	innerVector (Index outer) const

constexpr InnerVectorsReturnType	innerVectors (Index outerStart, Index outerSize)

constexpr const ConstInnerVectorsReturnType	innerVectors (Index outerStart, Index outerSize) const

bool	isVector () const

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

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

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

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

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

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

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

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

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

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

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

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

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

constexpr 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< internal::scalar_sum_op< Scalar, typename OtherDerived::Scalar >, const SparseView< MatrixType >, const OtherDerived >	operator+ (const Eigen::SparseMatrixBase< OtherDerived > &other) const

constexpr const NegativeReturnType	operator- () const

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

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

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

constexpr 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

constexpr NonConstRealReturnType	real ()

constexpr RealReturnType	real () const

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

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

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

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

constexpr RowXpr	row (Index i)

constexpr ConstRowXpr	row (Index i) const
	This is the const version of row().

Index	rows () const

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

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

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

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

Index	size () const

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

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

constexpr Index	subVectors () const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

constexpr 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

constexpr const CwiseUnaryOp< CustomUnaryOp, const SparseView< MatrixType > >	unaryExpr (const CustomUnaryOp &func=CustomUnaryOp()) const
	Apply a unary operator coefficient-wise.

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

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

Public Member Functions inherited from Eigen::EigenBase< SparseView< MatrixType > >
constexpr Index	cols () const noexcept

constexpr SparseView< MatrixType > &	derived ()

constexpr const SparseView< MatrixType > &	derived () const

constexpr Index	rows () const noexcept

constexpr Index	size () const noexcept

Additional Inherited Members
Public Types inherited from Eigen::SparseMatrixBase< SparseView< MatrixType > >
using	RealScalar

using	StorageIndex

using	value_type

Public Types inherited from Eigen::EigenBase< SparseView< MatrixType > >
using	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:

/builds/libeigen/eigen/Eigen/src/Core/util/ForwardDeclarations.h
/builds/libeigen/eigen/Eigen/src/SparseCore/SparseView.h

Detailed Description

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ nestedExpression()