[mlpack-git] [mlpack] Move mlpack_allknn and mlpack_allkfn, but preserve old names (#532)

[Ryan Curtin]

The name `mlpack_allknn` is misleading: "allknn" means "all k-nearest-neighbors", but that implies that the query and reference sets are the same.  But that is not necessarily true.  So `mlpack_knn` would be a more apt name.  The same is true for `mlpack_allkfn` and `mlpack_kfn`.

These should be renamed in the CMake configuration, but also we want to preserve the old names as per https://github.com/mlpack/mlpack/blob/master/UPDATING.txt , so that a user can still use `mlpack_allknn` and `mlpack_allkfn` if their scripts depend on it.  (We can remove this backwards compatibility in either 2.1.0 or 3.0.0, I am not sure which yet.)

On Linux or UNIX-like systems, this is probably done easiest with a symlink, but on Windows I don't think this is possible so it may be necessary to make copies of the programs to preserve this support.

A patch here should be a modification to the project's CMake configuration and to the documentation throughout the project (i.e. the tutorials, the programs themselves, anywhere that references 'allknn' or 'allkfn').

---
Reply to this email directly or view it on GitHub:
https://github.com/mlpack/mlpack/issues/532
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mailman.cc.gatech.edu/pipermail/mlpack-git/attachments/20160301/e0bc8f54/attachment.html>