Eigen::SparseView< MatrixType > Class Template Reference

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

#include <SparseView.h>

Inheritance diagram for Eigen::SparseView< MatrixType >:

Public Types
typedef internal::remove_all_t< MatrixType >	NestedExpression
Public Types inherited from Eigen::SparseMatrixBase< SparseView< MatrixType > >
enum
typedef internal::traits< SparseView< MatrixType > >::Scalar	Scalar
typedef Scalar	value_type
typedef internal::packet_traits< Scalar >::type	PacketScalar
typedef internal::traits< SparseView< MatrixType > >::StorageKind	StorageKind
typedef internal::traits< SparseView< MatrixType > >::StorageIndex	StorageIndex
typedef internal::add_const_on_value_type_if_arithmetic< typename internal::packet_traits< Scalar >::type >::type	PacketReturnType
typedef SparseMatrixBase	StorageBaseType
typedef Matrix< StorageIndex, Dynamic, 1 >	IndexVector
typedef Matrix< Scalar, Dynamic, 1 >	ScalarVector
typedef std::conditional_t< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, Eigen::Transpose< const SparseView< MatrixType > > >, Transpose< const SparseView< MatrixType > > >	AdjointReturnType
typedef Transpose< SparseView< MatrixType > >	TransposeReturnType
typedef Transpose< const SparseView< MatrixType > >	ConstTransposeReturnType
typedef SparseMatrix< Scalar, Flags &RowMajorBit ? RowMajor :ColMajor, StorageIndex >	PlainObject
typedef NumTraits< Scalar >::Real	RealScalar
typedef std::conditional_t< HasDirectAccess_, const Scalar &, Scalar >	CoeffReturnType
typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, Matrix< Scalar, Dynamic, Dynamic > >	ConstantReturnType
typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	DenseMatrixType
typedef Matrix< Scalar, internal::max_size_prefer_dynamic(RowsAtCompileTime, ColsAtCompileTime), internal::max_size_prefer_dynamic(RowsAtCompileTime, ColsAtCompileTime)>	SquareMatrixType
typedef EigenBase< SparseView< MatrixType > >	Base
Public Types inherited from Eigen::EigenBase< SparseView< MatrixType > >
typedef Eigen::Index	Index
	The interface type of indices. More...
typedef internal::traits< SparseView< MatrixType > >::StorageKind	StorageKind

Public Member Functions
	SparseView (const MatrixType &mat, const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision())
Index	rows () const
Index	cols () const
Index	innerSize () const
Index	outerSize () const
const internal::remove_all_t< MatrixTypeNested > &	nestedExpression () const
Scalar	reference () const
RealScalar	epsilon () const
Public Member Functions inherited from Eigen::SparseMatrixBase< SparseView< MatrixType > >
SparseView< MatrixType > &	operator= (const EigenBase< OtherDerived > &other)
SparseView< MatrixType > &	operator= (const ReturnByValue< OtherDerived > &other)
SparseView< MatrixType > &	operator= (const SparseMatrixBase< OtherDerived > &other)
SparseView< MatrixType > &	operator= (const SparseView< MatrixType > &other)
const SparseView< MatrixType > &	derived () const
SparseView< MatrixType > &	derived ()
SparseView< MatrixType > &	const_cast_derived () const
Index	rows () const
Index	cols () const
Index	size () const
bool	isVector () const
Index	outerSize () const
Index	innerSize () const
bool	isRValue () const
SparseView< MatrixType > &	markAsRValue ()
	SparseMatrixBase ()
