Example of Jaccard.similarity(profile1, profile2)

Author: tdebatty

src/main/java/info/debatty/java/stringsimilarity/Jaccard.java

@@ -69,8 +69,21 @@ public double similarity(String s1, String s2) {
         return similarity(ks.getProfile(s1), ks.getProfile(s2));
     }
 
+    /**
+     * Compute and return the Jaccard index similarity between two string profiles.
+     * 
+     * E.g:
+     * ks = new KShingling(4)
+     * profile1 = ks.getProfile("My String")
+     * profile2 = ks.getProfile("My other string")
+     * similarity = jaccard.similarity(profile1, profile2)
+     * 
+     * @param profile1
+     * @param profile2
+     * @return 
+     */
     public double similarity(HashMap<String,Integer> profile1,
-            HashMap<String,Integer> profile2) {
+        HashMap<String,Integer> profile2) {
         Set<String> set1 = profile1.keySet();
         Set<String> set2 = profile2.keySet();
 

src/main/java/info/debatty/java/stringsimilarity/SorensenDice.java

@@ -24,7 +24,6 @@
 
 package info.debatty.java.stringsimilarity;
 
-import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Set;