diff options
author | Rocky Madden <git@rockymadden.com> | 2012-10-20 15:34:25 -0600 |
---|---|---|
committer | Rocky Madden <git@rockymadden.com> | 2012-10-20 15:34:25 -0600 |
commit | 9fbe4868503142a7bd2e502b393d3bd60fdb441c (patch) | |
tree | fa2cecb89e3868fecaeb3790e9706862decb7a51 /readme.md | |
parent | f95a07d2481a45ddd8d088651f9669900da51edd (diff) | |
download | stringmetric-9fbe4868503142a7bd2e502b393d3bd60fdb441c.tar.gz stringmetric-9fbe4868503142a7bd2e502b393d3bd60fdb441c.tar.bz2 stringmetric-9fbe4868503142a7bd2e502b393d3bd60fdb441c.zip |
Created Metaphone algorithm, metric, specs, and command.
Diffstat (limited to 'readme.md')
-rwxr-xr-x | readme.md | 7 |
1 files changed, 3 insertions, 4 deletions
@@ -5,6 +5,7 @@ A collection of string metrics implemented in Scala. Includes a light-weight cor * Jaro * Jaro-Winkler * Levenshtein +* Metaphone * Soundex ## Building the API @@ -15,11 +16,9 @@ gradle tar ## Using the API `// Import metric of choice.` -`import org.hashtree.stringmetric.JaroWinklerMetric` -`// Optionally import metric implicit stringCleaner into scope.` -`import org.hashtree.stringmetric.JaroWinklerMetric.stringCleaner` +`import org.hashtree.stringmetric.distance.JaroWinklerMetric` -`// Invoke metric compare method with implicit stringCleaner.` +`// Invoke metric compare method.` `val distance = JaroWinklerMetric.compare("string1", "string2")` `// Do something. In this case, distance is between 1.0f and 0.0f.` |