SparseView< MatrixType > &	operator+= (const SparseMatrixBase< OtherDerived > &other)
SparseView< MatrixType > &	operator+= (const DiagonalBase< OtherDerived > &other)
SparseView< MatrixType > &	operator+= (const EigenBase< OtherDerived > &other)
EIGEN_STRONG_INLINE SparseView< MatrixType > &	operator+= (const SparseMatrixBase< OtherDerived > &other)
SparseView< MatrixType > &	operator-= (const SparseMatrixBase< OtherDerived > &other)
SparseView< MatrixType > &	operator-= (const DiagonalBase< OtherDerived > &other)
SparseView< MatrixType > &	operator-= (const EigenBase< OtherDerived > &other)
EIGEN_STRONG_INLINE SparseView< MatrixType > &	operator-= (const SparseMatrixBase< OtherDerived > &other)
SparseView< MatrixType > &	operator*= (const Scalar &other)
SparseView< MatrixType > &	operator*= (const SparseMatrixBase< OtherDerived > &other)
SparseView< MatrixType > &	operator/= (const Scalar &other)
EIGEN_STRONG_INLINE const CwiseProductDenseReturnType< OtherDerived >::Type	cwiseProduct (const MatrixBase< OtherDerived > &other) const
EIGEN_STRONG_INLINE const SparseMatrixBase< SparseView< MatrixType > >::template CwiseProductDenseReturnType< OtherDerived >::Type	cwiseProduct (const MatrixBase< OtherDerived > &other) const
const Product< SparseView< MatrixType >, OtherDerived >	operator* (const DiagonalBase< OtherDerived > &other) const
const Product< SparseView< MatrixType >, OtherDerived, AliasFreeProduct >	operator* (const SparseMatrixBase< OtherDerived > &other) const
const Product< SparseView< MatrixType >, OtherDerived >	operator* (const MatrixBase< OtherDerived > &other) const
SparseSymmetricPermutationProduct< SparseView< MatrixType >, Upper|Lower >	twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
const TriangularView< const SparseView< MatrixType >, Mode >	triangularView () const
ConstSelfAdjointViewReturnType< UpLo >::Type	selfadjointView () const
SelfAdjointViewReturnType< UpLo >::Type	selfadjointView ()
SparseMatrixBase< SparseView< MatrixType > >::template ConstSelfAdjointViewReturnType< UpLo >::Type	selfadjointView () const
SparseMatrixBase< SparseView< MatrixType > >::template SelfAdjointViewReturnType< UpLo >::Type	selfadjointView ()
Scalar	dot (const MatrixBase< OtherDerived > &other) const
Scalar	dot (const SparseMatrixBase< OtherDerived > &other) const
internal::traits< SparseView< MatrixType > >::Scalar	dot (const MatrixBase< OtherDerived > &other) const
internal::traits< SparseView< MatrixType > >::Scalar	dot (const SparseMatrixBase< OtherDerived > &other) const
RealScalar	squaredNorm () const
RealScalar	norm () const
RealScalar	blueNorm () const
TransposeReturnType	transpose ()
const ConstTransposeReturnType	transpose () const
const AdjointReturnType	adjoint () const
DenseMatrixType	toDense () const
bool	isApprox (const SparseMatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
bool	isApprox (const MatrixBase< OtherDerived > &other, const RealScalar &prec=NumTraits< Scalar >::dummy_precision()) const
const internal::eval< SparseView< MatrixType > >::type	eval () const
Scalar	sum () const
const SparseView< SparseView< MatrixType > >	pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
Public Member Functions inherited from Eigen::EigenBase< SparseView< MatrixType > >
constexpr EIGEN_DEVICE_FUNC SparseView< MatrixType > &	derived ()
constexpr EIGEN_DEVICE_FUNC const SparseView< MatrixType > &	derived () const
EIGEN_DEVICE_FUNC SparseView< MatrixType > &	const_cast_derived () const
EIGEN_DEVICE_FUNC const SparseView< MatrixType > &	const_derived () const
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	rows () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	cols () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC EIGEN_CONSTEXPR Index	size () const EIGEN_NOEXCEPT
EIGEN_DEVICE_FUNC void	evalTo (Dest &dst) const
EIGEN_DEVICE_FUNC void	addTo (Dest &dst) const
EIGEN_DEVICE_FUNC void	subTo (Dest &dst) const
EIGEN_DEVICE_FUNC void	applyThisOnTheRight (Dest &dst) const
EIGEN_DEVICE_FUNC void	applyThisOnTheLeft (Dest &dst) const
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE DeviceWrapper< SparseView< MatrixType >, Device >	device (Device &device)
EIGEN_DEVICE_FUNC EIGEN_STRONG_INLINE DeviceWrapper< const SparseView< MatrixType >, Device >	device (Device &device) const

Protected Attributes
MatrixTypeNested	m_matrix
Scalar	m_reference
RealScalar	m_epsilon
Protected Attributes inherited from Eigen::SparseMatrixBase< SparseView< MatrixType > >
bool	m_isRValue

Private Types
typedef MatrixType::Nested	MatrixTypeNested
typedef internal::remove_all_t< MatrixTypeNested >	MatrixTypeNested_
typedef SparseMatrixBase< SparseView >	Base

Additional Inherited Members
Protected Member Functions inherited from Eigen::SparseMatrixBase< SparseView< MatrixType > >
SparseView< MatrixType > &	assign (const OtherDerived &other)
void	assignGeneric (const OtherDerived &other)
Static Protected Member Functions inherited from Eigen::SparseMatrixBase< SparseView< MatrixType > >
static StorageIndex	convert_index (const Index idx)

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()

Member Typedef Documentation

Base

template<typename MatrixType >

typedef SparseMatrixBase<SparseView> Eigen::SparseView< MatrixType >::Base

private

MatrixTypeNested

template<typename MatrixType >

typedef MatrixType::Nested Eigen::SparseView< MatrixType >::MatrixTypeNested

private

MatrixTypeNested_

template<typename MatrixType >

typedef internal::remove_all_t<MatrixTypeNested> Eigen::SparseView< MatrixType >::MatrixTypeNested_

private

NestedExpression

template<typename MatrixType >

typedef internal::remove_all_t<MatrixType> Eigen::SparseView< MatrixType >::NestedExpression

Constructor & Destructor Documentation

SparseView()

template<typename MatrixType >

Eigen::SparseView< MatrixType >::SparseView ( const MatrixType &  mat, const Scalar &  reference = Scalar(0), const RealScalar &  epsilon = NumTraits<Scalar>::dummy_precision()  )

inlineexplicit

      : m_matrix(mat), m_reference(reference), m_epsilon(epsilon) {}

Member Function Documentation

cols()

template<typename MatrixType >

Index Eigen::SparseView< MatrixType >::cols ( ) const

inline

{ return m_matrix.cols(); }

References Eigen::SparseView< MatrixType >::m_matrix.

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), gdb.printers.EigenMatrixPrinter::to_string(), and gdb.printers.EigenSparseMatrixPrinter::to_string().

