[mlpack-git] master: Add more information on deprecated methods. (0d071af)

[gitdub at mlpack.org]

Repository : https://github.com/mlpack/mlpack
On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/1148f1652e139c9037eb3813550090313d089a30...a8a8a1381b529a01420de6e792a4a1e7bd58a626

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

commit 0d071af207002e9c2054bd60f85765942994e0ff
Author: MarcosPividori <marcos.pividori at gmail.com>
Date:   Mon Aug 29 18:33:04 2016 -0300

    Add more information on deprecated methods.


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

0d071af207002e9c2054bd60f85765942994e0ff
 src/mlpack/methods/neighbor_search/neighbor_search.hpp | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

diff --git a/src/mlpack/methods/neighbor_search/neighbor_search.hpp b/src/mlpack/methods/neighbor_search/neighbor_search.hpp
index fb06a22..313de90 100644
--- a/src/mlpack/methods/neighbor_search/neighbor_search.hpp
+++ b/src/mlpack/methods/neighbor_search/neighbor_search.hpp
@@ -467,24 +467,30 @@ class NeighborSearch
   size_t Scores() const { return scores; }
 
   //! Access whether or not search is done in naive linear scan mode.
-  //! Deprecated. Will be removed in mlpack 3.0.0.
+  //! Deprecated. Will be replaced in mlpack 3.0.0, by a new method:
+  //! NeighborSearchMode SearchMode().
   bool Naive() const { return naive; }
   //! Modify whether or not search is done in naive linear scan mode.
-  //! Deprecated. Will be removed in mlpack 3.0.0.
+  //! Deprecated. Will be replaced in mlpack 3.0.0, by a new method:
+  //! NeighborSearchMode& SearchMode().
   bool& Naive() { return naive; }
 
   //! Access whether or not search is done in single-tree mode.
-  //! Deprecated. Will be removed in mlpack 3.0.0.
+  //! Deprecated. Will be replaced in mlpack 3.0.0, by a new method:
+  //! NeighborSearchMode SearchMode().
   bool SingleMode() const { return singleMode; }
   //! Modify whether or not search is done in single-tree mode.
-  //! Deprecated. Will be removed in mlpack 3.0.0.
+  //! Deprecated. Will be replaced in mlpack 3.0.0, by a new method:
+  //! NeighborSearchMode& SearchMode().
   bool& SingleMode() { return singleMode; }
 
   //! Access whether or not search is done in greedy mode.
-  //! Deprecated. Will be removed in mlpack 3.0.0.
+  //! Deprecated. Will be replaced in mlpack 3.0.0, by a new method:
+  //! NeighborSearchMode SearchMode().
   bool Greedy() const { return greedy; }
   //! Modify whether or not search is done in greedy mode.
-  //! Deprecated. Will be removed in mlpack 3.0.0.
+  //! Deprecated. Will be replaced in mlpack 3.0.0, by a new method:
+  //! NeighborSearchMode& SearchMode().
   bool& Greedy() { return greedy; }
 
   //! Access the relative error to be considered in approximate search.