[mlpack-git] master: This constructor doesn't take a set. (e2beb21)

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

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

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/c260f6ee781fa5c7efa72df7b0ea9890873bf7c4...e2beb217f3e17729b73f9edc05601195e92f775d

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

commit e2beb217f3e17729b73f9edc05601195e92f775d
Author: ryan <ryan at ratml.org>
Date:   Wed Apr 22 00:03:33 2015 -0400

    This constructor doesn't take a set.


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

e2beb217f3e17729b73f9edc05601195e92f775d
 src/mlpack/methods/range_search/range_search.hpp | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

diff --git a/src/mlpack/methods/range_search/range_search.hpp b/src/mlpack/methods/range_search/range_search.hpp
index 2c1b95e..0788d13 100644
--- a/src/mlpack/methods/range_search/range_search.hpp
+++ b/src/mlpack/methods/range_search/range_search.hpp
@@ -50,10 +50,9 @@ class RangeSearch
               const MetricType metric = MetricType());
 
   /**
-   * Initialize the RangeSearch object with the given reference dataset and
-   * pre-constructed tree (the reference set is the set that is searched).  It
-   * is assumed that the points in referenceSet correspond to the points in
-   * referenceTree.  Optionally, choose to use single-tree mode, which will not
+   * Initialize the RangeSearch object with the given pre-constructed reference
+   * tree (this is the tree built on the reference set, which is the set that is
+   * searched).  Optionally, choose to use single-tree mode, which will not
    * build a tree on query points.  Naive mode is not available as an option for
    * this constructor.  Additionally, an instantiated distance metric can be
    * given, for cases where the distance metric holds data.
@@ -64,9 +63,8 @@ class RangeSearch
    *
    * @note
    * Because tree-building (at least with BinarySpaceTree) modifies the ordering
-   * of a matrix, be sure you pass the modified matrix to this object!  In
-   * addition, mapping the points of the matrix back to their original indices
-   * is not done when this constructor is used.
+   * of a matrix, be aware that mapping of the points back to their original
+   * indices is not done when this constructor is used.
    * @endnote
    *
    * @param referenceTree Pre-built tree for reference points.