You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by br...@apache.org on 2014/12/14 21:41:25 UTC
[6/8] [text] Correct method names in JavaDoc after port from Lang
Correct method names in JavaDoc after port from Lang
Project: http://git-wip-us.apache.org/repos/asf/commons-text/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-text/commit/1947f0cc
Tree: http://git-wip-us.apache.org/repos/asf/commons-text/tree/1947f0cc
Diff: http://git-wip-us.apache.org/repos/asf/commons-text/diff/1947f0cc
Branch: refs/heads/master
Commit: 1947f0ccf242670c683caaa68b17b42c53960dcd
Parents: 1d59629
Author: Benedikt Ritter <br...@apache.org>
Authored: Sun Dec 14 21:35:05 2014 +0100
Committer: Benedikt Ritter <br...@apache.org>
Committed: Sun Dec 14 21:35:05 2014 +0100
----------------------------------------------------------------------
.../commons/text/similarity/FuzzyDistance.java | 16 +++----
.../text/similarity/JaroWrinklerDistance.java | 28 ++++++-------
.../text/similarity/LevenshteinDistance.java | 44 ++++++++++----------
3 files changed, 44 insertions(+), 44 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-text/blob/1947f0cc/src/main/java/org/apache/commons/text/similarity/FuzzyDistance.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/FuzzyDistance.java b/src/main/java/org/apache/commons/text/similarity/FuzzyDistance.java
index 6d0eab3..4d175a0 100644
--- a/src/main/java/org/apache/commons/text/similarity/FuzzyDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/FuzzyDistance.java
@@ -57,14 +57,14 @@ public class FuzzyDistance implements StringMetric<Integer> {
* </p>
*
* <pre>
- * distance.getFuzzyDistance(null, null, null) = IllegalArgumentException
- * distance.getFuzzyDistance("", "", Locale.ENGLISH) = 0
- * distance.getFuzzyDistance("Workshop", "b", Locale.ENGLISH) = 0
- * distance.getFuzzyDistance("Room", "o", Locale.ENGLISH) = 1
- * distance.getFuzzyDistance("Workshop", "w", Locale.ENGLISH) = 1
- * distance.getFuzzyDistance("Workshop", "ws", Locale.ENGLISH) = 2
- * distance.getFuzzyDistance("Workshop", "wo", Locale.ENGLISH) = 4
- * distance.getFuzzyDistance("Apache Software Foundation", "asf", Locale.ENGLISH) = 3
+ * distance.compare(null, null, null) = IllegalArgumentException
+ * distance.compare("", "", Locale.ENGLISH) = 0
+ * distance.compare("Workshop", "b", Locale.ENGLISH) = 0
+ * distance.compare("Room", "o", Locale.ENGLISH) = 1
+ * distance.compare("Workshop", "w", Locale.ENGLISH) = 1
+ * distance.compare("Workshop", "ws", Locale.ENGLISH) = 2
+ * distance.compare("Workshop", "wo", Locale.ENGLISH) = 4
+ * distance.compare("Apache Software Foundation", "asf", Locale.ENGLISH) = 3
* </pre>
*
* @param term a full term that should be matched against, must not be null
http://git-wip-us.apache.org/repos/asf/commons-text/blob/1947f0cc/src/main/java/org/apache/commons/text/similarity/JaroWrinklerDistance.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/JaroWrinklerDistance.java b/src/main/java/org/apache/commons/text/similarity/JaroWrinklerDistance.java
index 3633d41..07fbc7e 100644
--- a/src/main/java/org/apache/commons/text/similarity/JaroWrinklerDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/JaroWrinklerDistance.java
@@ -47,20 +47,20 @@ public class JaroWrinklerDistance implements StringMetric<Double> {
* between two CharSequences.
*
* <pre>
- * distance.getJaroWinklerDistance(null, null) = IllegalArgumentException
- * distance.getJaroWinklerDistance("","") = 0.0
- * distance.getJaroWinklerDistance("","a") = 0.0
- * distance.getJaroWinklerDistance("aaapppp", "") = 0.0
- * distance.getJaroWinklerDistance("frog", "fog") = 0.93
- * distance.getJaroWinklerDistance("fly", "ant") = 0.0
- * distance.getJaroWinklerDistance("elephant", "hippo") = 0.44
- * distance.getJaroWinklerDistance("hippo", "elephant") = 0.44
- * distance.getJaroWinklerDistance("hippo", "zzzzzzzz") = 0.0
- * distance.getJaroWinklerDistance("hello", "hallo") = 0.88
- * distance.getJaroWinklerDistance("ABC Corporation", "ABC Corp") = 0.91
- * distance.getJaroWinklerDistance("D N H Enterprises Inc", "D & H Enterprises, Inc.") = 0.93
- * distance.getJaroWinklerDistance("My Gym Children's Fitness Center", "My Gym. Childrens Fitness") = 0.94
- * distance.getJaroWinklerDistance("PENNSYLVANIA", "PENNCISYLVNIA") = 0.9
+ * distance.compare(null, null) = IllegalArgumentException
+ * distance.compare("","") = 0.0
+ * distance.compare("","a") = 0.0
+ * distance.compare("aaapppp", "") = 0.0
+ * distance.compare("frog", "fog") = 0.93
+ * distance.compare("fly", "ant") = 0.0
+ * distance.compare("elephant", "hippo") = 0.44
+ * distance.compare("hippo", "elephant") = 0.44
+ * distance.compare("hippo", "zzzzzzzz") = 0.0
+ * distance.compare("hello", "hallo") = 0.88
+ * distance.compare("ABC Corporation", "ABC Corp") = 0.91
+ * distance.compare("D N H Enterprises Inc", "D & H Enterprises, Inc.") = 0.93
+ * distance.compare("My Gym Children's Fitness Center", "My Gym. Childrens Fitness") = 0.94
+ * distance.compare("PENNSYLVANIA", "PENNCISYLVNIA") = 0.9
* </pre>
*
* @param left the first String, must not be null
http://git-wip-us.apache.org/repos/asf/commons-text/blob/1947f0cc/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java b/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
index 3d1264e..5bd9d3e 100644
--- a/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
+++ b/src/main/java/org/apache/commons/text/similarity/LevenshteinDistance.java
@@ -57,17 +57,17 @@ public class LevenshteinDistance implements StringMetric<Integer> {
* </p>
*
* <pre>
- * distance.getLevenshteinDistance(null, *) = IllegalArgumentException
- * distance.getLevenshteinDistance(*, null) = IllegalArgumentException
- * distance.getLevenshteinDistance("","") = 0
- * distance.getLevenshteinDistance("","a") = 1
- * distance.getLevenshteinDistance("aaapppp", "") = 7
- * distance.getLevenshteinDistance("frog", "fog") = 1
- * distance.getLevenshteinDistance("fly", "ant") = 3
- * distance.getLevenshteinDistance("elephant", "hippo") = 7
- * distance.getLevenshteinDistance("hippo", "elephant") = 7
- * distance.getLevenshteinDistance("hippo", "zzzzzzzz") = 8
- * distance.getLevenshteinDistance("hello", "hallo") = 1
+ * distance.compare(null, *) = IllegalArgumentException
+ * distance.compare(*, null) = IllegalArgumentException
+ * distance.compare("","") = 0
+ * distance.compare("","a") = 1
+ * distance.compare("aaapppp", "") = 7
+ * distance.compare("frog", "fog") = 1
+ * distance.compare("fly", "ant") = 3
+ * distance.compare("elephant", "hippo") = 7
+ * distance.compare("hippo", "elephant") = 7
+ * distance.compare("hippo", "zzzzzzzz") = 8
+ * distance.compare("hello", "hallo") = 1
* </pre>
*
* @param left the first string, must not be null
@@ -101,17 +101,17 @@ public class LevenshteinDistance implements StringMetric<Integer> {
* </p>
*
* <pre>
- * distance.getLevenshteinDistance(null, *, *) = IllegalArgumentException
- * distance.getLevenshteinDistance(*, null, *) = IllegalArgumentException
- * distance.getLevenshteinDistance(*, *, -1) = IllegalArgumentException
- * distance.getLevenshteinDistance("","", 0) = 0
- * distance.getLevenshteinDistance("aaapppp", "", 8) = 7
- * distance.getLevenshteinDistance("aaapppp", "", 7) = 7
- * distance.getLevenshteinDistance("aaapppp", "", 6)) = -1
- * distance.getLevenshteinDistance("elephant", "hippo", 7) = 7
- * distance.getLevenshteinDistance("elephant", "hippo", 6) = -1
- * distance.getLevenshteinDistance("hippo", "elephant", 7) = 7
- * distance.getLevenshteinDistance("hippo", "elephant", 6) = -1
+ * distance.compare(null, *, *) = IllegalArgumentException
+ * distance.compare(*, null, *) = IllegalArgumentException
+ * distance.compare(*, *, -1) = IllegalArgumentException
+ * distance.compare("","", 0) = 0
+ * distance.compare("aaapppp", "", 8) = 7
+ * distance.compare("aaapppp", "", 7) = 7
+ * distance.compare("aaapppp", "", 6)) = -1
+ * distance.compare("elephant", "hippo", 7) = 7
+ * distance.compare("elephant", "hippo", 6) = -1
+ * distance.compare("hippo", "elephant", 7) = 7
+ * distance.compare("hippo", "elephant", 6) = -1
* </pre>
*
* @param left the first string, must not be null