Skip to content

Commit

Permalink
Add brief documentation to split criterion
Browse files Browse the repository at this point in the history
  • Loading branch information
JacksonCampolattaro committed Jul 16, 2020
1 parent 73820f7 commit 5c6fff2
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions Octree/include/CGAL/Octree/Split_criterion.h
Expand Up @@ -8,6 +8,9 @@ namespace CGAL {

namespace Octree {

/*!
* \brief Criterion to split nodes of an octree when they contain more than a certain number of items
*/
struct Split_to_bucket_size {

std::size_t m_bucket_size;
Expand All @@ -21,6 +24,9 @@ struct Split_to_bucket_size {
}
};

/*!
* \brief Criterion to split nodes of an octree when they are less than a certain depth
*/
struct Split_to_max_depth {

std::size_t m_max_depth;
Expand All @@ -33,6 +39,9 @@ struct Split_to_max_depth {
}
};

/*!
* \brief Criterion to split nodes when they are less than a depth and they contain more than a number of items
*/
struct Split_to_max_depth_or_bucket_size {

std::size_t m_max_depth, m_bucket_size;
Expand Down

0 comments on commit 5c6fff2

Please sign in to comment.