.TH "mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType, SplitType >::DualTreeTraverser< RuleType >" 3 "Tue Sep 9 2014" "Version 1.0.10" "MLPACK" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType, SplitType >::DualTreeTraverser< RuleType > \- 
.PP
A dual-tree traverser for binary space trees; see dual_tree_traverser\&.hpp\&.  

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

.in +1c
.ti -1c
.RI "\fBDualTreeTraverser\fP (RuleType &\fBrule\fP)"
.br
.RI "\fIInstantiate the dual-tree traverser with the given rule set\&. \fP"
.ti -1c
.RI "size_t \fBNumBaseCases\fP () const "
.br
.RI "\fIGet the number of times a base case was calculated\&. \fP"
.ti -1c
.RI "size_t & \fBNumBaseCases\fP ()"
.br
.RI "\fIModify the number of times a base case was calculated\&. \fP"
.ti -1c
.RI "size_t \fBNumPrunes\fP () const "
.br
.RI "\fIGet the number of prunes\&. \fP"
.ti -1c
.RI "size_t & \fBNumPrunes\fP ()"
.br
.RI "\fIModify the number of prunes\&. \fP"
.ti -1c
.RI "size_t \fBNumScores\fP () const "
.br
.RI "\fIGet the number of times a node combination was scored\&. \fP"
.ti -1c
.RI "size_t & \fBNumScores\fP ()"
.br
.RI "\fIModify the number of times a node combination was scored\&. \fP"
.ti -1c
.RI "size_t \fBNumVisited\fP () const "
.br
.RI "\fIGet the number of visited combinations\&. \fP"
.ti -1c
.RI "size_t & \fBNumVisited\fP ()"
.br
.RI "\fIModify the number of visited combinations\&. \fP"
.ti -1c
.RI "void \fBTraverse\fP (\fBBinarySpaceTree\fP &queryNode, \fBBinarySpaceTree\fP &referenceNode)"
.br
.RI "\fITraverse the two trees\&. \fP"
.in -1c
.SS "Private Attributes"

.in +1c
.ti -1c
.RI "size_t \fBnumBaseCases\fP"
.br
.RI "\fIThe number of times a base case was calculated\&. \fP"
.ti -1c
.RI "size_t \fBnumPrunes\fP"
.br
.RI "\fIThe number of prunes\&. \fP"
.ti -1c
.RI "size_t \fBnumScores\fP"
.br
.RI "\fIThe number of times a node combination was scored\&. \fP"
.ti -1c
.RI "size_t \fBnumVisited\fP"
.br
.RI "\fIThe number of node combinations that have been visited during traversal\&. \fP"
.ti -1c
.RI "RuleType & \fBrule\fP"
.br
.RI "\fIReference to the rules with which the trees will be traversed\&. \fP"
.ti -1c
.RI "RuleType::TraversalInfoType \fBtraversalInfo\fP"
.br
.RI "\fITraversal information, held in the class so that it isn't continually being reallocated\&. \fP"
.in -1c
.SH "Detailed Description"
.PP 

.SS "template<typename BoundType, typename StatisticType = EmptyStatistic, typename MatType = arma::mat, typename SplitType = MeanSplit<BoundType, MatType>>template<typename RuleType>class mlpack::tree::BinarySpaceTree< BoundType, StatisticType, MatType, SplitType >::DualTreeTraverser< RuleType >"
A dual-tree traverser for binary space trees; see dual_tree_traverser\&.hpp\&. 
.PP
Definition at line 103 of file binary_space_tree\&.hpp\&.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "template<typename BoundType , typename StatisticType  = EmptyStatistic, typename MatType  = arma::mat, typename SplitType  = MeanSplit<BoundType, MatType>> template<typename RuleType > \fBmlpack::tree::BinarySpaceTree\fP< BoundType, StatisticType, MatType, SplitType >::\fBDualTreeTraverser\fP< RuleType >::\fBDualTreeTraverser\fP (RuleType &rule)"

.PP
Instantiate the dual-tree traverser with the given rule set\&. 
.SH "Member Function Documentation"
.PP 
.SS "template<typename BoundType , typename StatisticType  = EmptyStatistic, typename MatType  = arma::mat, typename SplitType  = MeanSplit<BoundType, MatType>> template<typename RuleType > size_t \fBmlpack::tree::BinarySpaceTree\fP< BoundType, StatisticType, MatType, SplitType >::\fBDualTreeTraverser\fP< RuleType >::NumBaseCases () const\fC [inline]\fP"

