[mlpack-git] master, mlpack-1.0.x: Update documentation to reflect changes in RangeSearch. (7973e83)

[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 7973e83f949ba6aa5ba6570791ec66b139bc3938
Author: Ryan Curtin <ryan at ratml.org>
Date:   Thu Mar 13 15:07:38 2014 +0000

    Update documentation to reflect changes in RangeSearch.


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

7973e83f949ba6aa5ba6570791ec66b139bc3938
 doc/tutorials/range_search/range_search.txt | 19 +++++++++++++------
 1 file changed, 13 insertions(+), 6 deletions(-)

diff --git a/doc/tutorials/range_search/range_search.txt b/doc/tutorials/range_search/range_search.txt
index 270e64d..a3e238c 100644
--- a/doc/tutorials/range_search/range_search.txt
+++ b/doc/tutorials/range_search/range_search.txt
@@ -357,16 +357,13 @@ class and use it seamlessly with RangeSearch.
 The RangeSearch class also allows a custom tree to be used.  The standard
 \b mlpack tree, mlpack::tree::BinarySpaceTree, is also highly extensible in its
 own right, and its documentation should be consulted for more information.
-Currently, the RangeSearch tree requires a tree which only has left and right
-children, and no points in nodes (only in leaves), but this support is planned
-to be extended.
 
 A simple usage of the TreeType policy could be to use a different type of bound
-with the tree.  For instance, you could use a ball bound instead of a
-rectangular bound:
+with the existing mlpack::tree::BinarySpaceTree class.  For instance, you could
+use a ball bound instead of a rectangular bound:
 
 @code
-// Construct a NeighborSearch object with ball bounds.
+// Construct a RangeSearch object with ball bounds.
 RangeSearch<
   metric::SquaredEuclideanDistance,
   tree::BinarySpaceTree<bound::BallBound<2>,
@@ -379,6 +376,16 @@ not make use of tree statistics; therefore, the EmptyStatistic class should be
 used for the StatisticType parameter of the BinarySpaceTree (but this is not
 technically necessary -- RangeSearch simply makes no use of the tree statistic).
 
+It is also possible to use a completely different type of tree.  The example
+below shows the use of the RangeSearch class with the mlpack::tree::CoverTree
+class (which has the EmptyStatistic statistic type as a default, so we do not
+need to specify that).
+
+ at code
+// Construct a RangeSearch object that uses cover trees.
+RangeSearch<tree::CoverTree<> > rangeSearch(dataset);
+ at endcode
+
 @section further_doc_rstut Further documentation
 
 For further documentation on the RangeSearch class, consult the