summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorRocky Madden <git@rockymadden.com>2013-01-23 14:39:25 -0700
committerRocky Madden <git@rockymadden.com>2013-01-23 14:39:25 -0700
commit73ce75fa7fc89ca2d4b012dd6a4af6119fb32426 (patch)
treebaa66370f6e84e4b1084f60669fe45225520076f /readme.md
parent3f7acdffbed47acf1563716ad9af30bda9d042b4 (diff)
downloadstringmetric-73ce75fa7fc89ca2d4b012dd6a4af6119fb32426.tar.gz
stringmetric-73ce75fa7fc89ca2d4b012dd6a4af6119fb32426.tar.bz2
stringmetric-73ce75fa7fc89ca2d4b012dd6a4af6119fb32426.zip
Added filter package information.
Diffstat (limited to 'readme.md')
-rwxr-xr-xreadme.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 9a600b5..df457b1 100755
--- a/readme.md
+++ b/readme.md
@@ -267,6 +267,24 @@ r163
l222
```
+## Filter package
+Useful for filtering strings prior to evaluation (e.g. ignore case, ignore non-alpha, ignore spaces). Filters can be used implicitly.
+
+Basic example with no filtering:
+```scala
+JaroWinklerMetric.compare("string1", "string2")
+```
+
+Basic example with single filter:
+```scala
+JaroWinklerMetric.compare("string1", "string2")(new StringFilterDelegate with AsciiLetterCaseStringFilter)
+```
+
+Basic example with stacked filter. Filters are applied in reverse order:
+```scala
+JaroWinklerMetric.compare("string1", "string2")(new StringFilterDelegate with AsciiLetterCaseStringFilter with AsciiLetterOnlyStringFilter)
+```
+
## Todo
* SmithWaterman
* MongeElkan