CyberChef/src/core/operations/StandardDeviation.mjs

53 lines
1.4 KiB
JavaScript

/**
* @author bwhitn [brian.m.whitney@outlook.com]
* @author d98762625 [d98762625@gmail.com]
* @copyright Crown Copyright 2018
* @license Apache-2.0
*/
import BigNumber from "bignumber.js";
import Operation from "../Operation.mjs";
import { stdDev, createNumArray } from "../lib/Arithmetic.mjs";
import { ARITHMETIC_DELIM_OPTIONS } from "../lib/Delim.mjs";
/**
* Standard Deviation operation
*/
class StandardDeviation extends Operation {
/**
* StandardDeviation constructor
*/
constructor() {
super();
this.name = "Standard Deviation";
this.module = "Default";
this.description = "Computes the standard deviation of a number list. If an item in the string is not a number it is excluded from the list.<br><br>e.g. <code>0x0a 8 .5</code> becomes <code>4.089281382128433</code>";
this.infoURL = "https://wikipedia.org/wiki/Standard_deviation";
this.inputType = "string";
this.outputType = "BigNumber";
this.args = [
{
"name": "Delimiter",
"type": "option",
"value": ARITHMETIC_DELIM_OPTIONS,
}
];
}
/**
* @param {string} input
* @param {Object[]} args
* @returns {BigNumber}
*/
run(input, args) {
const val = stdDev(createNumArray(input, args[0]));
return BigNumber.isBigNumber(val) ? val : new BigNumber(NaN);
}
}
export default StandardDeviation;