songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

small doc update

This commit is contained in:
Sven Oesau 2024-02-19 12:10:59 +01:00
parent 20e3cb8462
commit c580e30407
3 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Orthtree/doc/Orthtree/Concepts/OrthtreeTraitsWithData.h
View File

@ -42,7 +42,7 @@ public:
using Construct_root_node_contents = unspecified_type; using Construct_root_node_contents = unspecified_type;
/*! /*!
* \brief functor which fills the contents of the nodes children. * \brief Functor which fills the contents of the nodes children.
* *
* Provides the operator: * Provides the operator:
* `void operator()(typename Tree::Node_index, Tree&, const Point_d&)` * `void operator()(typename Tree::Node_index, Tree&, const Point_d&)`

2
Orthtree/include/CGAL/Orthtree.h
View File

@ -724,7 +724,7 @@ public:
} }
/*! /*!
\brief determines whether the node specified by index `n` is a root node. \brief determines whether the node specified by index `n` is the root node.
*/ */
bool is_root(Node_index n) const { bool is_root(Node_index n) const {
return n == 0; return n == 0;

2
Orthtree/include/CGAL/Orthtree/Nearest_neighbors.h
View File

@ -119,7 +119,7 @@ namespace Orthtrees {
\ingroup PkgOrthtreeNeighbors \ingroup PkgOrthtreeNeighbors
\brief finds at most `k` elements within a specific radius that are \brief finds at most `k` elements within a specific radius that are
nearest to the center of the sphere `query`: if `query` does not contain nearest to the center of the sphere `query`: if `query` does not contain
at least `k` elements, only contained points will be returned. at least `k` elements, only contained elements will be returned.
This function is useful when the user already knows how sparse the elements are, This function is useful when the user already knows how sparse the elements are,
or if they do not care about elements that are too far away. or if they do not care about elements that are too far away.