MLPACK  1.0.11
neighbor_search_rules.hpp
Go to the documentation of this file.
1 
23 #ifndef __MLPACK_METHODS_NEIGHBOR_SEARCH_NEIGHBOR_SEARCH_RULES_HPP
24 #define __MLPACK_METHODS_NEIGHBOR_SEARCH_NEIGHBOR_SEARCH_RULES_HPP
25 
26 #include "ns_traversal_info.hpp"
27 
28 namespace mlpack {
29 namespace neighbor {
30 
31 template<typename SortPolicy, typename MetricType, typename TreeType>
33 {
34  public:
35  NeighborSearchRules(const typename TreeType::Mat& referenceSet,
36  const typename TreeType::Mat& querySet,
37  arma::Mat<size_t>& neighbors,
38  arma::mat& distances,
39  MetricType& metric);
48  double BaseCase(const size_t queryIndex, const size_t referenceIndex);
49 
58  double Score(const size_t queryIndex, TreeType& referenceNode);
59 
71  double Rescore(const size_t queryIndex,
72  TreeType& referenceNode,
73  const double oldScore) const;
74 
83  double Score(TreeType& queryNode, TreeType& referenceNode);
84 
96  double Rescore(TreeType& queryNode,
97  TreeType& referenceNode,
98  const double oldScore) const;
99 
101  size_t BaseCases() const { return baseCases; }
103  size_t& BaseCases() { return baseCases; }
104 
106  size_t Scores() const { return scores; }
108  size_t& Scores() { return scores; }
109 
112 
114  const TraversalInfoType& TraversalInfo() const { return traversalInfo; }
117 
118  private:
120  const typename TreeType::Mat& referenceSet;
121 
123  const typename TreeType::Mat& querySet;
124 
126  arma::Mat<size_t>& neighbors;
127 
129  arma::mat& distances;
130 
132  MetricType& metric;
133 
139  double lastBaseCase;
140 
142  size_t baseCases;
144  size_t scores;
145 
149 
153  double CalculateBound(TreeType& queryNode) const;
154 
164  void InsertNeighbor(const size_t queryIndex,
165  const size_t pos,
166  const size_t neighbor,
167  const double distance);
168 };
169 
170 }; // namespace neighbor
171 }; // namespace mlpack
172 
173 // Include implementation.
174 #include "neighbor_search_rules_impl.hpp"
175 
176 #endif // __MLPACK_METHODS_NEIGHBOR_SEARCH_NEIGHBOR_SEARCH_RULES_HPP
double CalculateBound(TreeType &queryNode) const
Recalculate the bound for a given query node.
TraversalInfoType & TraversalInfo()
Modify the traversal info.
size_t lastQueryIndex
The last query point BaseCase() was called with.
arma::mat & distances
The matrix the resultant neighbor distances should be stored in.
TraversalInfoType traversalInfo
Traversal info for the parent combination; this is updated by the traversal before each call to Score...
size_t BaseCases() const
Get the number of base cases that have been performed.
const TreeType::Mat & referenceSet
The reference set.
void InsertNeighbor(const size_t queryIndex, const size_t pos, const size_t neighbor, const double distance)
Insert a point into the neighbors and distances matrices; this is a helper function.
NeighborSearchTraversalInfo< TreeType > TraversalInfoType
Convenience typedef.
const TraversalInfoType & TraversalInfo() const
Get the traversal info.
Traversal information for NeighborSearch.
size_t & Scores()
Modify the number of scores that have been performed.
double lastBaseCase
The last base case result.
size_t Scores() const
Get the number of scores that have been performed.
size_t lastReferenceIndex
The last reference point BaseCase() was called with.
double Score(const size_t queryIndex, TreeType &referenceNode)
Get the score for recursion order.
NeighborSearchRules(const typename TreeType::Mat &referenceSet, const typename TreeType::Mat &querySet, arma::Mat< size_t > &neighbors, arma::mat &distances, MetricType &metric)
arma::Mat< size_t > & neighbors
The matrix the resultant neighbor indices should be stored in.
double BaseCase(const size_t queryIndex, const size_t referenceIndex)
Get the distance from the query point to the reference point.
size_t & BaseCases()
Modify the number of base cases that have been performed.
double Rescore(const size_t queryIndex, TreeType &referenceNode, const double oldScore) const
Re-evaluate the score for recursion order.
MetricType & metric
The instantiated metric.
size_t scores
The number of scores that have been performed.
size_t baseCases
The number of base cases that have been performed.
const TreeType::Mat & querySet
The query set.