diff options
| author | Alexander Pickering <alexandermpickering@gmail.com> | 2016-06-03 04:10:09 -0400 |
|---|---|---|
| committer | Alexander Pickering <alexandermpickering@gmail.com> | 2016-06-03 04:10:09 -0400 |
| commit | 335da258f84a16233d3e7daaf382534a268af118 (patch) | |
| tree | 017a4dfd062a0604f6dc7022db341cf352a2ac2d | |
| parent | 40de7a8474e6013602d6ee38a6b1cedf1d9e14ce (diff) | |
| download | fuzzel-335da258f84a16233d3e7daaf382534a268af118.tar.gz fuzzel-335da258f84a16233d3e7daaf382534a268af118.tar.bz2 fuzzel-335da258f84a16233d3e7daaf382534a268af118.zip | |
Made documentation a little more descriptive
| -rw-r--r-- | fuzzel.lua | 8 |
1 files changed, 4 insertions, 4 deletions
@@ -12,7 +12,7 @@ fuzzel.LevenshtienDistance(string_first, strings_second) Calculates the "real" Levenshtien Distance - returns number distance + returns number_distance fuzzel.LevensteinRatio(string_first, string_second) The Levenshtien Ratio divided by the first string's length. Useing a ratio is a decent way to determin if a spelling is "close enough" @@ -28,15 +28,15 @@ fuzzel.DamerauLevenshtienRatio(string_first, string_second) The Damerau-Levenshtien Distance divided by the first string's length - returns number + returns number_ratio fuzzel.HammingDistance(string_first, string_second) Purely the number of substitutions needed to change one string into another. Note that both strings must be the same length. - returns number + returns number_distance fuzzel.HammingRatio(string_first, string_second) The hamming distance divided by the length of the first string - returns number + returns number_ratio fuzzel.FuzzySearchDistance(string_needle, vararg_in) in may be either a table, or a list of arguments. fuzzel.FuzzySearchDistance will find the string that most closely resembles needle, based on Damerau-Levenshtien Distance |
