---
name: "mlpack_tree_CoverTree_SingleTreeTraverser"
section: "3"
platform: "linux"
package: "mlpack-doc"
version: "1.0.10-1"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/mlpack_tree_CoverTree_SingleTreeTraverser"
---

# mlpack\_tree\_CoverTree\_SingleTreeTraverser(3)

A single-tree cover tree traverser; see single\_tree\_traverser.hpp for implementation.

## NAME

mlpack::tree::CoverTree\< MetricType, RootPointPolicy, StatisticType \>::SingleTreeTraverser\< RuleType \> -

A single-tree cover tree traverser; see single\_tree\_traverser.hpp for implementation.

## SYNOPSIS

### Public Member Functions

**SingleTreeTraverser** (RuleType &**rule**)\
 *Initialize the single tree traverser with the given rule.*  size\_t **NumPrunes** () const \
 *Get the number of prunes so far.*  size\_t & **NumPrunes** ()\
 *Set the number of prunes (good for a reset to 0).*  void **Traverse** (const size\_t queryIndex, **CoverTree** &referenceNode)\
 *Traverse the tree with the given point.*

### Private Attributes

size\_t **numPrunes**\
 *The number of nodes which have been pruned during traversal.*  RuleType & **rule**\
 *Reference to the rules with which the tree will be traversed.*

## Detailed Description

### template\<typename MetricType = metric::LMetric\<2, true\>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic\>template\<typename RuleType\>class mlpack::tree::CoverTree\< MetricType, RootPointPolicy, StatisticType \>::SingleTreeTraverser\< RuleType \>

A single-tree cover tree traverser; see single\_tree\_traverser.hpp for implementation.

Definition at line 220 of file cover\_tree.hpp.

## Constructor & Destructor Documentation

### template\<typename MetricType = metric::LMetric\<2, true\>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic\> template\<typename RuleType \> mlpack::tree::CoverTree\< MetricType, RootPointPolicy, StatisticType \>::SingleTreeTraverser\< RuleType \>::SingleTreeTraverser (RuleType &rule)

Initialize the single tree traverser with the given rule.

## Member Function Documentation

### template\<typename MetricType = metric::LMetric\<2, true\>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic\> template\<typename RuleType \> size\_t mlpack::tree::CoverTree\< MetricType, RootPointPolicy, StatisticType \>::SingleTreeTraverser\< RuleType \>::NumPrunes () const` [inline]`

Get the number of prunes so far.

Definition at line 54 of file single\_tree\_traverser.hpp.

### template\<typename MetricType = metric::LMetric\<2, true\>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic\> template\<typename RuleType \> size\_t& mlpack::tree::CoverTree\< MetricType, RootPointPolicy, StatisticType \>::SingleTreeTraverser\< RuleType \>::NumPrunes ()` [inline]`

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

Definition at line 56 of file single\_tree\_traverser.hpp.

### template\<typename MetricType = metric::LMetric\<2, true\>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic\> template\<typename RuleType \> void mlpack::tree::CoverTree\< MetricType, RootPointPolicy, StatisticType \>::SingleTreeTraverser\< RuleType \>::Traverse (const size\_tqueryIndex, CoverTree &referenceNode)

Traverse the tree with the given point.

**Parameters:**

*queryIndex* The index of the point in the query set which is used as the query point. \
 *referenceNode* The tree node to be traversed.

## Member Data Documentation

### template\<typename MetricType = metric::LMetric\<2, true\>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic\> template\<typename RuleType \> size\_t mlpack::tree::CoverTree\< MetricType, RootPointPolicy, StatisticType \>::SingleTreeTraverser\< RuleType \>::numPrunes` [private]`

The number of nodes which have been pruned during traversal.

Definition at line 63 of file single\_tree\_traverser.hpp.

### template\<typename MetricType = metric::LMetric\<2, true\>, typename RootPointPolicy = FirstPointIsRoot, typename StatisticType = EmptyStatistic\> template\<typename RuleType \> RuleType& mlpack::tree::CoverTree\< MetricType, RootPointPolicy, StatisticType \>::SingleTreeTraverser\< RuleType \>::rule` [private]`

Reference to the rules with which the tree will be traversed.

Definition at line 60 of file single\_tree\_traverser.hpp.

## Author

Generated automatically by Doxygen for MLPACK from the source code.