math-utils-simple 3.0.0 → 4.0.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "math-utils-simple",
-  "version": "3.0.0",
-  "description": "A simple math utility library for npm",
+  "version": "4.0.1",
+  "description": "Math utility library for npm",
   "type": "module",
   "main": "./src/index.js",
   "exports": {
@@ -16,6 +16,14 @@
     "npm",
     "library"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/umar-farooq-5757/math-utils-simple.git"
+  },
+  "bugs": {
+    "url": "https://github.com/umar-farooq-5757/math-utils-simple/issues"
+  },
+  "homepage": "https://github.com/umar-farooq-5757/math-utils-simple#readme",
   "author": "Umar Farooq",
   "license": "MIT"
 }

package/src/arrays/angleBetweenVectors.js

@@ -0,0 +1,9 @@
+import cosineSimilarity from "./cosineSimilarity.js";
+
+export default function angleBetweenVectors(a, b) {
+  const cosine = cosineSimilarity(a, b);
+
+  return Math.acos(
+    Math.min(1, Math.max(-1, cosine))
+  );
+}

package/src/arrays/cosineSimilarity.js

@@ -0,0 +1,13 @@
+import dotProduct from "./dotProduct.js";
+import vectorMagnitude from "./vectorMagnitude.js";
+
+export default function cosineSimilarity(a, b) {
+  const magA = vectorMagnitude(a);
+  const magB = vectorMagnitude(b);
+
+  if (magA === 0 || magB === 0) {
+    throw new Error("Cannot calculate similarity for a zero vector.");
+  }
+
+  return dotProduct(a, b) / (magA * magB);
+}

package/src/arrays/crossProduct.js

@@ -0,0 +1,15 @@
+export default function crossProduct(a, b) {
+  if (!Array.isArray(a) || !Array.isArray(b)) {
+    throw new TypeError("Expected two arrays.");
+  }
+
+  if (a.length !== 3 || b.length !== 3) {
+    throw new Error("Cross product requires two 3-dimensional vectors.");
+  }
+
+  return [
+    a[1] * b[2] - a[2] * b[1],
+    a[2] * b[0] - a[0] * b[2],
+    a[0] * b[1] - a[1] * b[0],
+  ];
+}

package/src/arrays/cumulativeSum.js

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

package/src/arrays/dotProduct.js

@@ -0,0 +1,17 @@
+export default function dotProduct(a, b) {
+  if (!Array.isArray(a) || !Array.isArray(b)) {
+    throw new TypeError("Expected two arrays.");
+  }
+
+  if (a.length !== b.length) {
+    throw new Error("Arrays must have the same length.");
+  }
+
+  let result = 0;
+
+  for (let i = 0; i < a.length; i++) {
+    result += a[i] * b[i];
+  }
+
+  return result;
+}

package/src/arrays/elementWiseAdd.js

@@ -0,0 +1,11 @@
+export default function elementWiseAdd(a, b) {
+  if (!Array.isArray(a) || !Array.isArray(b)) {
+    throw new TypeError("Expected two arrays.");
+  }
+
+  if (a.length !== b.length) {
+    throw new Error("Arrays must have the same length.");
+  }
+
+  return a.map((value, index) => value + b[index]);
+}

package/src/arrays/elementWiseDivide.js

@@ -0,0 +1,13 @@
+export default function elementWiseDivide(a, b) {
+  if (a.length !== b.length) {
+    throw new Error("Arrays must have the same length.");
+  }
+
+  return a.map((value, index) => {
+    if (b[index] === 0) {
+      throw new Error("Division by zero.");
+    }
+
+    return value / b[index];
+  });
+}

package/src/arrays/elementWiseMultiply.js

@@ -0,0 +1,11 @@
+export default function elementWiseMultiply(a, b) {
+  if (!Array.isArray(a) || !Array.isArray(b)) {
+    throw new TypeError("Expected two arrays.");
+  }
+
+  if (a.length !== b.length) {
+    throw new Error("Arrays must have the same length.");
+  }
+
+  return a.map((value, index) => value * b[index]);
+}

package/src/arrays/elementWiseSubtract.js

@@ -0,0 +1,7 @@
+export default function elementWiseSubtract(a, b) {
+  if (a.length !== b.length) {
+    throw new Error("Arrays must have the same length.");
+  }
+
+  return a.map((value, index) => value - b[index]);
+}

package/src/arrays/matrixMultiply.js

