CoverTree< MetricType, StatisticType, MatType, RootPointPolicy >::SingleTreeTraverser< RuleType > Class Template Reference

A single-tree cover tree traverser; see single_tree_traverser.hpp for implementation. More...

Public Member Functions

 SingleTreeTraverser (RuleType &rule)
 Initialize the single tree traverser with the given rule. More...

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

 
size_t & NumPrunes ()
 Set the number of prunes (good for a reset to 0). More...

 
void Traverse (const size_t queryIndex, CoverTree &referenceNode)
 Traverse the tree with the given point. More...

 

Detailed Description


template<typename MetricType = metric::LMetric<2, true>, typename StatisticType = EmptyStatistic, typename MatType = arma::mat, typename RootPointPolicy = FirstPointIsRoot>

template
<
typename
RuleType
>

class mlpack::tree::CoverTree< MetricType, StatisticType, MatType, RootPointPolicy >::SingleTreeTraverser< RuleType >

A single-tree cover tree traverser; see single_tree_traverser.hpp for implementation.

Definition at line 257 of file cover_tree.hpp.

Constructor & Destructor Documentation

◆ SingleTreeTraverser()

SingleTreeTraverser ( RuleType &  rule)

Initialize the single tree traverser with the given rule.

Member Function Documentation

◆ NumPrunes() [1/2]

size_t NumPrunes ( ) const
inline

Get the number of prunes so far.

Definition at line 50 of file single_tree_traverser.hpp.

◆ NumPrunes() [2/2]

size_t& NumPrunes ( )
inline

Set the number of prunes (good for a reset to 0).

Definition at line 52 of file single_tree_traverser.hpp.

◆ Traverse()

void Traverse ( const size_t  queryIndex,
CoverTree referenceNode 
)

Traverse the tree with the given point.

Parameters
queryIndexThe index of the point in the query set which is used as the query point.
referenceNodeThe tree node to be traversed.

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