From 2c6e6e5e578833b0f936c5c571f86e8ec36d7bcc Mon Sep 17 00:00:00 2001 From: Simon Giraudot Date: Tue, 8 Sep 2015 12:38:34 +0200 Subject: [PATCH] Update Reference Manual with additional template parameter --- Point_set_processing_3/include/CGAL/compute_average_spacing.h | 3 +++ .../include/CGAL/edge_aware_upsample_point_set.h | 4 ++++ Point_set_processing_3/include/CGAL/jet_estimate_normals.h | 4 +++- Point_set_processing_3/include/CGAL/jet_smooth_point_set.h | 3 +++ Point_set_processing_3/include/CGAL/pca_estimate_normals.h | 3 +++ 5 files changed, 16 insertions(+), 1 deletion(-) diff --git a/Point_set_processing_3/include/CGAL/compute_average_spacing.h b/Point_set_processing_3/include/CGAL/compute_average_spacing.h index b4e0fda9d3b..127ceef3f69 100644 --- a/Point_set_processing_3/include/CGAL/compute_average_spacing.h +++ b/Point_set_processing_3/include/CGAL/compute_average_spacing.h @@ -130,6 +130,9 @@ compute_average_spacing(const typename Kernel::Point_3& query, ///< 3D point who /// /// \pre `k >= 2.` /// +/// @tparam Concurrency_tag enables sequential versus parallel algorithm. +/// Possible values are `Sequential_tag` +/// and `Parallel_tag`. /// @tparam InputIterator iterator over input points. /// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3`. /// It can be omitted if the value type of `InputIterator` is convertible to `Point_3`. diff --git a/Point_set_processing_3/include/CGAL/edge_aware_upsample_point_set.h b/Point_set_processing_3/include/CGAL/edge_aware_upsample_point_set.h index 5495290ae65..b7e3433d64c 100644 --- a/Point_set_processing_3/include/CGAL/edge_aware_upsample_point_set.h +++ b/Point_set_processing_3/include/CGAL/edge_aware_upsample_point_set.h @@ -285,6 +285,10 @@ update_new_point( /// in point-based rendering, hole filling, and sparse surface reconstruction. /// Normals of points are required as input. For more details, please refer to \cgalCite{ear-2013}. /// +/// @tparam Concurrency_tag enables sequential versus parallel +/// versions of `compute_average_spacing()` (called internally). +/// Possible values are `Sequential_tag` +/// and `Parallel_tag`. /// @tparam OutputIterator Type of the output iterator. /// The type of the objects put in it is /// `std::pair`. diff --git a/Point_set_processing_3/include/CGAL/jet_estimate_normals.h b/Point_set_processing_3/include/CGAL/jet_estimate_normals.h index a429643c797..6dc45e6780a 100644 --- a/Point_set_processing_3/include/CGAL/jet_estimate_normals.h +++ b/Point_set_processing_3/include/CGAL/jet_estimate_normals.h @@ -151,7 +151,9 @@ jet_estimate_normal(const typename Kernel::Point_3& query, ///< point to compute /// /// \pre `k >= 2` /// -/// +/// @tparam Concurrency_tag enables sequential versus parallel algorithm. +/// Possible values are `Sequential_tag` +/// and `Parallel_tag`. /// @tparam ForwardIterator iterator model of the concept of the same name over input points and able to store output normals. /// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3`. /// It can be omitted if the value type of `ForwardIterator` is convertible to `Point_3`. diff --git a/Point_set_processing_3/include/CGAL/jet_smooth_point_set.h b/Point_set_processing_3/include/CGAL/jet_smooth_point_set.h index 9800fcb6cf7..d933439d66e 100644 --- a/Point_set_processing_3/include/CGAL/jet_smooth_point_set.h +++ b/Point_set_processing_3/include/CGAL/jet_smooth_point_set.h @@ -155,6 +155,9 @@ jet_smooth_point( /// /// \pre `k >= 2` /// +/// @tparam Concurrency_tag enables sequential versus parallel algorithm. +/// Possible values are `Sequential_tag` +/// and `Parallel_tag`. /// @tparam InputIterator iterator over input points. /// @tparam PointPMap is a model of `ReadWritePropertyMap` with value type `Point_3`. /// It can be omitted if the value type of `InputIterator` is convertible to `Point_3`. diff --git a/Point_set_processing_3/include/CGAL/pca_estimate_normals.h b/Point_set_processing_3/include/CGAL/pca_estimate_normals.h index 81c0646c2a1..a3ce97289c4 100644 --- a/Point_set_processing_3/include/CGAL/pca_estimate_normals.h +++ b/Point_set_processing_3/include/CGAL/pca_estimate_normals.h @@ -142,6 +142,9 @@ pca_estimate_normal(const typename Kernel::Point_3& query, ///< point to compute /// /// \pre `k >= 2` /// +/// @tparam Concurrency_tag enables sequential versus parallel algorithm. +/// Possible values are `Sequential_tag` +/// and `Parallel_tag`. /// @tparam ForwardIterator iterator over input points. /// @tparam PointPMap is a model of `ReadablePropertyMap` with value type `Point_3`. /// It can be omitted if the value type of `ForwardIterator` is convertible to `Point_3`.