epsilon()

template<typename MatrixType >

RealScalar Eigen::SparseView< MatrixType >::epsilon ( ) const

inline

{ return m_epsilon; }

References Eigen::SparseView< MatrixType >::m_epsilon.

Referenced by Eigen::internal::unary_evaluator< SparseView< ArgType >, IteratorBased >::InnerIterator::incrementToNonZero(), and Eigen::internal::unary_evaluator< SparseView< Product< Lhs, Rhs, Options > >, IteratorBased >::unary_evaluator().

innerSize()

template<typename MatrixType >

Index Eigen::SparseView< MatrixType >::innerSize ( ) const

inline

{ return m_matrix.innerSize(); }

References Eigen::SparseView< MatrixType >::m_matrix.

nestedExpression()

template<typename MatrixType >

const internal::remove_all_t<MatrixTypeNested>& Eigen::SparseView< MatrixType >::nestedExpression ( ) const

inline

Returns

the nested expression

{ return m_matrix; }

References Eigen::SparseView< MatrixType >::m_matrix.

Referenced by Eigen::internal::unary_evaluator< SparseView< Product< Lhs, Rhs, Options > >, IteratorBased >::unary_evaluator().

outerSize()

template<typename MatrixType >

Index Eigen::SparseView< MatrixType >::outerSize ( ) const

inline

{ return m_matrix.outerSize(); }

References Eigen::SparseView< MatrixType >::m_matrix.

reference()

template<typename MatrixType >

Scalar Eigen::SparseView< MatrixType >::reference ( ) const

inline

{ return m_reference; }

References Eigen::SparseView< MatrixType >::m_reference.

Referenced by Eigen::internal::unary_evaluator< SparseView< ArgType >, IteratorBased >::InnerIterator::incrementToNonZero(), and Eigen::internal::unary_evaluator< SparseView< Product< Lhs, Rhs, Options > >, IteratorBased >::unary_evaluator().

rows()

template<typename MatrixType >

Index Eigen::SparseView< MatrixType >::rows ( ) const

inline

{ return m_matrix.rows(); }

References Eigen::SparseView< MatrixType >::m_matrix.

Referenced by gdb.printers._MatrixEntryIterator::__next__(), gdb.printers.EigenMatrixPrinter::children(), gdb.printers.EigenSparseMatrixPrinter::children(), gdb.printers.EigenMatrixPrinter::to_string(), and gdb.printers.EigenSparseMatrixPrinter::to_string().

Member Data Documentation

m_epsilon

template<typename MatrixType >

RealScalar Eigen::SparseView< MatrixType >::m_epsilon

protected

Referenced by Eigen::SparseView< MatrixType >::epsilon().

m_matrix

template<typename MatrixType >

MatrixTypeNested Eigen::SparseView< MatrixType >::m_matrix

protected

Referenced by Eigen::SparseView< MatrixType >::cols(), Eigen::SparseView< MatrixType >::innerSize(), Eigen::SparseView< MatrixType >::nestedExpression(), Eigen::SparseView< MatrixType >::outerSize(), and Eigen::SparseView< MatrixType >::rows().

m_reference

template<typename MatrixType >

Scalar Eigen::SparseView< MatrixType >::m_reference

protected

Referenced by Eigen::SparseView< MatrixType >::reference().

---

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

• ForwardDeclarations.h
• SparseView.h