mlpack  master
dual_tree_traverser.hpp
Go to the documentation of this file.
1 
15 #ifndef MLPACK_CORE_TREE_BINARY_SPACE_TREE_DUAL_TREE_TRAVERSER_HPP
16 #define MLPACK_CORE_TREE_BINARY_SPACE_TREE_DUAL_TREE_TRAVERSER_HPP
17 
18 #include <mlpack/prereqs.hpp>
19 
20 #include "binary_space_tree.hpp"
21 
22 namespace mlpack {
23 namespace tree {
24 
25 template<typename MetricType,
26  typename StatisticType,
27  typename MatType,
28  template<typename BoundMetricType, typename...> class BoundType,
29  template<typename SplitBoundType, typename SplitMatType>
30  class SplitType>
31 template<typename RuleType>
32 class BinarySpaceTree<MetricType, StatisticType, MatType, BoundType,
33  SplitType>::DualTreeTraverser
34 {
35  public:
39  DualTreeTraverser(RuleType& rule);
40 
48  void Traverse(BinarySpaceTree& queryNode,
49  BinarySpaceTree& referenceNode);
50 
52  size_t NumPrunes() const { return numPrunes; }
54  size_t& NumPrunes() { return numPrunes; }
55 
57  size_t NumVisited() const { return numVisited; }
59  size_t& NumVisited() { return numVisited; }
60 
62  size_t NumScores() const { return numScores; }
64  size_t& NumScores() { return numScores; }
65 
67  size_t NumBaseCases() const { return numBaseCases; }
69  size_t& NumBaseCases() { return numBaseCases; }
70 
71  private:
73  RuleType& rule;
74 
76  size_t numPrunes;
77 
79  size_t numVisited;
80 
82  size_t numScores;
83 
85  size_t numBaseCases;
86 
89  typename RuleType::TraversalInfoType traversalInfo;
90 };
91 
92 } // namespace tree
93 } // namespace mlpack
94 
95 // Include implementation.
96 #include "dual_tree_traverser_impl.hpp"
97 
98 #endif // MLPACK_CORE_TREE_BINARY_SPACE_TREE_DUAL_TREE_TRAVERSER_HPP
99 
size_t numVisited
The number of node combinations that have been visited during traversal.
size_t numScores
The number of times a node combination was scored.
Linear algebra utility functions, generally performed on matrices or vectors.
Definition: binarize.hpp:18
size_t NumPrunes() const
Get the number of prunes.
The core includes that mlpack expects; standard C++ includes and Armadillo.
RuleType & rule
Reference to the rules with which the trees will be traversed.
size_t NumBaseCases() const
Get the number of times a base case was calculated.
size_t NumVisited() const
Get the number of visited combinations.
RuleType::TraversalInfoType traversalInfo
Traversal information, held in the class so that it isn&#39;t continually being reallocated.
size_t NumScores() const
Get the number of times a node combination was scored.
BinarySpaceTree()
A default constructor.
size_t & NumScores()
Modify the number of times a node combination was scored.
size_t & NumVisited()
Modify the number of visited combinations.
size_t & NumPrunes()
Modify the number of prunes.
size_t & NumBaseCases()
Modify the number of times a base case was calculated.
size_t numBaseCases
The number of times a base case was calculated.