diff options
author | Marc Glisse <marc.glisse@inria.fr> | 2020-11-01 20:50:40 +0100 |
---|---|---|
committer | Marc Glisse <marc.glisse@inria.fr> | 2020-11-01 20:50:40 +0100 |
commit | 7d8e6d025436f269bc2e09292f118c4d8a035660 (patch) | |
tree | 7a2e54549388931dff9fd402f73b7df28f473164 | |
parent | c54a40fc6293fd746e1842f6811efae96df36bed (diff) |
Doc tweaks.
-rw-r--r-- | src/Subsampling/include/gudhi/choose_n_farthest_points.h | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/src/Subsampling/include/gudhi/choose_n_farthest_points.h b/src/Subsampling/include/gudhi/choose_n_farthest_points.h index bdd2993a..3c337025 100644 --- a/src/Subsampling/include/gudhi/choose_n_farthest_points.h +++ b/src/Subsampling/include/gudhi/choose_n_farthest_points.h @@ -38,20 +38,21 @@ enum : std::size_t { * \ingroup subsampling * \brief Subsample by a greedy strategy of iteratively adding the farthest point from the * current chosen point set to the subsampling. + * \details * The iteration starts with the landmark `starting point` or, if `starting point==random_starting_point`, * with a random landmark. + * It chooses `final_size` points from a random access range + * `input_pts` (or the number of distinct points if `final_size` is larger) + * and outputs them in the output iterator `output_it`. It also + * outputs the distance from each of those points to the set of previous + * points in `dist_it`. * \tparam Distance must provide an operator() that takes 2 points (value type of the range) * and returns their distance (or some more general proximity measure) as a `double`. * \tparam Point_range Random access range of points. * \tparam PointOutputIterator Output iterator whose value type is the point type. * \tparam DistanceOutputIterator Output iterator for distances. - * \details It chooses `final_size` points from a random access range - * `input_pts` (or the number of distinct points if `final_size` is larger) - * and outputs them in the output iterator `output_it`. It also - * outputs the distance from each of those points to the set of previous - * points in `dist_it`. * @param[in] dist A distance function. - * @param[in] input_pts Const reference to the input points. + * @param[in] input_pts The input points. * @param[in] final_size The size of the subsample to compute. * @param[in] starting_point The seed in the farthest point algorithm. * @param[out] output_it The output iterator for points. |