number-theory/lib/is_hexagonal.js

Number theory functions for javascript.

'use strict';

/**
  * Determines whether an integer is 'hexagonal'.
  * Algorithm works by finding the 'hexagonal root' of an int,
  * then checking whether the root's a whole number.
  * See: https://en.wikipedia.org/wiki/Hexagonal_number
  *
  * @param {Number} an integer x to test
  * @return {Boolean} Whether or not the x is hexagonal.
  * @module number-theory
  * @author Kelly Innes
  */

module.exports = function isHexagonal(n) {
  return ((Math.sqrt((8 * n) + 1) + 1) / 4) % 1 === 0;
};