- Developer getting started
- General Description
- Soundex Notes
In your project
npm install --save '@kba/simmetrics'
This module exports the file tree in
./lib as an object, i.e. relative path
./lib equals object path:
var simmetrics = ;var MogenElkan = simmetricssimilaritymetricsMongeElkan;…
- Make this library produce the same values as the java version (important!) So far this means better results for
- Automated testing
- Work with node.js
- Adding SmithWatermanGotoh metrics support.
- Actually export the functions
- Fix syntax errors
- Fixed tests
combined with previous versions, the above focus points are in place (node.js support, testing, certain metrics) and is now published as an npm module (and I changed the name of the repo to match). This version just updates the readme.
test folderSee the
simmetrics.test.js is a good place to start.
Developer getting started
npm install npm install -g mocha
and then to run all the tests:
- The following metrics still seem to generate different answers than the java version, and need to be corrected.
Although this is designed for Node.js, I will provide a browser version sometime in the future (or if anyone would like to contribute one).
So far, nearly all parts of the library have been ported. Algorithms left to be added are:
I should have those up very soon.
A note I should make:
I did not include the original timing tests for each one. I think they are unnecessary. However, as they can be useful sometimes, I will include them sometime as seperate modules which can be merged into the algorithms.
Soundex works as an object created by new, in which case the normal soundex
function is called as
instance.soundex(input[, length]); OR you can simply
call the Soundex function directly as
Also, it does not include the hyphen between the leading letter and the soundex numbers.