@@ -0,0 +1,26 @@
+export default function matrixMultiply(a, b) {
+  const rowsA = a.length;
+  const colsA = a[0].length;
+
+  const rowsB = b.length;
+  const colsB = b[0].length;
+
+  if (colsA !== rowsB) {
+    throw new Error("Matrix dimensions are incompatible.");
+  }
+
+  const result = Array.from(
+    { length: rowsA },
+    () => Array(colsB).fill(0)
+  );
+
+  for (let i = 0; i < rowsA; i++) {
+    for (let j = 0; j < colsB; j++) {
+      for (let k = 0; k < colsA; k++) {
+        result[i][j] += a[i][k] * b[k][j];
+      }
+    }
+  }
+
+  return result;
+}

package/src/arrays/movingAverage.js

@@ -0,0 +1,23 @@
+export default function movingAverage(array, window) {
+  if (!Array.isArray(array)) {
+    throw new TypeError("Expected an array.");
+  }
+
+  if (window <= 0 || window > array.length) {
+    throw new Error("Invalid window size.");
+  }
+
+  const result = [];
+
+  for (let i = 0; i <= array.length - window; i++) {
+    let sum = 0;
+
+    for (let j = 0; j < window; j++) {
+      sum += array[i + j];
+    }
+
+    result.push(sum / window);
+  }
+
+  return result;
+}

package/src/arrays/normalizeVector.js

@@ -0,0 +1,15 @@
+export default function normalize(array) {
+  if (!Array.isArray(array)) {
+    throw new TypeError("Expected an array.");
+  }
+
+  const magnitude = Math.sqrt(
+    array.reduce((sum, value) => sum + value * value, 0)
+  );
+
+  if (magnitude === 0) {
+    throw new Error("Cannot normalize a zero vector.");
+  }
+
+  return array.map(value => value / magnitude);
+}

package/src/arrays/projectVector.js

@@ -0,0 +1,13 @@
+import dotProduct from "./dotProduct.js";
+
+export default function projectVector(a, b) {
+  const denominator = dotProduct(b, b);
+
+  if (denominator === 0) {
+    throw new Error("Cannot project onto a zero vector.");
+  }
+
+  const scalar = dotProduct(a, b) / denominator;
+
+  return b.map(value => scalar * value);
+}

package/src/arrays/scalarDivide.js

@@ -0,0 +1,7 @@
+export default function scalarDivide(array, scalar) {
+  if (scalar === 0) {
+    throw new Error("Division by zero.");
+  }
+
+  return array.map(value => value / scalar);
+}

package/src/arrays/scalarMultiply.js

@@ -0,0 +1,3 @@
+export default function scalarMultiply(array, scalar) {
+  return array.map(value => value * scalar);
+}

package/src/arrays/transpose.js

@@ -0,0 +1,20 @@
+export default function transpose(matrix) {
+  if (matrix.length === 0) {
+    return [];
+  }
+
+  const rows = matrix.length;
+  const cols = matrix[0].length;
+
+  const result = [];
+
+  for (let col = 0; col < cols; col++) {
+    result[col] = [];
+
+    for (let row = 0; row < rows; row++) {
+      result[col][row] = matrix[row][col];
+    }
+  }
+
+  return result;
+}

package/src/arrays/vectorDistance.js

@@ -0,0 +1,11 @@
+import vectorMagnitude from "./vectorMagnitude.js";
+
+export default function vectorDistance(a, b) {
+  if (a.length !== b.length) {
+    throw new Error("Vectors must have the same length.");
+  }
+
+  const difference = a.map((value, index) => value - b[index]);
+
+  return vectorMagnitude(difference);
+}

package/src/arrays/vectorMagnitude.js

@@ -0,0 +1,5 @@
+export default function vectorMagnitude(array) {
+  return Math.sqrt(
+    array.reduce((sum, value) => sum + value * value, 0)
+  );
+}

package/src/index.js

