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

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/SparseCore/SparseView.h>

Inheritance diagram for Eigen::SparseView< MatrixType >:

Public Types
typedef internal::remove_all< MatrixType >::type	NestedExpression

Public Types inherited from Eigen::SparseMatrixBase< SparseView< MatrixType > >
enum

typedef internal::traits< SparseView< MatrixType > >::Scalar	Scalar

typedef Scalar	value_type
	The numeric type of the expression' coefficients, e.g. More...

typedef internal::packet_traits< Scalar >::type	PacketScalar

typedef internal::traits< SparseView< MatrixType > >::StorageKind	StorageKind

typedef internal::traits< SparseView< MatrixType > >::StorageIndex	StorageIndex
	The integer type used to store indices within a SparseMatrix. More...

typedef internal::add_const_on_value_type_if_arithmetic< typenameinternal::packet_traits< Scalar >::type >::type	PacketReturnType

typedef SparseMatrixBase	StorageBaseType

typedef Matrix< StorageIndex, Dynamic, 1 >	IndexVector

typedef Matrix< Scalar, Dynamic, 1 >	ScalarVector

typedef internal::conditional< NumTraits< Scalar >::IsComplex, CwiseUnaryOp< internal::scalar_conjugate_op< Scalar >, Eigen::Transpose< constDerived > >, Transpose< constDerived > >::type	AdjointReturnType

typedef Transpose< SparseView< MatrixType > >	TransposeReturnType

typedef internal::add_const< Transpose< constDerived > >::type	ConstTransposeReturnType

typedef SparseMatrix< Scalar, Flags &RowMajorBit ? RowMajor :ColMajor, StorageIndex >	PlainObject

typedef NumTraits< Scalar >::Real	RealScalar
	This is the "real scalar" type; if the Scalar type is already real numbers (e.g. More...

typedef internal::conditional< _HasDirectAccess, constScalar &, Scalar >::type	CoeffReturnType

typedef CwiseNullaryOp< internal::scalar_constant_op< Scalar >, Matrix< Scalar, Dynamic, Dynamic > >	ConstantReturnType

typedef Matrix< Scalar, RowsAtCompileTime, ColsAtCompileTime >	DenseMatrixType
	type of the equivalent dense matrix More...

typedef Matrix< Scalar, EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime), EIGEN_SIZE_MAX(RowsAtCompileTime, ColsAtCompileTime)>	SquareMatrixType
	type of the equivalent square matrix More...

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< MatrixTypeNested >::type &	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 > >
EIGEN_DEVICE_FUNC SparseView< MatrixType > &	derived ()

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

Protected Attributes
MatrixTypeNested	m_matrix

Scalar	m_reference

RealScalar	m_epsilon

Protected Attributes inherited from Eigen::SparseMatrixBase< SparseView< MatrixType > >
bool	m_isRValue

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