math-utils-simple 1.2.0 → 2.1.0

package/README.md

@@ -1,6 +1,6 @@
 # math-utils-simple
 
-A simple math utility library for JavaScript.
+A lightweight JavaScript math utility library built to scale for advanced use cases in the future.
 
 ## Install
 

package/package.json

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

package/src/index.js

@@ -1,5 +1,4 @@
 // ARITHMETIC
-
 export { default as add } from "./arithmetic/add.js";
 export { default as subtract } from "./arithmetic/subtract.js";
 export { default as multiply } from "./arithmetic/multiply.js";
@@ -18,7 +17,6 @@ export { default as cube } from "./arithmetic/cube.js";
 export { default as reciprocal } from "./arithmetic/reciprocal.js";
 
 // NUMBER
-
 export { default as digitalRoot } from "./number/digitalRoot.js";
 export { default as digitCount } from "./number/digitCount.js";
 export { default as divisors } from "./number/divisors.js";
@@ -41,4 +39,34 @@ export { default as nthFibonacci } from "./number/nthFibonacci.js";
 export { default as previousPrime } from "./number/previousPrime.js";
 export { default as primeFactors } from "./number/primeFactors.js";
 export { default as reverseNumber } from "./number/reverseNumber.js";
-export { default as sumOfDigits } from "./number/sumOfDigits.js";
+export { default as sumOfDigits } from "./number/sumOfDigits.js";
+
+// ROUNDING
+export { default as round } from "./rounding/round.js";
+export { default as floor } from "./rounding/floor.js";
+export { default as ceil } from "./rounding/ceil.js";
+export { default as truncate } from "./rounding/truncate.js";
+export { default as roundTo } from "./rounding/roundTo.js";
+export { default as clamp } from "./rounding/clamp.js";
+export { default as roundUpToNearest } from "./rounding/roundUpToNearest.js";
+export { default as roundDownToNearest } from "./rounding/roundDownToNearest.js";
+export { default as roundToNearest } from "./rounding/roundToNearest.js";
+export { default as snap } from "./rounding/snap.js";
+export { default as isBetween } from "./rounding/isBetween.js";
+export { default as wrap } from "./rounding/wrap.js";
+export { default as normalize } from "./rounding/normalize.js";
+
+// PERCENTAGES
+export { default as percentage } from "./percentages/percentage.js";
+export { default as increaseByPercentage } from "./percentages/increaseByPercentage.js";
+export { default as decreaseByPercentage } from "./percentages/decreaseByPercentage.js";
+export { default as percentageDifference } from "./percentages/percentageDifference.js";
+export { default as percentageChange } from "./percentages/percentageChange.js";
+export { default as findOriginalValue } from "./percentages/findOriginalValue.js";
+export { default as findFinalValue } from "./percentages/findFinalValue.js";
+export { default as discount } from "./percentages/discount.js";
+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";

package/src/percentages/decreaseByPercentage.js

@@ -0,0 +1,3 @@
+export default function decreaseByPercentage(value, percent) {
+  return value * (1 - percent / 100);
+}

package/src/percentages/discount.js

@@ -0,0 +1,3 @@
+export default function discount(price, percent) {
+  return price * (1 - percent / 100);
+}

package/src/percentages/findFinalValue.js

@@ -0,0 +1,3 @@
+export default function findFinalValue(original, percent) {
+  return original * (1 + percent / 100);
+}

package/src/percentages/findOriginalValue.js

@@ -0,0 +1,7 @@
+export default function findOriginalValue(finalValue, percentIncrease) {
+  if (percentIncrease === -100) {
+    throw new Error("Percent increase cannot be -100.");
+  }
+
+  return finalValue / (1 + percentIncrease / 100);
+}

package/src/percentages/increaseByPercentage.js

@@ -0,0 +1,3 @@
+export default function increaseByPercentage(value, percent) {
+  return value * (1 + percent / 100);
+}

package/src/percentages/lossPercentage.js

@@ -0,0 +1,11 @@
+export default function lossPercentage(cost, sellingPrice) {
+  if (cost === 0) {
+    throw new Error("Cost cannot be zero.");
+  }
+
+  if (sellingPrice >= cost) {
+    return 0;
+  }
+
+  return ((cost - sellingPrice) / cost) * 100;
+}

package/src/percentages/margin.js

