Return-Path: X-Original-To: apmail-hama-commits-archive@www.apache.org Delivered-To: apmail-hama-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 37B3F98A3 for ; Tue, 2 Oct 2012 07:38:14 +0000 (UTC) Received: (qmail 77576 invoked by uid 500); 2 Oct 2012 07:38:12 -0000 Delivered-To: apmail-hama-commits-archive@hama.apache.org Received: (qmail 77485 invoked by uid 500); 2 Oct 2012 07:38:10 -0000 Mailing-List: contact commits-help@hama.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@hama.apache.org Delivered-To: mailing list commits@hama.apache.org Received: (qmail 77457 invoked by uid 99); 2 Oct 2012 07:38:09 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 02 Oct 2012 07:38:09 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 02 Oct 2012 07:38:07 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 7CE6A23889C5 for ; Tue, 2 Oct 2012 07:37:23 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1392771 - /hama/trunk/ml/src/main/java/org/apache/hama/ml/distance/DistanceMeasurer.java Date: Tue, 02 Oct 2012 07:37:23 -0000 To: commits@hama.apache.org From: tommaso@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20121002073723.7CE6A23889C5@eris.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); }