AABBtree  0.0.0
A C++ non-recursive ND AABB tree
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
AABBtree::Tree< Real, N >::Statistics Struct Reference

#include <Tree.hxx>

Public Member Functions

void reset () noexcept
 
void print (OutStream &os) const
 

Public Attributes

Integer objects {0}
 
Integer nodes {0}
 
Integer leafs {0}
 
Integer long_boxes {0}
 
Integer depth {0}
 
Integer left_nodes {0}
 
Integer left_leafs {0}
 
Integer left_long_boxes {0}
 
Integer left_depth {0}
 
Integer right_nodes {0}
 
Integer right_leafs {0}
 
Integer right_long_boxes {0}
 
Integer right_depth {0}
 
Integer dump_counter {0}
 
Real balance_ratio {0.0}
 
Real depth_ratio {0.0}
 
Integer check_counter {0}
 

Detailed Description

template<typename Real, Integer N>
struct AABBtree::Tree< Real, N >::Statistics

Structure representing the statistics of the AABB tree.

Member Function Documentation

◆ print()

template<typename Real, Integer N>
void AABBtree::Tree< Real, N >::Statistics::print ( OutStream & os) const
inline

Print the tree info to an output stream.

Parameters
[in]osOutput stream to print the tree info to.

◆ reset()

template<typename Real, Integer N>
void AABBtree::Tree< Real, N >::Statistics::reset ( )
inlinenoexcept

Reset all statistics to their initial zero state

This method efficiently resets all statistics counters to zero and ratios to 0, returning the structure to its default-constructed state.

Note
This operation is noexcept and has constant time complexity O(1)
Postcondition
All counters are zero and ratios are 0

Member Data Documentation

◆ balance_ratio

template<typename Real, Integer N>
Real AABBtree::Tree< Real, N >::Statistics::balance_ratio {0.0}

Ratio of left/right subtree sizes (0=perfect balance).

◆ check_counter

template<typename Real, Integer N>
Integer AABBtree::Tree< Real, N >::Statistics::check_counter {0}

Total number of collision checks performed.

◆ depth

template<typename Real, Integer N>
Integer AABBtree::Tree< Real, N >::Statistics::depth {0}

Maximum depth of the tree.

◆ depth_ratio

template<typename Real, Integer N>
Real AABBtree::Tree< Real, N >::Statistics::depth_ratio {0.0}

Ratio of left/right subtree depths (0=perfect balance).

◆ dump_counter

template<typename Real, Integer N>
Integer AABBtree::Tree< Real, N >::Statistics::dump_counter {0}

Number of tree rebuilds (dumps).

◆ leafs

template<typename Real, Integer N>
Integer AABBtree::Tree< Real, N >::Statistics::leafs {0}

Number of leaf nodes (nodes with objects).

◆ left_depth

template<typename Real, Integer N>
Integer AABBtree::Tree< Real, N >::Statistics::left_depth {0}

Depth of left subtree.

◆ left_leafs

template<typename Real, Integer N>
Integer AABBtree::Tree< Real, N >::Statistics::left_leafs {0}

Number of leafs in left subtree.

◆ left_long_boxes

template<typename Real, Integer N>
Integer AABBtree::Tree< Real, N >::Statistics::left_long_boxes {0}

Number of long boxes in left subtree.

◆ left_nodes

template<typename Real, Integer N>
Integer AABBtree::Tree< Real, N >::Statistics::left_nodes {0}

Number of nodes in left subtree.

◆ long_boxes

template<typename Real, Integer N>
Integer AABBtree::Tree< Real, N >::Statistics::long_boxes {0}

Number of boxes with aspect ratio > threshold.

◆ nodes

template<typename Real, Integer N>
Integer AABBtree::Tree< Real, N >::Statistics::nodes {0}

Total number of nodes in the tree.

◆ objects

template<typename Real, Integer N>
Integer AABBtree::Tree< Real, N >::Statistics::objects {0}

Number of objects in the tree.

◆ right_depth

template<typename Real, Integer N>
Integer AABBtree::Tree< Real, N >::Statistics::right_depth {0}

Depth of right subtree.

◆ right_leafs

template<typename Real, Integer N>
Integer AABBtree::Tree< Real, N >::Statistics::right_leafs {0}

Number of leafs in right subtree.

◆ right_long_boxes

template<typename Real, Integer N>
Integer AABBtree::Tree< Real, N >::Statistics::right_long_boxes {0}

Number of long boxes in right subtree.

◆ right_nodes

template<typename Real, Integer N>
Integer AABBtree::Tree< Real, N >::Statistics::right_nodes {0}

Number of nodes in right subtree.

The documentation for this struct was generated from the following file: