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 > \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBSingleTreeTraverser\fP< RuleType >::\fBSingleTreeTraverser\fP (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 \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBSingleTreeTraverser\fP< RuleType >::NumPrunes () const\fC [inline]\fP

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& \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBSingleTreeTraverser\fP< RuleType >::NumPrunes ()\fC [inline]\fP

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 \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBSingleTreeTraverser\fP< RuleType >::Traverse (const size_tqueryIndex, \fBCoverTree\fP &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 \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBSingleTreeTraverser\fP< RuleType >::numPrunes\fC [private]\fP

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& \fBmlpack::tree::CoverTree\fP< MetricType, RootPointPolicy, StatisticType >::\fBSingleTreeTraverser\fP< RuleType >::rule\fC [private]\fP

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.