Package Exports

compute-hamming

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (compute-hamming) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Hamming Distance

Computes the Hamming distance between two sequences.

In information theory, the Hamming distance is number of differences between two sequences of the same length. These sequences may be represented as character strings, binary strings, or arrays.

Installation

$ npm install compute-hamming

For use in the browser, use browserify.

Usage

To use the module,

var hamming = require( 'compute-hamming' );

Examples

var a = 'this is a string.',
    b = 'thiz iz a string.';

console.log( hamming( a, b ) );
// Returns 2

var c = [ 5, 23, 2, 5, 9 ],
    d = [ 3, 21, 2, 5, 14 ];

console.log( hamming( c, d ) );
// Returns 3

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ open reports/coverage/lcov-report/index.html

License

MIT license.

compute-hamming