Finds degree of similarity between two strings, based on Dice's Coefficient, which is mostly better than Levenshtein distance.
Installation
In a terminal or command line navigated to your project folder:
Code: Select all
npm install string-similarity.ahkCode: Select all
#Include %A_ScriptDir%\node_modules
#Include string-similarity.ahk\export.ahk
oStringSimilarity := new stringsimilarity()
oStringSimilarity.compareTwoStrings("test", "testing")
; => 0.67
oStringSimilarity.compareTwoStrings("Hello", "hello")
; => 1.0API
Including the module provides a class stringsimilarity with three methods: .compareTwoStrings, .findBestMatch, and .simpleBestMatch
compareTwoStrings(string1, string2)
Returns a fraction between 0 and 1, which indicates the degree of similarity between the two strings. 0 indicates completely different strings, 1 indicates identical strings. The comparison is case-insensitive.
Arguments
- string1 (string): The first string
- string2 (string): The second string
Returns
(Number): A fraction from 0 to 1, both inclusive. Higher number indicates more similarity.
Example
Code: Select all
stringSimilarity.compareTwoStrings("healed", "sealed")
; => 0.80
stringSimilarity.compareTwoStrings("Olive-green table for sale, in extremely good condition."
, "For sale: table in very good condition, olive green in colour.")
; => 0.71
stringSimilarity.compareTwoStrings("Olive-green table for sale, in extremely good condition."
, "For sale: green Subaru Impreza, 210,000 miles")
; => 0.30
stringSimilarity.compareTwoStrings("Olive-green table for sale, in extremely good condition."
, "Wanted: mountain bike with at least 21 gears.")
; => 0.11findBestMatch(mainString, targetStrings)
Compares mainString against each string in targetStrings.
Arguments
- mainString (string): The string to match each target string against.
- targetStrings (Array): Each string in this array will be matched against the main string.
Returns
(Object): An object with a ratings property, which gives a similarity rating for each target string, and a bestMatch property, which specifies which target string was most similar to the main string. The array of ratings are sorted from higest rating to lowest.
Example
Code: Select all
stringSimilarity.findBestMatch("Olive-green table for sale, in extremely good condition."
, ["For sale: green Subaru Impreza, 210,000 miles"
, "For sale: table in very good condition, olive green in colour."
, "Wanted: mountain bike with at least 21 gears."])
; =>
{ ratings:
[{ target: "For sale: table in very good condition, olive green in colour.",
rating: 0.71 },
{ target: "For sale: green Subaru Impreza, 210,000 miles",
rating: 0.30 },
{ target: "Wanted: mountain bike with at least 21 gears.",
rating: 0.11 }],
bestMatch:
{ target: "For sale: table in very good condition, olive green in colour.",
rating: 0.71 } }simpleBestMatch(mainString, targetStrings)
Compares mainString against each string in targetStrings.
Arguments
- mainString (string): The string to match each target string against.
- targetStrings (Array): Each string in this array will be matched against the main string.
Returns
(String): The string that was most similar to the first argument string.
Example
Code: Select all
stringSimilarity.simpleBestMatch("Hard to"
, [" hard to "
, "hard to"
, "Hard 2"])
; => "hard to"
), so I tried the following:
