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

A single-tree traverser; see single_tree_traverser.hpp. More...

Public Member Functions

 SingleTreeTraverser (RuleType &rule)
 Instantiate the traverser with the given rule set. More...

 
size_t NumPrunes () const
 Get the number of pruned nodes. More...

 
size_t & NumPrunes ()
 Modify the number of pruned nodes. More...

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

 

Detailed Description


template
<
typename
MetricType
=
metric::EuclideanDistance
,
typename
StatisticType
=
EmptyStatistic
,
typename
MatType
=
arma::mat
>


template
<
typename
RuleType
>

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

A single-tree traverser; see single_tree_traverser.hpp.

Definition at line 35 of file octree.hpp.

Constructor & Destructor Documentation

◆ SingleTreeTraverser()

SingleTreeTraverser ( RuleType &  rule)

Instantiate the traverser with the given rule set.

Member Function Documentation

◆ NumPrunes() [1/2]

size_t NumPrunes ( ) const
inline

Get the number of pruned nodes.

Definition at line 41 of file single_tree_traverser.hpp.

◆ NumPrunes() [2/2]

size_t& NumPrunes ( )
inline

Modify the number of pruned nodes.

Definition at line 43 of file single_tree_traverser.hpp.

◆ Traverse()

void Traverse ( const size_t  queryIndex,
Octree referenceNode 
)

Traverse the reference tree with the given query point.

This does not reset the number of pruned nodes.

Parameters
queryIndexIndex of query point.
referenceNodeNode in reference tree.

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