GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-07-21 04:14:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add missing doc of SparseView

Browse Source 
(grafted from 831fffe874d791448ff2040654411383ae260a75
)
This commit is contained in:
Gael Guennebaud 2017-01-06 18:01:29 +01:00
parent dafdb0d8a8
commit 0b22158d9f
1 changed files with 32 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
Eigen/src/SparseCore/SparseView.h
View File

@ -27,6 +27,20 @@ struct traits<SparseView<MatrixType> > : traits<MatrixType>
} // end namespace internal } // end namespace internal
/** \ingroup SparseCore_Module
* \class SparseView
*
* \brief Expression of a dense or sparse matrix with zero or too small values removed
*
* \tparam 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 \c reference * \c 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.
*
* \sa MatrixBase::sparseView(), SparseMatrixBase::pruned()
*/
template<typename MatrixType> template<typename MatrixType>
class SparseView : public SparseMatrixBase<SparseView<MatrixType> > class SparseView : public SparseMatrixBase<SparseView<MatrixType> >
{ {
@ -190,6 +204,23 @@ struct unary_evaluator<SparseView<ArgType>, IndexBased>
} // end namespace internal } // end namespace internal
/** \ingroup SparseCore_Module
*
* \returns a sparse expression of the dense expression \c *this with values smaller than
* \a reference * \a epsilon removed.
*
* This method is typically used when prototyping to convert a quickly assembled dense Matrix \c D to a SparseMatrix \c S:
* \code
* MatrixXd D(n,m);
* SparseMatrix<double> S;
* S = D.sparseView(); // suppress numerical zeros (exact)
* S = D.sparseView(reference);
* S = D.sparseView(reference,epsilon);
* \endcode
* where \a reference is a meaningful non zero reference value,
* and \a epsilon is a tolerance factor defaulting to NumTraits<Scalar>::dummy_precision().
*
* \sa SparseMatrixBase::pruned(), class SparseView */
template<typename Derived> template<typename Derived>
const SparseView<Derived> MatrixBase<Derived>::sparseView(const Scalar& reference, const SparseView<Derived> MatrixBase<Derived>::sparseView(const Scalar& reference,
const typename NumTraits<Scalar>::Real& epsilon) const const typename NumTraits<Scalar>::Real& epsilon) const
@ -198,7 +229,7 @@ const SparseView<Derived> MatrixBase<Derived>::sparseView(const Scalar& referenc
} }
/** \returns an expression of \c *this with values smaller than /** \returns an expression of \c *this with values smaller than
* \a reference * \a epsilon are removed. * \a reference * \a epsilon removed.
* *
* This method is typically used in conjunction with the product of two sparse matrices * This method is typically used in conjunction with the product of two sparse matrices
* to automatically prune the smallest values as follows: * to automatically prune the smallest values as follows: