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

def

pull/7/head
matthieugomez 2018-05-17 11:12:55 -04:00
parent a253261d39
commit 87f1a4e9af
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -6,8 +6,8 @@ This Julia package computes various distances between strings.
## Syntax
The package defines two functions:
- The function `evaluate` return the distance between two strings.
- The function `compare` returns a similarity score between two strings. The similarity score is inversely related to the distance, and is always between 0 and 1. A value of 0 being completely different and a value of 1 being completely similar.
- The function `evaluate` return the litteral distance between two strings.
- The function `compare` returns a similarity score between two strings, which is based on the inverse of the distance. The function always returns a score between 0 and 1, with a value of 0 being completely different and a value of 1 being completely similar.
```julia