summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorRocky Madden <git@rockymadden.com>2013-01-10 12:59:59 -0700
committerRocky Madden <git@rockymadden.com>2013-01-10 12:59:59 -0700
commit2b1ee6b4f3d548414e0513149c727a640f4548fe (patch)
tree97963f86cb3563b801fd5c6de5f6d9b259e35334 /readme.md
parent5ba0d76e0266b6ad7ac9b1d3db4e04f04550ef50 (diff)
downloadstringmetric-2b1ee6b4f3d548414e0513149c727a640f4548fe.tar.gz
stringmetric-2b1ee6b4f3d548414e0513149c727a640f4548fe.tar.bz2
stringmetric-2b1ee6b4f3d548414e0513149c727a640f4548fe.zip
Created Ratcliff/Obershelp metric, command, and specs.
Diffstat (limited to 'readme.md')
-rwxr-xr-xreadme.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/readme.md b/readme.md
index 4e7b665..d23c90b 100755
--- a/readme.md
+++ b/readme.md
@@ -12,6 +12,7 @@ A Scala library of string metrics and phonetic algorithms. It provides implement
* __[Metaphone](http://en.wikipedia.org/wiki/Metaphone)__ (Phonetic metric and algorithm)
* __[N-Gram](http://en.wikipedia.org/wiki/N-gram)__ (Similarity metric and algorithm)
* __[NYSIIS](http://en.wikipedia.org/wiki/New_York_State_Identification_and_Intelligence_System)__ (Phonetic metric and algorithm)
+* __[Ratcliff / Obershelp](http://xlinux.nist.gov/dads/HTML/ratcliffObershelp.html)__ (Similarity metric)
* __[Refined NYSIIS](http://www.markcrocker.com/rexxtipsntricks/rxtt28.2.0482.html)__ (Phonetic metric and algorithm)
* __[Refined Soundex](http://ntz-develop.blogspot.com/2011/03/phonetic-algorithms.html)__ (Phonetic metric and algorithm)
* __[Soundex](http://en.wikipedia.org/wiki/Soundex)__ (Phonetic metric and algorithm)
@@ -43,10 +44,10 @@ if (distance >= 0.9) println("It's likely you're a match!")
You can also use the StringMetric, StringAlgorithm, and StringFilter convenience objects:
```scala
-if (StringMetric.compareWithJaroWinkler("string1", "string2") >= 0.9)
+if (StringMetric.compareWithJaroWinkler("string1", "string2") >= 0.9)
println("It's likely you're a match!")
-
-if (StringMetric.compareWithJaroWinkler("string1", "string2")(StringFilter.asciiLetterCase) >= 0.9)
+
+if (StringMetric.compareWithJaroWinkler("string1", "string2")(StringFilter.asciiLetterCase) >= 0.9)
println("It's likely you're a match!")
```
@@ -69,7 +70,7 @@ $ metaphoneMetric abc xyz
```
Get the phonetic representation of "abc" using the Metaphone phonetic algorithm:
-```shell
+```shell
$ metaphoneAlgorithm abc
```
@@ -121,4 +122,4 @@ Available on the [Maven Central Repository](http://search.maven.org/#search%7Cga
* Memoization decorator
## Questions and Comments
-Reach me at <stringmetric@rockymadden.com>. \ No newline at end of file
+Reach me at <stringmetric@rockymadden.com>.