double-metaphone

double-metaphone

Double metaphone algorithm in JavaScript. Includes few fixes and dead-code removal. 100% coverage (which hasn’t been done before). No cruft. Real fast.

Installation

npm:

$ npm install double-metaphone

Component:

$ component install wooorm/double-metaphone

Bower:

$ bower install double-metaphone

Usage

var doubleMetaphone = require('double-metaphone');

doubleMetaphone("michael"); // [ 'MKL', 'MXL' ]
doubleMetaphone("crevalle"); // [ 'KRFL', 'KRF' ]
doubleMetaphone("Filipowitz"); // [ 'FLPTS', 'FLPFX' ]
doubleMetaphone("Xavier"); // [ 'SF', 'SFR' ]
doubleMetaphone("delicious"); // [ 'TLSS', 'TLXS' ]
doubleMetaphone("acceptingness"); // ['AKSPTNNS', 'AKSPTNKNS]
doubleMetaphone("allegrettos"); // ['ALKRTS', 'AKRTS']

With stemmer:

var doubleMetaphone = require('double-metaphone');
var stemmer = require('stemmer');

doubleMetaphone(stemmer("acceptingness")); // [ 'AKSPTNK', 'AKSPTNK' ]
doubleMetaphone(stemmer("allegrettos")); // [ 'ALKRT', 'AKRT' ]

CLI

Install:

$ npm install --global double-metaphone

Use:

Usage: double-metaphone [options] string

Options:

  -h, --help           output usage information
  -v, --version        output version number

Usage:

  Note! The two results are tab seperated!

# output phonetics of given value
$ double-metaphone michael
# MKL	MXL

# output phonetics of stdin
$ echo "Xavier" | double-metaphone
# SF	SFR

Benchmark

On a MacBook Air, it runs about 390,000 op/s.

  390 op/s » op/s * 1,000

           doublemetaphone
  295 op/s » op/s * 1,000

           natural
  140 op/s » op/s * 1,000

License

MIT © Titus Wormer