svn commit: r1327587 - /mahout/trunk/core/src/main/java/org/apache/mahout/clustering/iterator/ClusterIterator.java

[je...@apache.org]

Author: jeastman
Date: Wed Apr 18 17:12:44 2012
New Revision: 1327587

URL: http://svn.apache.org/viewvc?rev=1327587&view=rev
Log:
updated class comment and reformatted with 120 column widths

Modified:
    mahout/trunk/core/src/main/java/org/apache/mahout/clustering/iterator/ClusterIterator.java

Modified: mahout/trunk/core/src/main/java/org/apache/mahout/clustering/iterator/ClusterIterator.java
URL: http://svn.apache.org/viewvc/mahout/trunk/core/src/main/java/org/apache/mahout/clustering/iterator/ClusterIterator.java?rev=1327587&r1=1327586&r2=1327587&view=diff
==============================================================================
--- mahout/trunk/core/src/main/java/org/apache/mahout/clustering/iterator/ClusterIterator.java (original)
+++ mahout/trunk/core/src/main/java/org/apache/mahout/clustering/iterator/ClusterIterator.java Wed Apr 18 17:12:44 2012
@@ -42,19 +42,17 @@ import org.apache.mahout.math.VectorWrit
 import com.google.common.io.Closeables;
 
 /**
- * This is an experimental clustering iterator which works with a
- * ClusteringPolicy and a prior ClusterClassifier which has been initialized
- * with a set of models. To date, it has been tested with k-means and Dirichlet
- * clustering. See examples DisplayKMeans and DisplayDirichlet which have been
- * switched over to use it.
+ * This is a clustering iterator which works with a set of Vector data and a prior ClusterClassifier which has been
+ * initialized with a set of models. Its implementation is algorithm-neutral and works for any iterative clustering
+ * algorithm (currently k-means, fuzzy-k-means and Dirichlet) that processes all the input vectors in each iteration.
+ * The cluster classifier is configured with a ClusteringPolicy to select the desired clustering algorithm.
  */
 public class ClusterIterator {
   
   public static final String PRIOR_PATH_KEY = "org.apache.mahout.clustering.prior.path";
   
   /**
-   * Iterate over data using a prior-trained ClusterClassifier, for a number of
-   * iterations
+   * Iterate over data using a prior-trained ClusterClassifier, for a number of iterations
    * 
    * @param policy
    *          the ClusteringPolicy to use
@@ -90,8 +88,8 @@ public class ClusterIterator {
   }
   
   /**
-   * Iterate over data using a prior-trained ClusterClassifier, for a number of
-   * iterations using a sequential implementation
+   * Iterate over data using a prior-trained ClusterClassifier, for a number of iterations using a sequential
+   * implementation
    * 
    * @param inPath
    *          a Path to input VectorWritables
@@ -143,8 +141,8 @@ public class ClusterIterator {
   }
   
   /**
-   * Iterate over data using a prior-trained ClusterClassifier, for a number of
-   * iterations using a mapreduce implementation
+   * Iterate over data using a prior-trained ClusterClassifier, for a number of iterations using a mapreduce
+   * implementation
    * 
    * @param inPath
    *          a Path to input VectorWritables
@@ -199,8 +197,7 @@ public class ClusterIterator {
   }
   
   /**
-   * Return if all of the Clusters in the parts in the filePath have converged
-   * or not
+   * Return if all of the Clusters in the parts in the filePath have converged or not
    * 
    * @param filePath
    *          the file path to the single file containing the clusters