[mlpack-git] master: Update documentation. (c86b32c)

[gitdub at mlpack.org]

Repository : https://github.com/mlpack/mlpack
On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/0f4b25acd6aaa14294c044874ba6cc0751712baa...0a19d07bd39e6223991976474bc79671ba8aa0f0

>---------------------------------------------------------------

commit c86b32cbf52ddce05215109c4593c7d8ef589b4f
Author: MarcosPividori <marcos.pividori at gmail.com>
Date:   Mon Aug 1 00:47:01 2016 -0300

    Update documentation.


>---------------------------------------------------------------

c86b32cbf52ddce05215109c4593c7d8ef589b4f
 .../neighbor_search/neighbor_search_rules_spill.hpp    | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

diff --git a/src/mlpack/methods/neighbor_search/neighbor_search_rules_spill.hpp b/src/mlpack/methods/neighbor_search/neighbor_search_rules_spill.hpp
index 6f84adf..2288770 100644
--- a/src/mlpack/methods/neighbor_search/neighbor_search_rules_spill.hpp
+++ b/src/mlpack/methods/neighbor_search/neighbor_search_rules_spill.hpp
@@ -74,9 +74,12 @@ class NeighborSearchRules<SortPolicy, MetricType, tree::SpillTree<MetricType,
   double BaseCase(const size_t queryIndex, const size_t referenceIndex);
 
   /**
-   * Get the score for recursion order.  A low score indicates priority for
-   * recursion, while DBL_MAX indicates that the node should not be recursed
-   * into at all (it should be pruned).
+   * Get the score for recursion order.  It implements a Hybrid sp-tree
+   * search.  If referenceNode's parent is a overlapping node, the score is
+   * calculated based on the splitting hyperplane: if query point is on the same
+   * side, returns 0, else DBL_MAX.
+   * If referenceNode's parent is a non-overlapping node, proper score is
+   * calculated, similar to the general Score() method.
    *
    * @param queryIndex Index of query point.
    * @param referenceNode Candidate node to be recursed into.
@@ -99,9 +102,12 @@ class NeighborSearchRules<SortPolicy, MetricType, tree::SpillTree<MetricType,
                  const double oldScore) const;
 
   /**
-   * Get the score for recursion order.  A low score indicates priority for
-   * recursionm while DBL_MAX indicates that the node should not be recursed
-   * into at all (it should be pruned).
+   * Get the score for recursion order.  It implements a Hybrid sp-tree
+   * search.  If referenceNode's parent is a overlapping node, the score is
+   * calculated based on the splitting hyperplane: if queryNode's bound
+   * intersects the referenceNode's half space, returns 0, else DBL_MAX.
+   * If referenceNode's parent is a non-overlapping node, proper score is
+   * calculated, similar to the general Score() method.
    *
    * @param queryNode Candidate query node to recurse into.
    * @param referenceNode Candidate reference node to recurse into.