number-hamming.js

//     wink-distance
//     Distance functions for Bag of Words, Strings,
//     Vectors and more.
//
//     Copyright (C) GRAYPE Systems Private Limited
//
//     This file is part of “wink-distance”.
//
//     Permission is hereby granted, free of charge, to any person obtaining a
//     copy of this software and associated documentation files (the "Software"),
//     to deal in the Software without restriction, including without limitation
//     the rights to use, copy, modify, merge, publish, distribute, sublicense,
//     and/or sell copies of the Software, and to permit persons to whom the
//     Software is furnished to do so, subject to the following conditions:
//
//     The above copyright notice and this permission notice shall be included
//     in all copies or substantial portions of the Software.
//
//     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
//     OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//     FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
//     THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//     FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
//     DEALINGS IN THE SOFTWARE.

/* eslint-disable no-bitwise */

// ## number

// ### hamming
/**
 *
 * Computes the the hamming distance between two numbers; each number is
 * assumed to be decimal representation of a binary number.
 *
 * @method number.hamming
 * @param {number} na the first number.
 * @param {number} nb the second number.
 * @return {number} hamming distance between `na` and `nb`.
 *
 * @example
 * hamming( 8, 8 );
 * // -> 0
 * hamming( 8, 15 );
 * // -> 3
 * hamming( 9, 15 );
 * // -> 2
 */
var hamming = function ( na, nb ) {
  // Initialize hamming distance.
  var distance = 0;
  // Compute hamming distance.
  for ( var xor = na ^ nb; xor > 0; distance += 1 ) xor &= ( xor - 1 );

  return distance;
}; // hamming()

module.exports = hamming;