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

compare

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

4
README.md
View File

@ -94,7 +94,9 @@ The package includes distance "modifiers", that can be applied to any distance.
#> 0.855
```
## Evaluate vs Compare
The function `evaluate` returns the litteral distance between two strings, with a value of 0 being completely similar. In contrast, the function `compare` always returns a score between 0 and 1, with a value of 0 being completely different and a value of 1 being completely similar.
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.
## Which distance should I use?