Eigen  3.3.7
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 > >
Index cols () const
 
const internal::eval< SparseView< MatrixType > >::type eval () 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
 
const Product< SparseView< MatrixType >, OtherDerived, AliasFreeProduct > operator* (const SparseMatrixBase< OtherDerived > &other) const
 
Index outerSize () const
 
const SparseView< SparseView< MatrixType > > pruned (const Scalar &reference=Scalar(0), const RealScalar &epsilon=NumTraits< Scalar >::dummy_precision()) const
 
Index rows () const
 
Index size () const
 
SparseSymmetricPermutationProduct< SparseView< MatrixType >, Upper|Lower > twistedBy (const PermutationMatrix< Dynamic, Dynamic, StorageIndex > &perm) const
 
- Public Member Functions inherited from Eigen::EigenBase< SparseView< MatrixType > >
Index cols () const
 
SparseView< MatrixType > & derived ()
 
const SparseView< MatrixType > & derived () const
 
Index rows () const
 
Index size () const
 

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. More...
 

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: