[mlpack-git] master, mlpack-1.0.x: added comment to base case. Some more preliminaries for rectangle trees. (ea72f0c)

[gitdub at big.cc.gt.atl.ga.us]

Repository : https://github.com/mlpack/mlpack

On branches: master,mlpack-1.0.x
Link       : https://github.com/mlpack/mlpack/compare/904762495c039e345beba14c1142fd719b3bd50e...f94823c800ad6f7266995c700b1b630d5ffdcf40

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

commit ea72f0cd8a69dd10682fdd5e14d3a23f73958e03
Author: andrewmw94 <andrewmw94 at gmail.com>
Date:   Thu May 22 15:16:15 2014 +0000

    added comment to base case.  Some more preliminaries for rectangle trees.


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

ea72f0cd8a69dd10682fdd5e14d3a23f73958e03
 src/mlpack/core/tree/rectangle_tree/rectangle_tree.hpp       | 2 +-
 src/mlpack/methods/neighbor_search/neighbor_search_rules.hpp | 9 ++++++++-
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/src/mlpack/core/tree/rectangle_tree/rectangle_tree.hpp b/src/mlpack/core/tree/rectangle_tree/rectangle_tree.hpp
index 5ed3348..fed4534 100644
--- a/src/mlpack/core/tree/rectangle_tree/rectangle_tree.hpp
+++ b/src/mlpack/core/tree/rectangle_tree/rectangle_tree.hpp
@@ -76,7 +76,7 @@ class RectangleTree
    * @param leafSize Size of each leaf in the tree;
    * @param maxNumChildren The maximum number of child nodes a non-leaf node may have.
    */
-  RectangleTree(MatType& data, const size_t leafSize = 20, const size_t maxNumChildren = 5);
+  RectangleTree(MatType& data, const size_t leafSize = 20, const size_t maxNumChildren = 4);
 
   //TODO implement the oldFromNew stuff if applicable.
 
diff --git a/src/mlpack/methods/neighbor_search/neighbor_search_rules.hpp b/src/mlpack/methods/neighbor_search/neighbor_search_rules.hpp
index cd37e44..effa4ac 100644
--- a/src/mlpack/methods/neighbor_search/neighbor_search_rules.hpp
+++ b/src/mlpack/methods/neighbor_search/neighbor_search_rules.hpp
@@ -22,7 +22,14 @@ class NeighborSearchRules
                       arma::Mat<size_t>& neighbors,
                       arma::mat& distances,
                       MetricType& metric);
-
+  /**
+   * Get the distance from the query point to the reference point.
+   * This will update the "neighbor" matrix with the new point if appropriate
+   * and will track the number of base cases (number of points evaluated).
+   *
+   * @param queryIndex Index of query point.
+   * @param referenceIndex Index of reference point.
+   */
   double BaseCase(const size_t queryIndex, const size_t referenceIndex);
 
   /**