[mlpack-git] master: Removes commented-out old BaseCase code (0d38271)

[gitdub at mlpack.org]

Repository : https://github.com/mlpack/mlpack
On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/34cf8d94f79c9a72ff4199676033b060cd039fcd...425324bf7fb7c86c85d10a909d8a59d4f69b7164

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

commit 0d382719a29754bfa6e2ddab976b5ae7386811c0
Author: Yannis Mentekidis <mentekid at gmail.com>
Date:   Fri Jul 1 14:51:21 2016 +0100

    Removes commented-out old BaseCase code


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

0d382719a29754bfa6e2ddab976b5ae7386811c0
 src/mlpack/methods/lsh/lsh_search.hpp | 41 ++++-------------------------------
 1 file changed, 4 insertions(+), 37 deletions(-)

diff --git a/src/mlpack/methods/lsh/lsh_search.hpp b/src/mlpack/methods/lsh/lsh_search.hpp
index 6227ca4..0882393 100644
--- a/src/mlpack/methods/lsh/lsh_search.hpp
+++ b/src/mlpack/methods/lsh/lsh_search.hpp
@@ -272,39 +272,6 @@ class LSHSearch
                               arma::uvec& referenceIndices,
                               size_t numTablesToSearch);
 
-//  /**
-//   * This is a helper function that computes the distance of the query to the
-//   * neighbor candidates and appropriately stores the best 'k' candidates.  This
-//   * is specific to the monochromatic search case, where the query set is the
-//   * reference set.
-//   *
-//   * @param queryIndex The index of the query in question
-//   * @param referenceIndex The index of the neighbor candidate in question
-//   * @param neighbors Matrix holding output neighbors.
-//   * @param distances Matrix holding output distances.
-//   */
-//  void BaseCase(const size_t queryIndex,
-//                const size_t referenceIndex,
-//                arma::Mat<size_t>& neighbors,
-//                arma::mat& distances) const;
-//
-//  /**
-//   * This is a helper function that computes the distance of the query to the
-//   * neighbor candidates and appropriately stores the best 'k' candidates.  This
-//   * is specific to bichromatic search, where the query set is not the same as
-//   * the reference set.
-//   *
-//   * @param queryIndex The index of the query in question
-//   * @param referenceIndex The index of the neighbor candidate in question
-//   * @param querySet Set of query points.
-//   * @param neighbors Matrix holding output neighbors.
-//   * @param distances Matrix holding output distances.
-//   */
-//  void BaseCase(const size_t queryIndex,
-//                const size_t referenceIndex,
-//                const arma::mat& querySet,
-//                arma::Mat<size_t>& neighbors,
-//                arma::mat& distances) const;
 
   /**
    * This is a helper function that computes the distance of the query to the
@@ -313,11 +280,11 @@ class LSHSearch
    * reference set.
    *
    * @param queryIndex The index of the query in question
-   * @param referenceIndex The index of the neighbor candidate in question
+   * @param referenceIndices The vector of indices of candidate neighbors for 
+   *    the query.
    * @param neighbors Matrix holding output neighbors.
    * @param distances Matrix holding output distances.
    */
-  // TODO: change documentation above
   void BaseCase(const size_t queryIndex,
                 const arma::uvec& referenceIndices,
                 arma::Mat<size_t>& neighbors,
@@ -330,12 +297,12 @@ class LSHSearch
    * the reference set.
    *
    * @param queryIndex The index of the query in question
-   * @param referenceIndex The index of the neighbor candidate in question
+   * @param referenceIndices The vector of indices of candidate neighbors for
+   *    the query.
    * @param querySet Set of query points.
    * @param neighbors Matrix holding output neighbors.
    * @param distances Matrix holding output distances.
    */
-  //TODO: change documentation above.
   void BaseCase(const size_t queryIndex,
                 const arma::uvec& referenceIndices,
                 const arma::mat& querySet,