Skip to content

Commit

Permalink
Update adjacent_node descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
JacksonCampolattaro committed Aug 20, 2020
1 parent 18cfdfa commit 88be3ad
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
6 changes: 5 additions & 1 deletion Octree/doc/Octree/Octree.txt
Expand Up @@ -12,6 +12,11 @@ namespace CGAL {
An octree is a commonly used data structure that subdivides 3d space.
The Octree package provides the Octree and Node classes.

\todo I need to discuss use-cases

Note that the octree will often be outperformed by Spacial_searching's kD-tree.
Octrees are most useful when implementing algorithms that require nodes without high aspect-ratios.

\section Section_Octree Octree

\section Section_Octree_Examples Examples
Expand Down Expand Up @@ -117,7 +122,6 @@ e.g. When is an octree the right choice?

\subsection Subsection_Octree_Splitting_Rules Splitting Rules
\subsection Subsection_Octree_Walker_Rules Walker Rules

*/

}
6 changes: 3 additions & 3 deletions Octree/include/CGAL/Octree/Node.h
Expand Up @@ -448,21 +448,21 @@ class Node {
}

/*!
* \todo I need to get copydoc working so I don't have to duplicate documentation
* \brief equivalent to adjacent_node, with a Direction rather than a bitset
*/
const Self *adjacent_node(Direction direction) const {
return adjacent_node(std::bitset<3>(static_cast<int>(direction)));
}

/*!
* \todo I need to get copydoc working so I don't have to duplicate documentation
* \brief equivalent to adjacent_node, except non-const
*/
Self *adjacent_node(std::bitset<3> direction) {
return const_cast<Self *>(const_cast<const Self *>(this)->adjacent_node(direction));
}

/*!
* \todo I need to get copydoc working so I don't have to duplicate documentation
* \brief equivalent to adjacent_node, with a Direction rather than a bitset and non-const
*/
Self *adjacent_node(Direction direction) {
return adjacent_node(std::bitset<3>(static_cast<int>(direction)));
Expand Down

0 comments on commit 88be3ad

Please sign in to comment.