summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRocky Madden <git@rockymadden.com>2013-03-08 11:34:02 -0700
committerRocky Madden <git@rockymadden.com>2013-03-08 11:34:02 -0700
commita5e9796ba2ee02c5e3dcb3e2addc9721bc2f41e1 (patch)
treedc9aa004dd381ea45b2d769c3daff7624e30f966
parent82e8891ecc8a7b8f350f4662c35e591db3880236 (diff)
downloadstringmetric-a5e9796ba2ee02c5e3dcb3e2addc9721bc2f41e1.tar.gz
stringmetric-a5e9796ba2ee02c5e3dcb3e2addc9721bc2f41e1.tar.bz2
stringmetric-a5e9796ba2ee02c5e3dcb3e2addc9721bc2f41e1.zip
Merged todo section.
-rwxr-xr-xreadme.md16
1 files changed, 7 insertions, 9 deletions
diff --git a/readme.md b/readme.md
index 35d8686..39b2b3f 100755
--- a/readme.md
+++ b/readme.md
@@ -3,19 +3,25 @@ String metrics and phonetic algorithms for Scala. The library provides facilitie
## Metrics and Algorithms
* __[Dice / Sorensen](http://en.wikipedia.org/wiki/Dice%27s_coefficient)__ (Similarity metric)
+* __[Double Metaphone](http://en.wikipedia.org/wiki/Metaphone)__ (On roadmap)
* __[Hamming](http://en.wikipedia.org/wiki/Hamming_distance)__ (Similarity metric)
+* __[Jaccard](http://en.wikipedia.org/wiki/Jaccard_index)__ (On roadmap)
* __[Jaro](http://en.wikipedia.org/wiki/Jaro-Winkler_distance)__ (Similarity metric)
* __[Jaro-Winkler](http://en.wikipedia.org/wiki/Jaro-Winkler_distance)__ (Similarity metric)
* __[Levenshtein](http://en.wikipedia.org/wiki/Levenshtein_distance)__ (Similarity metric)
* __[Metaphone](http://en.wikipedia.org/wiki/Metaphone)__ (Phonetic metric and algorithm)
+* __[Monge-Elkan](http://www.cs.cmu.edu/~pradeepr/papers/ijcai03.pdf)__ (On roadmap)
+* __[Needleman-Wunch](http://en.wikipedia.org/wiki/Needleman%E2%80%93Wunsch_algorithm)__ (On roadmap)
* __[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)
+* __[Smith-Waterman](http://en.wikipedia.org/wiki/Smith%E2%80%93Waterman_algorithm)__ (On roadmap)
* __[Soundex](http://en.wikipedia.org/wiki/Soundex)__ (Phonetic metric and algorithm)
* __Weighted Levenshtein__ (Similarity metric)
+
## Installation
Available on the [Maven Central Repository](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.rockymadden.stringmetric%22). Depending on the core sub-project shown below (add others, like the CLI, as needed):
@@ -361,7 +367,7 @@ println(StringMetric.compareWithSoundex("night", "nacht"))
```
## Decorating
-It is possible to decorate algorithms and metrics with additional functionality. The most common decorations are filters, which are useful for filtering strings prior to evaluation (e.g. ignore case, ignore non-alpha, ignore spaces).
+It is possible to decorate algorithms and metrics with additional functionality. The most common decorations are filters, which are useful for filtering strings prior to evaluation (e.g. ignore case, ignore non-alpha, ignore spaces). __NOTE:__ Memoization decorator on roadmap.
---
@@ -491,14 +497,6 @@ $ metaphoneAlgorithm dog
tk
```
-## Todo
-* SmithWaterman
-* MongeElkan
-* NeedlemanWunch
-* Jaccard
-* Double Metaphone
-* Memoization decorator
-
## Requirements
* Scala 2.10.x
* Gradle 1.x