A mimetic poly-alloy of the Quicksilver scoring algorithm, essentially LiquidMetal. `</Schwarzenegger Voice>`
npm install liquidmetalA mimetic poly-alloy of the Quicksilver scoring algorithm, essentially
LiquidMetal.
Flex matching short abbreviations against longer strings is a boon in
productivity for typists. Applications like
Quicksilver, Alfred,
LaunchBar, and
Launchy have made this method of keyboard entry a
popular one. It's time to bring this same functionality to web controls.
LiquidMetal makes scoring long strings against abbreviations easy.
---
How You Can Help
![Square Cash][square]
![Gratipay][gratipay]
![Book a Codementor session][codementor]
If you like this project, [buy me a coffee][square], [donate via Gratipay][gratipay], or [book a session with me on Codementor][codementor].
Bitcoin: 1rmm5tv6f997JK5bLcGbRCZyVjZUPkQ2m
[square]: https://cash.me/$rmm5t "Donate to rmm5t for open source!"
[gratipay]: https://gratipay.com/rmm5t/ "Donate to rmm5t for open source!"
[bitcoin]: bitcoin:1rmm5tv6f997JK5bLcGbRCZyVjZUPkQ2m?amount=0.01&label=Coffee%20to%20rmm5t%20for%20Open%20Source "Buy rmm5t a coffee for open source!"
[codementor]: https://www.codementor.io/rmm5t?utm_campaign=profile&utm_source=button-rmm5t&utm_medium=shields "Book a session with rmm5t on Codementor!"
Include the library:
Score any string against an abbreviation:
LiquidMetal.score("FooBar", "foo") //=> 0.950
LiquidMetal.score("FooBar", "fb") //=> 0.917
LiquidMetal.score("Foo Bar", "fb") //=> 0.929
LiquidMetal.score("Foo Bar", "baz") //=> 0.0
LiquidMetal.score("Foo Bar", "") //=> 0.8
All scores fall between a range of 0.0 (no match) to 1.0 (perfect match).
* Quicksilver and its scoreForAbbreviation algorithm by Alcor
* Quicksilver.js by Lachie Cox
* To satisfy my own requirements for the
jquery.flexselect plugin
* The Quicksilver algorithm doesn't give proper weight to abbreviations that
match the first character of the scored string.
* The Quicksilver algorithm is extremely slow for certain length
string/abbreviation combinations because of its use of recursion. While
slightly slower for shorter length string/abbreviation combinations,
LiquidMetal outperforms the Quicksilver algorithm by orders of magnitude under
other conditions.
* The javascript version of the Quicksilver algorithm (Quicksilver.js) is case
sensitive and doesn't give added weight to camel case strings; whereas,
LiquidMetal is case insensitive and does give added weight to uppercase
letters in camel case strings.
* More tests
* Consider tweaking the scores for "trailing" characters
* Improve implementation of highest score matching (LiquidMetal
currently returns the highest scoring match for an abbreviation,
but is inefficient)
* See if it's possible to tune the performance further
Copyright (c) 2009-2014, Ryan McGeary (ryan -[at]- mcgeary [dot] org)