From 30e801f3916d62084e92828f480a0531c7995383 Mon Sep 17 00:00:00 2001 From: cjamin Date: Thu, 30 Jun 2016 16:17:07 +0000 Subject: More doc improvements git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/subsampling_and_spatialsearching@1371 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 4ffe114b4e56b69fccc885ea2fbb9ad883f54761 --- src/Subsampling/include/gudhi/sparsify_point_set.h | 25 ++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) (limited to 'src/Subsampling/include/gudhi/sparsify_point_set.h') diff --git a/src/Subsampling/include/gudhi/sparsify_point_set.h b/src/Subsampling/include/gudhi/sparsify_point_set.h index b4536ec8..3923bf74 100644 --- a/src/Subsampling/include/gudhi/sparsify_point_set.h +++ b/src/Subsampling/include/gudhi/sparsify_point_set.h @@ -35,12 +35,25 @@ namespace Gudhi { namespace subsampling { /** -* \ingroup subsampling -* \brief Outputs a subset of the input points so that the -* squared distance between any two points -* is greater than or equal to `min_squared_dist`. -* -*/ + * \ingroup subsampling + * \brief Outputs a subset of the input points so that the + * squared distance between any two points + * is greater than or equal to `min_squared_dist`. + * + * \tparam Kernel must be a model of the SearchTraits + * concept, such as the CGAL::Epick_d class, which + * can be static if you know the ambiant dimension at compile-time, or dynamic if you don't. + * \tparam Point_range Range whose value type is Kernel::Point_d. It must provide random-access + * via `operator[]` and the points should be stored contiguously in memory. + * \tparam OutputIterator Output iterator whose value type is Kernel::Point_d. + * + * @param[in] k A kernel object. + * @param[in] input_pts Const reference to the input points. + * @param[in] min_squared_dist Minimum squared distance separating the output points. + * @param[out] output_it The output iterator. + */ template void -- cgit v1.2.3