summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRocky Madden <git@rockymadden.com>2013-01-23 14:21:25 -0700
committerRocky Madden <git@rockymadden.com>2013-01-23 14:21:25 -0700
commitdbe5a31249ed52e1a47634a13d4cc97b95061709 (patch)
treecb071d975f31eac540572e0cc2ff66eba16f4f75
parentcd5271bf631656ea556a0bf4707e0eeb0fd275ae (diff)
downloadstringmetric-dbe5a31249ed52e1a47634a13d4cc97b95061709.tar.gz
stringmetric-dbe5a31249ed52e1a47634a13d4cc97b95061709.tar.bz2
stringmetric-dbe5a31249ed52e1a47634a13d4cc97b95061709.zip
Added NYSIIS examples.
-rwxr-xr-xreadme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 9649efe..08938eb 100755
--- a/readme.md
+++ b/readme.md
@@ -164,6 +164,30 @@ tm
n0
```
+__NYSIIS Metric:__
+```scala
+println(NysiisMetric.compare("ham", "hum"))
+println(NysiisMetric.compare("dumb", "gum"))
+```
+
+Output:
+```
+true
+false
+```
+
+__NYSIIS Algorithm:__
+```scala
+println(NysiisAlgorithm.compute("macintosh"))
+println(NysiisAlgorithm.compute("knuth"))
+```
+
+Output:
+```
+mcant
+nnat
+```
+
## Testing
```shell
$ gradle :stringmetric-core:test