@pawells/math-extended 2.0.0 → 3.0.0

package/README.md

@@ -19,7 +19,7 @@ yarn add @pawells/math-extended
 
 ## Usage
 
-All exports are available as individual named imports for tree-shaking, or grouped via namespace imports for convenience.
+All exports are available as individual named imports for tree-shaking optimization.
 
 ### Direct Named Imports (Tree-Shaking Friendly)
 
@@ -43,29 +43,22 @@ const v = SmoothStep(0, 10, 0.5); // 5
 const rad = DegreesToRadians(180); // Math.PI
 ```
 
-### Namespace Imports (Grouped)
-
-Import related utilities together using namespace imports:
-
-```typescript
-import { VectorUtils, MatrixUtils, QuaternionUtils } from '@pawells/math-extended';
-
-// Access utilities via namespace
-VectorUtils.VectorAdd([1, 0, 0], [0, 1, 0]);
-MatrixUtils.MatrixMultiply(matA, matB);
-QuaternionUtils.QuaternionSLERP(q1, q2, 0.5);
-```
 
 ### Import Patterns
 
 | Pattern | Best For | Example |
 |---------|----------|---------|
 | **Direct named** | Tree-shaking, small imports | `import { VectorAdd } from '@pawells/math-extended'` |
-| **Namespace** | Grouping related functions | `import { VectorUtils } from '@pawells/math-extended'` |
-| **Mixed** | Flexibility | Both patterns together |
+| **Mixed** | Flexibility | Multiple imports together |
 
 ## API
 
+### Core
+
+| Export | Description |
+|--------|-------------|
+| `CubeRoot(value)` | Compute the cube root of a number |
+
 ### Angles
 
 | Export | Description |
@@ -106,7 +99,7 @@ All interpolation functions share the signature `(a, b, t)`. `t` is typically in
 | `CosineInterpolation` | Cosine interpolation |
 | `CatmullRomInterpolation` | Catmull-Rom spline `(p0, p1, p2, p3, t)` |
 | `HermiteInterpolation` | Hermite spline `(p0, p1, t0, t1, t)` |
-| `SphericalLinearInterpolation` | Shortest-arc scalar SLERP |
+| `SphericalLinearInterpolation` | **@deprecated** Identical to `LinearInterpolation`. Use `QuaternionSLERP` for true spherical interpolation. |
 | `StepInterpolation` | Step function with configurable threshold |
 | `QuadraticEaseIn/Out/InOut` | Quadratic easing |
 | `CubicEaseIn/Out/InOut` | Cubic easing |
@@ -172,11 +165,11 @@ Every scalar easing function has a `Vector*` counterpart (e.g., `VectorSmoothSte
 
 #### Assertions
 
-`AssertVector`, `AssertVector2`, `AssertVector3`, `AssertVector4`, `AssertVectorValue`, `AssertVectors`, `VectorError`
+`AssertVector`, `AssertVector2`, `AssertVector3`, `AssertVector4`, `AssertVectorNonZero`, `AssertVectorSameSize`, `ValidateVector`, `ValidateVector2`, `ValidateVector3`, `ValidateVector4`, `ValidateVectorSameSize`, `VectorError`
 
 ### Matrices
 
-Matrices are `number[][]` arrays (`IMatrix`, `IMatrix1`–`IMatrix4`). All operations return new matrices.
+Matrices are `number[][]` arrays (`TMatrix`, `TMatrix1`–`TMatrix4`). All operations return new matrices.
 
 #### Core
 
@@ -266,7 +259,7 @@ Matrices are `number[][]` arrays (`IMatrix`, `IMatrix1`–`IMatrix4`). All opera
 
 #### Assertions
 
-`AssertMatrix`, `AssertMatrix1`–`AssertMatrix4`, `AssertMatrixRow`, `AssertMatrixValue`, `AssertMatrices`, `MatrixError`
+`AssertMatrix`, `AssertMatrix1`–`AssertMatrix4`, `AssertMatrixSquare`, `AssertMatricesCompatible`, `ValidateMatrix`, `ValidateMatrix1`–`ValidateMatrix4`, `ValidateMatrixSquare`, `MatrixError`
 
 ### Quaternions
 
@@ -318,6 +311,7 @@ Quaternions are `[x, y, z, w]` tuples (`TQuaternion`).
 
 `AssertQuaternion`, `AssertQuaternions`, `AssertNormalizedQuaternion`, `AssertAxisAngle`, `AssertEulerAngles`, `AssertRotationMatrix`, `QuaternionError`
 
+
 ## Development
 
 ```bash
@@ -328,7 +322,7 @@ yarn watch          # Watch mode
 yarn typecheck      # Type check without building
 yarn lint           # ESLint
 yarn lint:fix       # ESLint with auto-fix
-yarn test           # Run tests (1080 tests)
+yarn test           # Run tests (1137 tests)
 yarn test:ui        # Interactive Vitest UI
 yarn test:coverage  # Tests with coverage report
 ```
