@ptolemy2002/js-math-utils 2.0.2 → 2.0.4

package/README.md

@@ -35,7 +35,7 @@ Clamps a number between a minimum and maximum value.
 
 ### wrapNumber
 #### Description
-Wraps a number between a minimum and maximum value, non-inclusive on the maximum side (so `min - 1` gets converted to `max - 1` and `max` gets converted to `min`).
+Wraps a number between a minimum and maximum value, inclusive on the maximum side (so `min - 1` gets converted to `max` and `max + 1` gets converted to `min`).
 
 #### Parameters
 - `n` (`number`): The number to be wrapped.

package/dist/index.d.ts

@@ -3,4 +3,4 @@ export type ClampOptions = {
     max?: number;
 };
 export declare function clamp(value: number, { min, max }?: ClampOptions): number;
-export declare function wrapNumber(n: number, min: number, max: number): number;
+export declare function wrapNumber(value: number, min: number, max: number): number;

package/dist/index.js

@@ -9,14 +9,33 @@ function clamp(value, { min = null, max = null } = {}) {
         return max;
     return value;
 }
-function wrapNumber(n, min, max) {
-    const range = max - min;
-    if (n === 0)
-        return max - min;
-    return ((n - range) % range === 0 ?
-        min
-        : n >= min ?
-            min + (n - min) % range
-            :
-                max + (n - min) % range);
+function wrapNumber(value, min, max) {
+    // Handle edge case: if min equals max, return that value
+    if (min === max) {
+        return min;
+    }
+    // Calculate the range size
+    const rangeSize = max - min;
+    // If value is already within range (inclusive), return as-is
+    if (value >= min && value <= max) {
+        return value;
+    }
+    // Normalize the value by shifting it relative to min
+    const normalizedValue = value - min;
+    // Calculate the wrapped position within the range
+    // Use modulo to find where the value falls in the repeating pattern
+    // The +1 is to ensure that the range is inclusive of both min and max
+    let wrappedValue = normalizedValue % rangeSize;
+    // Handle negative values by ensuring the result is positive
+    if (wrappedValue < 0) {
+        wrappedValue += rangeSize;
+    }
+    // If wrappedValue is 0 and the value approaches from the left,
+    // we need to return the max value so that we can remain
+    // inclusive of the max boundary
+    if (wrappedValue === 0 && value > max) {
+        return max;
+    }
+    // Shift back to the original range and return
+    return wrappedValue + min;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ptolemy2002/js-math-utils",
-    "version": "2.0.2",
+    "version": "2.0.4",
     "private": false,
     "main": "dist/index.js",
     "types": "dist/index.d.ts",