summaryrefslogtreecommitdiff
path: root/src/Subsampling/include/gudhi/sparsify_point_set.h
diff options
context:
space:
mode:
authorcjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-06-30 16:17:07 +0000
committercjamin <cjamin@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-06-30 16:17:07 +0000
commit30e801f3916d62084e92828f480a0531c7995383 (patch)
treec326bd032479f6e8b3aeba1bea7223d65d39b1fa /src/Subsampling/include/gudhi/sparsify_point_set.h
parentb2efeb519cdb43e407be5d1c0834c5cb39cc216a (diff)
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
Diffstat (limited to 'src/Subsampling/include/gudhi/sparsify_point_set.h')
-rw-r--r--src/Subsampling/include/gudhi/sparsify_point_set.h25
1 files changed, 19 insertions, 6 deletions
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 <a target="_blank"
+ * href="http://doc.cgal.org/latest/Spatial_searching/classSearchTraits.html">SearchTraits</a>
+ * concept, such as the <a target="_blank"
+ * href="http://doc.cgal.org/latest/Kernel_d/classCGAL_1_1Epick__d.html">CGAL::Epick_d</a> 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 <typename Kernel, typename Point_range, typename OutputIterator>
void