svn commit: r1066055 - /mahout/trunk/core/src/main/java/org/apache/mahout/clustering/kmeans/KMeansClusterMapper.java

[gs...@apache.org]

Author: gsingers
Date: Tue Feb  1 14:37:46 2011
New Revision: 1066055

URL: http://svn.apache.org/viewvc?rev=1066055&view=rev
Log:
Add javadocs

Modified:
    mahout/trunk/core/src/main/java/org/apache/mahout/clustering/kmeans/KMeansClusterMapper.java

Modified: mahout/trunk/core/src/main/java/org/apache/mahout/clustering/kmeans/KMeansClusterMapper.java
URL: http://svn.apache.org/viewvc/mahout/trunk/core/src/main/java/org/apache/mahout/clustering/kmeans/KMeansClusterMapper.java?rev=1066055&r1=1066054&r2=1066055&view=diff
==============================================================================
--- mahout/trunk/core/src/main/java/org/apache/mahout/clustering/kmeans/KMeansClusterMapper.java (original)
+++ mahout/trunk/core/src/main/java/org/apache/mahout/clustering/kmeans/KMeansClusterMapper.java Tue Feb  1 14:37:46 2011
@@ -30,6 +30,13 @@ import org.apache.mahout.clustering.Weig
 import org.apache.mahout.common.distance.DistanceMeasure;
 import org.apache.mahout.math.VectorWritable;
 
+/**
+ * The {@link org.apache.mahout.clustering.kmeans.KMeansClusterMapper} is responsible for calculating which points belong
+ * to which clusters and outputting the information.  This is an optional step, as some applications only care about
+ * what the Centroids are.
+ *
+ * @see KMeansDriver for more information on how to invoke this process
+ */
 public class KMeansClusterMapper extends Mapper<WritableComparable<?>,VectorWritable,IntWritable,WeightedVectorWritable> {
   
   private final Collection<Cluster> clusters = new ArrayList<Cluster>();