From 79eaf04bb86c74310bfa0ed1026eba6077925b04 Mon Sep 17 00:00:00 2001 From: Sven Oesau Date: Fri, 2 Feb 2024 10:51:21 +0100 Subject: [PATCH] doc split predicate with bucket_size needs Node_data with random access --- Orthtree/include/CGAL/Orthtree.h | 2 +- Orthtree/include/CGAL/Orthtree/Split_predicates.h | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/Orthtree/include/CGAL/Orthtree.h b/Orthtree/include/CGAL/Orthtree.h index b0df8c8afd1..bb8ef542a72 100644 --- a/Orthtree/include/CGAL/Orthtree.h +++ b/Orthtree/include/CGAL/Orthtree.h @@ -311,7 +311,7 @@ public: than `bucket_size`, it is not split. \warning This convenience method is only appropriate for trees with traits classes where - `Node_data` is a list-like type with a `size()` method. + `Node_data` is a model of `RandomAccessRange`. \param max_depth deepest a tree is allowed to be (nodes at this depth will not be split). \param bucket_size maximum number of items a node is allowed to contain. diff --git a/Orthtree/include/CGAL/Orthtree/Split_predicates.h b/Orthtree/include/CGAL/Orthtree/Split_predicates.h index 934e599cba0..b4997a7aa77 100644 --- a/Orthtree/include/CGAL/Orthtree/Split_predicates.h +++ b/Orthtree/include/CGAL/Orthtree/Split_predicates.h @@ -29,6 +29,9 @@ namespace Orthtrees { This is a bucket size predicate that considers a node should be split if it contains more than a certain number of items. + + \warning This split predicate is only appropriate for trees with traits classes where + `Node_data` is a model of `RandomAccessRange`. */ class Maximum_number_of_inliers { @@ -92,6 +95,8 @@ public: at a depth smaller than `max_depth` but already has fewer inliers than `bucket_size`, it is not split. + \warning This split predicate is only appropriate for trees with traits classes where + `Node_data` is a model of `RandomAccessRange`. */ class Maximum_depth_and_maximum_number_of_inliers {