@@ -0,0 +1,7 @@
+export default function margin(cost, sellingPrice) {
+  if (sellingPrice === 0) {
+    throw new Error("Selling price cannot be zero.");
+  }
+
+  return ((sellingPrice - cost) / sellingPrice) * 100;
+}

package/src/percentages/markup.js

@@ -0,0 +1,3 @@
+export default function markup(cost, percent) {
+  return cost * (1 + percent / 100);
+}

package/src/percentages/percentage.js

@@ -0,0 +1,7 @@
+export default function percentage(value, total) {
+  if (total === 0) {
+    throw new Error("Total cannot be zero.");
+  }
+
+  return (value / total) * 100;
+}

package/src/percentages/percentageChange.js

@@ -0,0 +1,7 @@
+export default function percentageChange(oldValue, newValue) {
+  if (oldValue === 0) {
+    throw new Error("Old value cannot be zero.");
+  }
+
+  return ((newValue - oldValue) / oldValue) * 100;
+}

package/src/percentages/percentageDifference.js

@@ -0,0 +1,10 @@
+export default function percentageDifference(a, b) {
+  if (a === 0 && b === 0) {
+    return 0;
+  }
+
+  return (
+    (Math.abs(a - b) / ((Math.abs(a) + Math.abs(b)) / 2)) *
+    100
+  );
+}

package/src/percentages/profitPercentage.js

@@ -0,0 +1,7 @@
+export default function profitPercentage(cost, sellingPrice) {
+  if (cost === 0) {
+    throw new Error("Cost cannot be zero.");
+  }
+
+  return ((sellingPrice - cost) / cost) * 100;
+}

package/src/percentages/relativeChange.js

@@ -0,0 +1,7 @@
+export default function relativeChange(a, b) {
+  if (b === 0) {
+    throw new Error("Reference value cannot be zero.");
+  }
+
+  return ((a - b) / b) * 100;
+}

package/src/rounding/ceil.js

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

package/src/rounding/clamp.js

@@ -0,0 +1,7 @@
+export default function clamp(value, min, max) {
+  if (min > max) {
+    throw new Error("min cannot be greater than max.");
+  }
+
+  return Math.min(Math.max(value, min), max);
+}

package/src/rounding/floor.js

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

package/src/rounding/isBetween.js

@@ -0,0 +1,11 @@
+export default function isBetween(value, min, max, inclusive = true) {
+  if (min > max) {
+    throw new Error("min cannot be greater than max.");
+  }
+
+  if (inclusive) {
+    return value >= min && value <= max;
+  }
+
+  return value > min && value < max;
+}

package/src/rounding/normalize.js

@@ -0,0 +1,7 @@
+export default function normalize(value, min, max) {
+  if (min === max) {
+    throw new Error("min and max cannot be equal.");
+  }
+
+  return (value - min) / (max - min);
+}

package/src/rounding/round.js

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

package/src/rounding/roundDownToNearest.js

@@ -0,0 +1,7 @@
+export default function roundDownToNearest(value, multiple) {
+  if (multiple === 0) {
+    throw new Error("multiple cannot be zero.");
+  }
+
+  return Math.floor(value / multiple) * multiple;
+}

package/src/rounding/roundTo.js

@@ -0,0 +1,4 @@
+export default function roundTo(n, decimals = 0) {
+  const factor = 10 ** decimals;
+  return Math.round(n * factor) / factor;
+}

package/src/rounding/roundToNearest.js

@@ -0,0 +1,7 @@
+export default function roundToNearest(value, multiple) {
+  if (multiple === 0) {
+    throw new Error("multiple cannot be zero.");
+  }
+
+  return Math.round(value / multiple) * multiple;
+}

package/src/rounding/roundUpToNearest.js

@@ -0,0 +1,7 @@
+export default function roundUpToNearest(value, multiple) {
+  if (multiple === 0) {
+    throw new Error("multiple cannot be zero.");
+  }
+
+  return Math.ceil(value / multiple) * multiple;
+}

package/src/rounding/snap.js

@@ -0,0 +1,7 @@
+export default function snap(value, step) {
+  if (step === 0) {
+    throw new Error("step cannot be zero.");
+  }
+
+  return Math.round(value / step) * step;
+}

package/src/rounding/truncate.js

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

package/src/rounding/wrap.js

@@ -0,0 +1,9 @@
+export default function wrap(value, min, max) {
+  if (min >= max) {
+    throw new Error("min must be less than max.");
+  }
+
+  const range = max - min;
+
+  return ((((value - min) % range) + range) % range) + min;
+}