summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRocky Madden <git@rockymadden.com>2013-03-09 15:06:00 -0700
committerRocky Madden <git@rockymadden.com>2013-03-09 15:06:00 -0700
commitad84413a4525a33247079c4bc148c642d26edc88 (patch)
tree87fdb7a1dd8de8250c3195c599799e9a23ad2a1e
parent532568e38856f277eb947c46239ed39b98216947 (diff)
downloadstringmetric-ad84413a4525a33247079c4bc148c642d26edc88.tar.gz
stringmetric-ad84413a4525a33247079c4bc148c642d26edc88.tar.bz2
stringmetric-ad84413a4525a33247079c4bc148c642d26edc88.zip
Fixed metrics missing curry.
-rwxr-xr-xreadme.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/readme.md b/readme.md
index b70ba5d..c290462 100755
--- a/readme.md
+++ b/readme.md
@@ -56,10 +56,10 @@ __Maven:__
Useful for approximate string matching and measurement of string distance. Most metrics calculate the similarity of two strings as a double with a value between 0 and 1. A value of 0 being completely different and a value of 1 being completely similar.
-__Dice / Sorensen Metric:__
+__Dice / Sorensen Metric:__ _(Note you must specify the size of the n-gram you wish to use. This can be done implicitly.)_
```scala
-println(DiceSorensenMetric.compare("night", "nacht"))
-println(DiceSorensenMetric.compare("context", "contact"))
+println(DiceSorensenMetric.compare("night", "nacht")(1))
+println(DiceSorensenMetric.compare("context", "contact")(1))
```
Output:
@@ -84,10 +84,10 @@ Output: _(Note the exception of integers, rather than doubles, being returned.)_
---
-__Jaccard Metric:__
+__Jaccard Metric:__ _(Note you must specify the size of the n-gram you wish to use. This can be done implicitly.)_
```scala
-println(JaccardMetric.compare("night", "nacht"))
-println(JaccardMetric.compare("context", "contact"))
+println(JaccardMetric.compare("night", "nacht")(1))
+println(JaccardMetric.compare("context", "contact")(1))
```
Output: