[mlpack-svn] r14992 - mlpack/trunk/src/mlpack/methods/kmeans

[fastlab-svn at coffeetalk-1.cc.gatech.edu]

Author: rcurtin
Date: 2013-05-01 19:51:49 -0400 (Wed, 01 May 2013)
New Revision: 14992

Modified:
   mlpack/trunk/src/mlpack/methods/kmeans/kmeans.hpp
Log:
A notice that FastCluster() doesn't work.


Modified: mlpack/trunk/src/mlpack/methods/kmeans/kmeans.hpp
===================================================================
--- mlpack/trunk/src/mlpack/methods/kmeans/kmeans.hpp	2013-05-01 23:44:45 UTC (rev 14991)
+++ mlpack/trunk/src/mlpack/methods/kmeans/kmeans.hpp	2013-05-01 23:51:49 UTC (rev 14992)
@@ -142,6 +142,11 @@
                const bool initialAssignmentGuess = false,
                const bool initialCentroidGuess = false) const;
 
+  /**
+   * An implementation of k-means using the Pelleg-Moore algorithm; this is
+   * known to not work -- do not use it!  (Fixing it is TODO, of course; see
+   * #251.)
+   */
   template<typename MatType>
   void FastCluster(MatType& data,
                    const size_t clusters,