mirrors
/
StringDistances.jl
mirror of https://github.com/matthieugomez/StringDistances.jl.git
1
0
Fork 0
Code Issues Releases Wiki Activity

evaluate examples

pull/7/head
matthieugomez 2018-05-17 11:25:51 -04:00
parent 28ef77ea5f
commit b7097c868d
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -95,8 +95,14 @@ The package includes distance "modifiers", that can be applied to any distance.
```
## Evaluate vs Compare
The function `evaluate` returns the litteral distance between two strings, with a value of 0 being completely similar.
The function `compare` is the opposite of `evaluate': a value of 0 means completely different and a value of 1 means completely similar.
The function `compare` is the opposite of `evaluate`: a value of 0 means completely different and a value of 1 means completely similar.
```
evaluate(Levenshtein(), "New York", "New York")
#> 0
compare(Levenshtein(), "New York", "New York")
#> 1.0
```
## Which distance should I use?