@@ -339,4 +333,4 @@ yarn test:coverage  # Tests with coverage report
 
 ## License
 
-MIT — See [LICENSE](./LICENSE) for details.
+This project is licensed under the [MIT License](LICENSE).

package/build/clamp.d.ts

@@ -9,11 +9,11 @@
  * @returns The clamped value in the range [min, max]
  *
  * @example
-     * ```typescript
-     * Clamp(5, 0, 10)   // 5 (within range)
-     * Clamp(-3, 0, 10)  // 0 (below min)
-     * Clamp(15, 0, 10)  // 10 (above max)
-     * ```
+ * ```typescript
+ * Clamp(5, 0, 10)   // 5 (within range)
+ * Clamp(-3, 0, 10)  // 0 (below min)
+ * Clamp(15, 0, 10)  // 10 (above max)
+ * ```
  */
 export declare function Clamp(x: number, min: number, max: number): number;
 //# sourceMappingURL=clamp.d.ts.map

package/build/clamp.js

@@ -9,11 +9,11 @@
  * @returns The clamped value in the range [min, max]
  *
  * @example
-     * ```typescript
-     * Clamp(5, 0, 10)   // 5 (within range)
-     * Clamp(-3, 0, 10)  // 0 (below min)
-     * Clamp(15, 0, 10)  // 10 (above max)
-     * ```
+ * ```typescript
+ * Clamp(5, 0, 10)   // 5 (within range)
+ * Clamp(-3, 0, 10)  // 0 (below min)
+ * Clamp(15, 0, 10)  // 10 (above max)
+ * ```
  */
 export function Clamp(x, min, max) {
     return Math.max(min, Math.min(x, max));

package/build/core.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Core mathematical utilities for pure numeric calculations.
+ * Provides foundational math operations with no domain coupling.
+ */
+/**
+ * Calculates the cube root of a number, preserving the sign of the input.
+ * Handles negative numbers correctly (unlike Math.cbrt in some contexts).
+ *
+ * @param value - The value to calculate the cube root of
+ * @returns The cube root of the value, with same sign as input
+ *
+ * @example
+ * ```typescript
+ * import { CubeRoot } from '@pawells/math-extended';
+ *
+ * CubeRoot(8); // 2
+ * CubeRoot(-8); // -2
+ * CubeRoot(27); // 3
+ * CubeRoot(0); // 0
+ * ```
+ */
+export declare function CubeRoot(value: number): number;
+//# sourceMappingURL=core.d.ts.map

package/build/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE9C"}

package/build/core.js

@@ -0,0 +1,25 @@
+/**
+ * Core mathematical utilities for pure numeric calculations.
+ * Provides foundational math operations with no domain coupling.
+ */
+/**
+ * Calculates the cube root of a number, preserving the sign of the input.
+ * Handles negative numbers correctly (unlike Math.cbrt in some contexts).
+ *
+ * @param value - The value to calculate the cube root of
+ * @returns The cube root of the value, with same sign as input
+ *
+ * @example
+ * ```typescript
+ * import { CubeRoot } from '@pawells/math-extended';
+ *
+ * CubeRoot(8); // 2
+ * CubeRoot(-8); // -2
+ * CubeRoot(27); // 3
+ * CubeRoot(0); // 0
+ * ```
+ */
+export function CubeRoot(value) {
+    return Math.sign(value) * Math.pow(Math.abs(value), 1 / 3);
+}
+//# sourceMappingURL=core.js.map

package/build/core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.js","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAa;IACrC,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;AAC5D,CAAC"}

package/build/index.d.ts

@@ -1,8 +1,5 @@
-export * as VectorUtils from './vectors/index.js';
-export * as MatrixUtils from './matrices/index.js';
-export * as QuaternionUtils from './quaternions/index.js';
-export * from './angles.js';
 export * from './clamp.js';
+export * from './core.js';
 export * from './interpolation.js';
 export * from './matrices/index.js';
 export * from './quaternions/index.js';

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,WAAW,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,WAAW,MAAM,qBAAqB,CAAC;AACnD,OAAO,KAAK,eAAe,MAAM,wBAAwB,CAAC;AAG1D,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC"}

package/build/index.js

@@ -1,10 +1,5 @@
-// Namespace exports for grouped imports
-export * as VectorUtils from './vectors/index.js';
-export * as MatrixUtils from './matrices/index.js';
-export * as QuaternionUtils from './quaternions/index.js';
-// Direct named exports for tree-shaking
-export * from './angles.js';
 export * from './clamp.js';
+export * from './core.js';
 export * from './interpolation.js';
 export * from './matrices/index.js';
 export * from './quaternions/index.js';

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,OAAO,KAAK,WAAW,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,WAAW,MAAM,qBAAqB,CAAC;AACnD,OAAO,KAAK,eAAe,MAAM,wBAAwB,CAAC;AAE1D,wCAAwC;AACxC,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,wBAAwB,CAAC;AACvC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC"}