BinarySpaceTree< MetricType, StatisticType, MatType, BoundType, SplitType >::DualTreeTraverser< RuleType > Class Template Reference

A dual-tree traverser for binary space trees; see dual_tree_traverser.hpp. More...

Public Member Functions

 DualTreeTraverser (RuleType &rule)
 Instantiate the dual-tree traverser with the given rule set. More...

 
size_t NumBaseCases () const
 Get the number of times a base case was calculated. More...

 
size_t & NumBaseCases ()
 Modify the number of times a base case was calculated. More...

 
size_t NumPrunes () const
 Get the number of prunes. More...

 
size_t & NumPrunes ()
 Modify the number of prunes. More...

 
size_t NumScores () const
 Get the number of times a node combination was scored. More...

 
size_t & NumScores ()
 Modify the number of times a node combination was scored. More...

 
size_t NumVisited () const
 Get the number of visited combinations. More...

 
size_t & NumVisited ()
 Modify the number of visited combinations. More...

 
void Traverse (BinarySpaceTree &queryNode, BinarySpaceTree &referenceNode)
 Traverse the two trees. More...

 

Detailed Description


template<typename MetricType, typename StatisticType = EmptyStatistic, typename MatType = arma::mat, template< typename BoundMetricType, typename... > class BoundType = bound::HRectBound, template< typename SplitBoundType, typename SplitMatType > class SplitType = MidpointSplit>

template
<
typename
RuleType
>

class mlpack::tree::BinarySpaceTree< MetricType, StatisticType, MatType, BoundType, SplitType >::DualTreeTraverser< RuleType >

A dual-tree traverser for binary space trees; see dual_tree_traverser.hpp.

Definition at line 100 of file binary_space_tree.hpp.

Constructor & Destructor Documentation

◆ DualTreeTraverser()

DualTreeTraverser ( RuleType &  rule)

Instantiate the dual-tree traverser with the given rule set.

Member Function Documentation

◆ NumBaseCases() [1/2]

size_t NumBaseCases ( ) const
inline

Get the number of times a base case was calculated.

Definition at line 66 of file dual_tree_traverser.hpp.

◆ NumBaseCases() [2/2]

size_t& NumBaseCases ( )
inline

Modify the number of times a base case was calculated.

Definition at line 68 of file dual_tree_traverser.hpp.

◆ NumPrunes() [1/2]

size_t NumPrunes ( ) const
inline

Get the number of prunes.

Definition at line 51 of file dual_tree_traverser.hpp.

◆ NumPrunes() [2/2]

size_t& NumPrunes ( )
inline

Modify the number of prunes.

Definition at line 53 of file dual_tree_traverser.hpp.

◆ NumScores() [1/2]

size_t NumScores ( ) const
inline

Get the number of times a node combination was scored.

Definition at line 61 of file dual_tree_traverser.hpp.

◆ NumScores() [2/2]

size_t& NumScores ( )
inline

Modify the number of times a node combination was scored.

Definition at line 63 of file dual_tree_traverser.hpp.

◆ NumVisited() [1/2]

size_t NumVisited ( ) const
inline

Get the number of visited combinations.

Definition at line 56 of file dual_tree_traverser.hpp.

◆ NumVisited() [2/2]

size_t& NumVisited ( )
inline

Modify the number of visited combinations.

Definition at line 58 of file dual_tree_traverser.hpp.

◆ Traverse()

void Traverse ( BinarySpaceTree queryNode,
BinarySpaceTree referenceNode 
)

Traverse the two trees.

This does not reset the number of prunes.

Parameters
queryNodeThe query node to be traversed.
referenceNodeThe reference node to be traversed.

The documentation for this class was generated from the following files:
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-git/src/mlpack/core/tree/binary_space_tree/binary_space_tree.hpp
  • /home/jenkins-mlpack/mlpack.org/_src/mlpack-git/src/mlpack/core/tree/binary_space_tree/dual_tree_traverser.hpp