svn commit: r1392771 - /hama/trunk/ml/src/main/java/org/apache/hama/ml/distance/DistanceMeasurer.java

[to...@apache.org]

Author: tommaso
Date: Tue Oct  2 07:37:23 2012
New Revision: 1392771

URL: http://svn.apache.org/viewvc?rev=1392771&view=rev
Log:
[HAMA-650] - addeda javadoc to DistanceMeasurer

Modified:
    hama/trunk/ml/src/main/java/org/apache/hama/ml/distance/DistanceMeasurer.java

Modified: hama/trunk/ml/src/main/java/org/apache/hama/ml/distance/DistanceMeasurer.java
URL: http://svn.apache.org/viewvc/hama/trunk/ml/src/main/java/org/apache/hama/ml/distance/DistanceMeasurer.java?rev=1392771&r1=1392770&r2=1392771&view=diff
==============================================================================
--- hama/trunk/ml/src/main/java/org/apache/hama/ml/distance/DistanceMeasurer.java (original)
+++ hama/trunk/ml/src/main/java/org/apache/hama/ml/distance/DistanceMeasurer.java Tue Oct  2 07:37:23 2012
@@ -19,10 +19,27 @@ package org.apache.hama.ml.distance;
 
 import org.apache.hama.ml.math.DoubleVector;
 
+/**
+ * a {@link DistanceMeasurer} is responsible for calculating the distance between
+ * {@link DoubleVector}s or Arrays of {@code double}s
+ */
 public interface DistanceMeasurer {
 
+  /**
+   * Calculates the distance between two arrays of {@code double}s
+   * @param set1 an array of {@code double}
+   * @param set2 an array of {@code double}
+   * @return a {@code double} representing the distance
+   */
   public double measureDistance(double[] set1, double[] set2);
 
+
+  /**
+   * Calculates the distance between two {@link DoubleVector}ss
+   * @param vec1 a {@link DoubleVector}
+   * @param vec2 a {@link DoubleVector}
+   * @return a {@code double} representing the distance
+   */
   public double measureDistance(DoubleVector vec1, DoubleVector vec2);
 
 }