mlpack  2.2.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
fastmks_rules.hpp
Go to the documentation of this file.
1 
12 #ifndef MLPACK_METHODS_FASTMKS_FASTMKS_RULES_HPP
13 #define MLPACK_METHODS_FASTMKS_FASTMKS_RULES_HPP
14 
15 #include <mlpack/prereqs.hpp>
19 #include <boost/heap/priority_queue.hpp>
20 
21 namespace mlpack {
22 namespace fastmks {
23 
33 template<typename KernelType, typename TreeType>
35 {
36  public:
46  FastMKSRules(const typename TreeType::Mat& referenceSet,
47  const typename TreeType::Mat& querySet,
48  const size_t k,
49  KernelType& kernel);
50 
57  void GetResults(arma::Mat<size_t>& indices, arma::mat& products);
58 
60  double BaseCase(const size_t queryIndex, const size_t referenceIndex);
61 
70  double Score(const size_t queryIndex, TreeType& referenceNode);
71 
80  double Score(TreeType& queryNode, TreeType& referenceNode);
81 
93  double Rescore(const size_t queryIndex,
94  TreeType& referenceNode,
95  const double oldScore) const;
96 
108  double Rescore(TreeType& queryNode,
109  TreeType& referenceNode,
110  const double oldScore) const;
111 
113  size_t BaseCases() const { return baseCases; }
115  size_t& BaseCases() { return baseCases; }
116 
118  size_t Scores() const { return scores; }
120  size_t& Scores() { return scores; }
121 
123 
124  const TraversalInfoType& TraversalInfo() const { return traversalInfo; }
125  TraversalInfoType& TraversalInfo() { return traversalInfo; }
126 
127  private:
129  const typename TreeType::Mat& referenceSet;
131  const typename TreeType::Mat& querySet;
132 
134  typedef std::pair<double, size_t> Candidate;
135 
137  struct CandidateCmp {
138  bool operator()(const Candidate& c1, const Candidate& c2) const
139  {
140  return c1.first > c2.first;
141  };
142  };
143 
148  typedef boost::heap::priority_queue<Candidate,
149  boost::heap::compare<CandidateCmp>> CandidateList;
150 
152  std::vector<CandidateList> candidates;
153 
155  const size_t k;
156 
158  arma::vec queryKernels;
160  arma::vec referenceKernels;
161 
163  KernelType& kernel;
164 
166  size_t lastQueryIndex;
168  size_t lastReferenceIndex;
170  double lastKernel;
171 
173  double CalculateBound(TreeType& queryNode) const;
174 
182  void InsertNeighbor(const size_t queryIndex,
183  const size_t index,
184  const double product);
185 
187  size_t baseCases;
189  size_t scores;
190 
191  TraversalInfoType traversalInfo;
192 };
193 
194 } // namespace fastmks
195 } // namespace mlpack
196 
197 // Include implementation.
198 #include "fastmks_rules_impl.hpp"
199 
200 #endif
TraversalInfoType & TraversalInfo()
The TraversalInfo class holds traversal information which is used in dual-tree (and single-tree) trav...
double Rescore(const size_t queryIndex, TreeType &referenceNode, const double oldScore) const
Re-evaluate the score for recursion order.
FastMKSRules(const typename TreeType::Mat &referenceSet, const typename TreeType::Mat &querySet, const size_t k, KernelType &kernel)
Construct the FastMKSRules object.
The core includes that mlpack expects; standard C++ includes and Armadillo.
const TraversalInfoType & TraversalInfo() const
size_t & BaseCases()
Modify the number of times BaseCase() was called.
double Score(const size_t queryIndex, TreeType &referenceNode)
Get the score for recursion order.
double BaseCase(const size_t queryIndex, const size_t referenceIndex)
Compute the base case (kernel value) between two points.
size_t & Scores()
Modify the number of times Score() was called.
The FastMKSRules class is a template helper class used by FastMKS class when performing exact max-ker...
size_t Scores() const
Get the number of times Score() was called.
tree::TraversalInfo< TreeType > TraversalInfoType
size_t BaseCases() const
Get the number of times BaseCase() was called.
void GetResults(arma::Mat< size_t > &indices, arma::mat &products)
Store the list of candidates for each query point in the given matrices.