doc split predicate with bucket_size needs Node_data with random access

This commit is contained in:
Sven Oesau 2024-02-02 10:51:21 +01:00
parent 73bf4edf44
commit 79eaf04bb8
2 changed files with 6 additions and 1 deletions

View File

@ -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.

View File

@ -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 {