math-utils-simple 2.1.0 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "math-utils-simple",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "A simple math utility library for npm",
   "type": "module",
   "main": "./src/index.js",

package/src/index.js

@@ -69,4 +69,19 @@ export { default as markup } from "./percentages/markup.js";
 export { default as profitPercentage } from "./percentages/profitPercentage.js";
 export { default as lossPercentage } from "./percentages/lossPercentage.js";
 export { default as margin } from "./percentages/margin.js";
-export { default as relativeChange } from "./percentages/relativeChange.js";
+export { default as relativeChange } from "./percentages/relativeChange.js";
+
+// STATISTICS
+export { default as sum } from "./statistics/sum.js";
+export { default as average } from "./statistics/average.js";
+export { default as median } from "./statistics/median.js";
+export { default as mode } from "./statistics/mode.js";
+export { default as range } from "./statistics/range.js";
+export { default as variance } from "./statistics/variance.js";
+export { default as standardDeviation } from "./statistics/standardDeviation.js";
+export { default as max } from "./statistics/max.js";
+export { default as min } from "./statistics/min.js";
+export { default as count } from "./statistics/count.js";
+export { default as frequency } from "./statistics/frequency.js";
+export { default as quartiles } from "./statistics/quartiles.js";
+export { default as interQuartileRange } from "./statistics/interQuartileRange.js";

package/src/statistics/average.js

@@ -0,0 +1,13 @@
+import sum from "./sum.js";
+
+export default function average(array) {
+  if (!Array.isArray(array)) {
+    throw new TypeError("Expected an array.");
+  }
+
+  if (array.length === 0) {
+    throw new Error("Cannot calculate average of an empty array.");
+  }
+
+  return sum(array) / array.length;
+}

package/src/statistics/count.js

@@ -0,0 +1,7 @@
+export default function count(array) {
+  if (!Array.isArray(array)) {
+    throw new TypeError("Expected an array.");
+  }
+
+  return array.length;
+}

package/src/statistics/frequency.js

@@ -0,0 +1,13 @@
+export default function frequency(array) {
+  if (!Array.isArray(array)) {
+    throw new TypeError("Expected an array.");
+  }
+
+  const result = {};
+
+  for (const value of array) {
+    result[value] = (result[value] || 0) + 1;
+  }
+
+  return result;
+}

package/src/statistics/interQuartileRange.js

@@ -0,0 +1,7 @@
+import quartiles from "./quartiles.js";
+
+export default function interQuartileRange(array) {
+  const { q1, q3 } = quartiles(array);
+
+  return q3 - q1;
+}

package/src/statistics/max.js

@@ -0,0 +1,19 @@
+export default function max(array) {
+  if (!Array.isArray(array)) {
+    throw new TypeError("Expected an array.");
+  }
+
+  if (array.length === 0) {
+    throw new Error("Cannot find maximum of an empty array.");
+  }
+
+  let largest = array[0];
+
+  for (const value of array) {
+    if (value > largest) {
+      largest = value;
+    }
+  }
+
+  return largest;
+}

package/src/statistics/median.js

@@ -0,0 +1,18 @@
+export default function median(array) {
+  if (!Array.isArray(array)) {
+    throw new TypeError("Expected an array.");
+  }
+
+  if (array.length === 0) {
+    throw new Error("Cannot calculate median of an empty array.");
+  }
+
+  const sorted = [...array].sort((a, b) => a - b);
+  const middle = Math.floor(sorted.length / 2);
+
+  if (sorted.length % 2 === 0) {
+    return (sorted[middle - 1] + sorted[middle]) / 2;
+  }
+
+  return sorted[middle];
+}

package/src/statistics/min.js

@@ -0,0 +1,19 @@
+export default function min(array) {
+  if (!Array.isArray(array)) {
+    throw new TypeError("Expected an array.");
+  }
+
+  if (array.length === 0) {
+    throw new Error("Cannot find minimum of an empty array.");
+  }
+
+  let smallest = array[0];
+
+  for (const value of array) {
+    if (value < smallest) {
+      smallest = value;
+    }
+  }
+
+  return smallest;
+}

package/src/statistics/mode.js

@@ -0,0 +1,38 @@
+export default function mode(array) {
+  if (!Array.isArray(array)) {
+    throw new TypeError("Expected an array.");
+  }
+
+  if (array.length === 0) {
+    throw new Error("Cannot calculate mode of an empty array.");
+  }
+
+  const counts = new Map();
+
+  for (const value of array) {
+    counts.set(value, (counts.get(value) || 0) + 1);
+  }
+
+  let maxFrequency = 0;
+
+  for (const frequency of counts.values()) {
+    if (frequency > maxFrequency) {
+      maxFrequency = frequency;
+    }
+  }
+
+  // No mode if every value occurs equally often.
+  if (maxFrequency === 1) {
+    return [];
+  }
+
+  const modes = [];
+
+  for (const [value, frequency] of counts) {
+    if (frequency === maxFrequency) {
+      modes.push(value);
+    }
+  }
+
+  return modes.sort((a, b) => a - b);
+}

package/src/statistics/quartiles.js

@@ -0,0 +1,37 @@
+import median from "./median.js";
+
+export default function quartiles(array) {
+  if (!Array.isArray(array)) {
+    throw new TypeError("Expected an array.");
+  }
+
+  if (array.length === 0) {
+    throw new Error("Cannot calculate quartiles of an empty array.");
+  }
+
+  const sorted = [...array].sort((a, b) => a - b);
+
+  const q2 = median(sorted);
+
+  const middle = Math.floor(sorted.length / 2);
+
+  let lowerHalf;
+  let upperHalf;
+
+  if (sorted.length % 2 === 0) {
+    lowerHalf = sorted.slice(0, middle);
+    upperHalf = sorted.slice(middle);
+  } else {
+    lowerHalf = sorted.slice(0, middle);
+    upperHalf = sorted.slice(middle + 1);
+  }
+
+  const q1 = median(lowerHalf);
+  const q3 = median(upperHalf);
+
+  return {
+    q1,
+    q2,
+    q3,
+  };
+}

package/src/statistics/range.js

@@ -0,0 +1,6 @@
+import min from "./min.js";
+import max from "./max.js";
+
+export default function range(array) {
+  return max(array) - min(array);
+}

package/src/statistics/standardDeviation.js

@@ -0,0 +1,5 @@
+import variance from "./variance.js";
+
+export default function standardDeviation(array) {
+  return Math.sqrt(variance(array));
+}

package/src/statistics/sum.js

@@ -0,0 +1,7 @@
+export default function sum(array) {
+  if (!Array.isArray(array)) {
+    throw new TypeError("Expected an array.");
+  }
+
+  return array.reduce((total, value) => total + value, 0);
+}

package/src/statistics/variance.js

@@ -0,0 +1,21 @@
+import average from "./average.js";
+
+export default function variance(array) {
+  if (!Array.isArray(array)) {
+    throw new TypeError("Expected an array.");
+  }
+
+  if (array.length === 0) {
+    throw new Error("Cannot calculate variance of an empty array.");
+  }
+
+  const mean = average(array);
+
+  let sum = 0;
+
+  for (const value of array) {
+    sum += (value - mean) ** 2;
+  }
+
+  return sum / array.length;
+}