slayer/lib/algorithms/entropy.js

JavaScript time series spike detection for Node.js; like the Octave findpeaks function.

'use strict';

/**
 * entropy algorithm described as S4 in the following paper.
 *
 * Not yet complete.
 *
 * @param distance {Number} Number of elements to look around
 * @param item {Number} Item value to compare against its neighbourhood.
 * @param i {Number} Current index of `item` within `array`
 * @param array {Array.<Number>}
 * @returns {Number|null}
 */
 /* istanbul ignore next */
module.exports = function entropy(distance, item, i, array){
  return null;
};