.PP
Get the number of times a base case was calculated\&. 
.PP
Definition at line 75 of file dual_tree_traverser\&.hpp\&.
.SS "template<typename BoundType , typename StatisticType  = EmptyStatistic, typename MatType  = arma::mat, typename SplitType  = MeanSplit<BoundType, MatType>> template<typename RuleType > size_t& \fBmlpack::tree::BinarySpaceTree\fP< BoundType, StatisticType, MatType, SplitType >::\fBDualTreeTraverser\fP< RuleType >::NumBaseCases ()\fC [inline]\fP"

.PP
Modify the number of times a base case was calculated\&. 
.PP
Definition at line 77 of file dual_tree_traverser\&.hpp\&.
.SS "template<typename BoundType , typename StatisticType  = EmptyStatistic, typename MatType  = arma::mat, typename SplitType  = MeanSplit<BoundType, MatType>> template<typename RuleType > size_t \fBmlpack::tree::BinarySpaceTree\fP< BoundType, StatisticType, MatType, SplitType >::\fBDualTreeTraverser\fP< RuleType >::NumPrunes () const\fC [inline]\fP"

.PP
Get the number of prunes\&. 
.PP
Definition at line 60 of file dual_tree_traverser\&.hpp\&.
.SS "template<typename BoundType , typename StatisticType  = EmptyStatistic, typename MatType  = arma::mat, typename SplitType  = MeanSplit<BoundType, MatType>> template<typename RuleType > size_t& \fBmlpack::tree::BinarySpaceTree\fP< BoundType, StatisticType, MatType, SplitType >::\fBDualTreeTraverser\fP< RuleType >::NumPrunes ()\fC [inline]\fP"

.PP
Modify the number of prunes\&. 
.PP
Definition at line 62 of file dual_tree_traverser\&.hpp\&.
.SS "template<typename BoundType , typename StatisticType  = EmptyStatistic, typename MatType  = arma::mat, typename SplitType  = MeanSplit<BoundType, MatType>> template<typename RuleType > size_t \fBmlpack::tree::BinarySpaceTree\fP< BoundType, StatisticType, MatType, SplitType >::\fBDualTreeTraverser\fP< RuleType >::NumScores () const\fC [inline]\fP"

.PP
Get the number of times a node combination was scored\&. 
.PP
Definition at line 70 of file dual_tree_traverser\&.hpp\&.
.SS "template<typename BoundType , typename StatisticType  = EmptyStatistic, typename MatType  = arma::mat, typename SplitType  = MeanSplit<BoundType, MatType>> template<typename RuleType > size_t& \fBmlpack::tree::BinarySpaceTree\fP< BoundType, StatisticType, MatType, SplitType >::\fBDualTreeTraverser\fP< RuleType >::NumScores ()\fC [inline]\fP"

.PP
Modify the number of times a node combination was scored\&. 
.PP
Definition at line 72 of file dual_tree_traverser\&.hpp\&.
.SS "template<typename BoundType , typename StatisticType  = EmptyStatistic, typename MatType  = arma::mat, typename SplitType  = MeanSplit<BoundType, MatType>> template<typename RuleType > size_t \fBmlpack::tree::BinarySpaceTree\fP< BoundType, StatisticType, MatType, SplitType >::\fBDualTreeTraverser\fP< RuleType >::NumVisited () const\fC [inline]\fP"

.PP
Get the number of visited combinations\&. 
.PP
Definition at line 65 of file dual_tree_traverser\&.hpp\&.
.SS "template<typename BoundType , typename StatisticType  = EmptyStatistic, typename MatType  = arma::mat, typename SplitType  = MeanSplit<BoundType, MatType>> template<typename RuleType > size_t& \fBmlpack::tree::BinarySpaceTree\fP< BoundType, StatisticType, MatType, SplitType >::\fBDualTreeTraverser\fP< RuleType >::NumVisited ()\fC [inline]\fP"

