.TH "mlpack::tree::CoverTree< MetricType, RootPointPolicy, StatisticType >::SingleTreeTraverser< RuleType >" 3 "Tue Sep 9 2014" "Version 1.0.10" "MLPACK" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mlpack::tree::CoverTree< MetricType, RootPointPolicy, StatisticType >::SingleTreeTraverser< RuleType > \- 
.PP
A single-tree cover tree traverser; see single_tree_traverser\&.hpp for implementation\&.  

.SH SYNOPSIS
.br
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSingleTreeTraverser\fP (RuleType &\fBrule\fP)"
.br
.RI "\fIInitialize the single tree traverser with the given rule\&. \fP"
.ti -1c
.RI "size_t \fBNumPrunes\fP () const "
.br
.RI "\fIGet the number of prunes so far\&. \fP"
.ti -1c
.RI "size_t & \fBNumPrunes\fP ()"
.br
.RI "\fISet the number of prunes (good for a reset to 0)\&. \fP"
.ti -1c
.RI "void \fBTraverse\fP (const size_t queryIndex, \fBCoverTree\fP &referenceNode)"
.br
.RI "\fITraverse the tree with the given point\&. \fP"
.in -1c
.SS "Private Attributes"

.in +1c
.ti -1c
.RI "size_t \fBnumPrunes\fP"
.br
.RI "\fIThe number of nodes which have been pruned during traversal\&. \fP"
.ti -1c
.RI "RuleType & \fBrule\fP"
.br
.RI "\fIReference to the rules with which the tree will be traversed\&. \fP"
.in -1c
.SH "Detailed Description"
.PP 

.SS "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\&. 


.PP
Definition at line 220 of file cover_tree\&.hpp\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "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)"

.PP
Initialize the single tree traverser with the given rule\&. 
.SH "Member Function Documentation"
.PP 
.SS "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"

.PP
Get the number of prunes so far\&. 
.PP
Definition at line 54 of file single_tree_traverser\&.hpp\&.
.SS "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"

.PP
Set the number of prunes (good for a reset to 0)\&. 
.PP
Definition at line 56 of file single_tree_traverser\&.hpp\&.
.SS "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)"

.PP
Traverse the tree with the given point\&. 
.PP
\fBParameters:\fP
.RS 4
\fIqueryIndex\fP The index of the point in the query set which is used as the query point\&. 
.br
\fIreferenceNode\fP The tree node to be traversed\&. 
.RE
.PP

.SH "Member Data Documentation"
.PP 
.SS "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"

.PP
The number of nodes which have been pruned during traversal\&. 
.PP
Definition at line 63 of file single_tree_traverser\&.hpp\&.
.SS "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"

.PP
Reference to the rules with which the tree will be traversed\&. 
.PP
Definition at line 60 of file single_tree_traverser\&.hpp\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for MLPACK from the source code\&.