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

Update README.md

compathelper/new_version/2020-10-08-17-05-17-769-1797568811
matthieugomez 2020-07-13 08:59:33 -07:00
parent 77afc0d4fb
commit 5b768bd8e1
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -5,6 +5,9 @@
The package is registered in the [`General`](https://github.com/JuliaRegistries/General) registry and so can be installed at the REPL with `] add StringDistances`.
## Supported Distances
Each distance can be computed on iterators that defines a `length` function (which includes `AbstractStrings`, `graphemes` and `AbstractVector`)
The available distances are:
- Edit Distances
@ -42,11 +45,6 @@ evaluate(Levenshtein(), "martha", "marhta")
Levenshtein()("martha", "marhta")
```
You can also compute a distance between two iterators:
```julia
evaluate(Levenshtein(), [1, 5, 6], [1, 6, 5])
2
```
### Compare
The function `compare` is defined as 1 minus the normalized distance between two strings. It always returns a `Float64` between 0 and 1: a value of 0 means completely different and a value of 1 means completely similar.