.PP
Modify the number of visited combinations\&. 
.PP
Definition at line 67 of file dual_tree_traverser\&.hpp\&.
.SS "template<typename BoundType , typename StatisticType  = EmptyStatistic, typename MatType  = arma::mat, typename SplitType  = MeanSplit<BoundType, MatType>> template<typename RuleType > void \fBmlpack::tree::BinarySpaceTree\fP< BoundType, StatisticType, MatType, SplitType >::\fBDualTreeTraverser\fP< RuleType >::Traverse (\fBBinarySpaceTree\fP &queryNode, \fBBinarySpaceTree\fP &referenceNode)"

.PP
Traverse the two trees\&. This does not reset the number of prunes\&.
.PP
\fBParameters:\fP
.RS 4
\fIqueryNode\fP The query node to be traversed\&. 
.br
\fIreferenceNode\fP The reference node to be traversed\&. 
.br
\fIscore\fP The score of the current node combination\&. 
.RE
.PP

.SH "Member Data Documentation"
.PP 
.SS "template<typename BoundType , typename StatisticType  = EmptyStatistic, typename MatType  = arma::mat, typename SplitType  = MeanSplit<BoundType, MatType>> template<typename RuleType > size_t \fBmlpack::tree::BinarySpaceTree\fP< BoundType, StatisticType, MatType, SplitType >::\fBDualTreeTraverser\fP< RuleType >::numBaseCases\fC [private]\fP"

.PP
The number of times a base case was calculated\&. 
.PP
Definition at line 93 of file dual_tree_traverser\&.hpp\&.
.SS "template<typename BoundType , typename StatisticType  = EmptyStatistic, typename MatType  = arma::mat, typename SplitType  = MeanSplit<BoundType, MatType>> template<typename RuleType > size_t \fBmlpack::tree::BinarySpaceTree\fP< BoundType, StatisticType, MatType, SplitType >::\fBDualTreeTraverser\fP< RuleType >::numPrunes\fC [private]\fP"

.PP
The number of prunes\&. 
.PP
Definition at line 84 of file dual_tree_traverser\&.hpp\&.
.SS "template<typename BoundType , typename StatisticType  = EmptyStatistic, typename MatType  = arma::mat, typename SplitType  = MeanSplit<BoundType, MatType>> template<typename RuleType > size_t \fBmlpack::tree::BinarySpaceTree\fP< BoundType, StatisticType, MatType, SplitType >::\fBDualTreeTraverser\fP< RuleType >::numScores\fC [private]\fP"

.PP
The number of times a node combination was scored\&. 
.PP
Definition at line 90 of file dual_tree_traverser\&.hpp\&.
.SS "template<typename BoundType , typename StatisticType  = EmptyStatistic, typename MatType  = arma::mat, typename SplitType  = MeanSplit<BoundType, MatType>> template<typename RuleType > size_t \fBmlpack::tree::BinarySpaceTree\fP< BoundType, StatisticType, MatType, SplitType >::\fBDualTreeTraverser\fP< RuleType >::numVisited\fC [private]\fP"

.PP
The number of node combinations that have been visited during traversal\&. 
.PP
Definition at line 87 of file dual_tree_traverser\&.hpp\&.
.SS "template<typename BoundType , typename StatisticType  = EmptyStatistic, typename MatType  = arma::mat, typename SplitType  = MeanSplit<BoundType, MatType>> template<typename RuleType > RuleType& \fBmlpack::tree::BinarySpaceTree\fP< BoundType, StatisticType, MatType, SplitType >::\fBDualTreeTraverser\fP< RuleType >::rule\fC [private]\fP"

.PP
Reference to the rules with which the trees will be traversed\&. 
.PP
Definition at line 81 of file dual_tree_traverser\&.hpp\&.
.SS "template<typename BoundType , typename StatisticType  = EmptyStatistic, typename MatType  = arma::mat, typename SplitType  = MeanSplit<BoundType, MatType>> template<typename RuleType > RuleType::TraversalInfoType \fBmlpack::tree::BinarySpaceTree\fP< BoundType, StatisticType, MatType, SplitType >::\fBDualTreeTraverser\fP< RuleType >::traversalInfo\fC [private]\fP"

.PP
Traversal information, held in the class so that it isn't continually being reallocated\&. 
.PP
Definition at line 97 of file dual_tree_traverser\&.hpp\&.

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