@@ -84,4 +84,45 @@ 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";
+export { default as interQuartileRange } from "./statistics/interQuartileRange.js";
+
+// ARRAYS
+export { default as dotProduct } from "./arrays/dotProduct.js";
+export { default as crossProduct } from "./arrays/crossProduct.js";
+export { default as elementWiseAdd } from "./arrays/elementWiseAdd.js";
+export { default as elementWiseSubtract } from "./arrays/elementWiseSubtract.js";
+export { default as elementWiseMultiply } from "./arrays/elementWiseMultiply.js";
+export { default as elementWiseDivide } from "./arrays/elementWiseDivide.js";
+export { default as scalarMultiply } from "./arrays/scalarMultiply.js";
+export { default as scalarDivide } from "./arrays/scalarDivide.js";
+export { default as normalizeVector } from "./arrays/normalizeVector.js";
+export { default as vectorMagnitude } from "./arrays/vectorMagnitude.js";
+export { default as vectorDistance } from "./arrays/vectorDistance.js";
+export { default as cosineSimilarity } from "./arrays/cosineSimilarity.js";
+export { default as angleBetweenVectors } from "./arrays/angleBetweenVectors.js";
+export { default as projectVector } from "./arrays/projectVector.js";
+export { default as cumulativeSum } from "./arrays/cumulativeSum.js";
+export { default as movingAverage } from "./arrays/movingAverage.js";
+export { default as transpose } from "./arrays/transpose.js";
+export { default as matrixMultiply } from "./arrays/matrixMultiply.js";
+
+// RANDOM
+export { default as random } from "./random/random.js";
+export { default as randomInt } from "./random/randomInt.js";
+export { default as randomFloat } from "./random/randomFloat.js";
+export { default as randomBoolean } from "./random/randomBoolean.js";
+export { default as randomChoice } from "./random/randomChoice.js";
+export { default as shuffle } from "./random/shuffle.js";
+export { default as sample } from "./random/sample.js";
+/**
+ * future goals
+ * randomSign() → returns -1 or 1
+randomHexColor()
+randomRGB()
+randomUUID() (using crypto.randomUUID())
+randomString(length, charset)
+randomDate(start, end)
+weightedChoice(items, weights)
+randomGaussian(mean, stdDev) (normal distribution via the Box–Muller transform)
+randomSeed(seed) (seeded pseudo-random number generator)
+ */

package/src/random/random.js

@@ -0,0 +1,3 @@
+export default function random() {
+  return Math.random();
+}

package/src/random/randomBoolean.js

@@ -0,0 +1,3 @@
+export default function randomBoolean() {
+  return Math.random() < 0.5;
+}

package/src/random/randomChoice.js

@@ -0,0 +1,11 @@
+export default function randomChoice(array) {
+  if (!Array.isArray(array)) {
+    throw new TypeError("Expected an array.");
+  }
+
+  if (array.length === 0) {
+    throw new Error("Cannot choose from an empty array.");
+  }
+
+  return array[Math.floor(Math.random() * array.length)];
+}

package/src/random/randomFloat.js

@@ -0,0 +1,11 @@
+export default function randomFloat(min, max) {
+  if (typeof min !== "number" || typeof max !== "number") {
+    throw new TypeError("Expected numeric bounds.");
+  }
+
+  if (min > max) {
+    throw new Error("Minimum cannot be greater than maximum.");
+  }
+
+  return Math.random() * (max - min) + min;
+}

package/src/random/randomInt.js

@@ -0,0 +1,11 @@
+export default function randomInt(min, max) {
+  if (!Number.isInteger(min) || !Number.isInteger(max)) {
+    throw new TypeError("Expected integer bounds.");
+  }
+
+  if (min > max) {
+    throw new Error("Minimum cannot be greater than maximum.");
+  }
+
+  return Math.floor(Math.random() * (max - min + 1)) + min;
+}

package/src/random/sample.js

@@ -0,0 +1,17 @@
+import shuffle from "./shuffle.js";
+
+export default function sample(array, count) {
+  if (!Array.isArray(array)) {
+    throw new TypeError("Expected an array.");
+  }
+
+  if (!Number.isInteger(count) || count < 0) {
+    throw new Error("Count must be a non-negative integer.");
+  }
+
+  if (count > array.length) {
+    throw new Error("Count cannot exceed array length.");
+  }
+
+  return shuffle(array).slice(0, count);
+}

package/src/random/shuffle.js

@@ -0,0 +1,15 @@
+export default function shuffle(array) {
+  if (!Array.isArray(array)) {
+    throw new TypeError("Expected an array.");
+  }
+
+  const result = [...array];
+
+  for (let i = result.length - 1; i > 0; i--) {
+    const j = Math.floor(Math.random() * (i + 1));
+
+    [result[i], result[j]] = [result[j], result[i]];
+  }
+
+  return result;
+}