@inglorious/utils 2.3.0 → 3.0.0

package/README.md

@@ -43,7 +43,7 @@ const result = calculate(10) // 40
 Perform vector operations on plain objects.
 
 ```javascript
-import { add } from "@inglorious/utils/math/linear-algebra/vector"
+import { add } from "@inglorious/utils/math/vector.js"
 
 const position = [10, 20]
 const velocity = [2, -1]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inglorious/utils",
-  "version": "2.3.0",
+  "version": "3.0.0",
   "description": "A set of general-purpose utility functions designed with functional programming principles in mind.",
   "author": "IceOnFire <antony.mistretta@gmail.com> (https://ingloriouscoderz.it)",
   "license": "MIT",

package/src/algorithms/decision-tree.test.js

@@ -1,12 +1,13 @@
 import { expect, test } from "vitest"
 
-import { length } from "../math/linear-algebra/vector.js"
-import { subtract } from "../math/linear-algebra/vectors.js"
+import { length } from "../math/vector.js"
+import { subtract } from "../math/vectors.js"
+import { v } from "../v.js"
 import { decide } from "./decision-tree.js"
 
 test("it should make a decision based on a binary decision tree", () => {
-  const entity = { state: "sleeping", position: [0, 0, 0] }
-  const target = { position: [10, 0, 0] }
+  const entity = { state: "sleeping", position: v(0, 0, 0) }
+  const target = { position: v(10, 0, 0) }
   const tree = {
     test({ entity }) {
       return entity.state === "idle"
@@ -83,8 +84,8 @@ test("it should make a decision based on a binary decision tree", () => {
 })
 
 test("it should make a decision on a multi-child tree", () => {
-  const entity = { state: "sleeping", position: [0, 0, 0] }
-  const target = { position: [10, 0, 0] }
+  const entity = { state: "sleeping", position: v(0, 0, 0) }
+  const target = { position: v(10, 0, 0) }
   const wakeUp = () => ({
     test({ entity, target }) {
       const distance = length(subtract(target.position, entity.position))

package/src/algorithms/index.js

@@ -0,0 +1,4 @@
+import * as decisionTree from "./decision-tree.js"
+import * as pathfinding from "./path-finding.js"
+
+export { decisionTree, pathfinding }

package/src/algorithms/path-finding.js

@@ -4,8 +4,8 @@
  */
 
 import { contains, push, remove, root } from "../data-structures/heap.js"
-import { abs, magnitude } from "../math/linear-algebra/vector.js"
-import { subtract } from "../math/linear-algebra/vectors.js"
+import { abs, magnitude } from "../math/vector.js"
+import { subtract } from "../math/vectors.js"
 
 const NO_COST = 0
 

package/src/data-structures/index.js

@@ -0,0 +1,10 @@
+import * as array from "./array.js"
+import * as board from "./board.js"
+import * as boolean from "./boolean.js"
+import * as heap from "./heap.js"
+import * as object from "./object.js"
+import * as objects from "./objects.js"
+import * as set from "./set.js"
+import * as tree from "./tree.js"
+
+export { array, board, boolean, heap, object, objects, set, tree }

package/src/functions/index.js

@@ -0,0 +1,4 @@
+import * as func from "./function.js"
+import * as funcs from "./functions.js"
+
+export { func, funcs }

package/src/index.js

@@ -0,0 +1,8 @@
+import * as algorithms from "./algorithms/index.js"
+import * as dataStructures from "./data-structures/index.js"
+import * as functions from "./functions/index.js"
+import * as math from "./math/index.js"
+import * as physics from "./physics/index.js"
+
+export { algorithms, dataStructures, functions, math, physics }
+export { v } from "./v.js"

package/src/math/{geometry/circle.js → circle.js}

@@ -1,14 +1,14 @@
 /**
- * @typedef {import("./types").Point} Point
- * @typedef {import("./types").Circle} Circle
- * @typedef {import("./types").Rectangle} Rectangle
- * @typedef {import("./types").Platform} Platform
+ * @typedef {import("./geometry/types.js").Point} Point
+ * @typedef {import("./geometry/types.js").Circle} Circle
+ * @typedef {import("./geometry/types.js").Rectangle} Rectangle
+ * @typedef {import("./geometry/types.js").Platform} Platform
  */
 
-import { clamp } from "../linear-algebra/vector.js"
-import { subtract } from "../linear-algebra/vectors.js"
 import { intersectsCircle as pointIntersectsCircle } from "./point.js"
 import { hypothenuse } from "./triangle.js"
+import { clamp } from "./vector.js"
+import { subtract } from "./vectors.js"
 
 const HALF = 2
 const SQUARED = 2

package/src/math/{geometry/circle.test.js → circle.test.js}

@@ -1,5 +1,6 @@
 import { expect, test } from "vitest"
 
+import { v } from "../v.js"
 import {
   intersectsCircle,
   intersectsPoint,
@@ -8,50 +9,50 @@ import {
 
 test("it should prove that a circle around a point intersects with it", () => {
   const circle = {
-    position: [1, 1, 0],
+    position: v(1, 1, 0),
     radius: 1,
   }
-  const point = [1.5, 1.5, 0]
+  const point = v(1.5, 1.5, 0)
 
   expect(intersectsPoint(circle, point)).toBe(true)
 })
 
 test("it should prove that two equal circles intersect", () => {
-  const circle1 = { position: [1, 1, 0], radius: 1 }
-  const circle2 = { position: [1, 1, 0], radius: 1 }
+  const circle1 = { position: v(1, 1, 0), radius: 1 }
+  const circle2 = { position: v(1, 1, 0), radius: 1 }
 
   expect(intersectsCircle(circle1, circle2)).toBe(true)
 })
 
 test("it should prove that two circles shifted by a small x intersect", () => {
-  const circle1 = { position: [1, 1, 0], radius: 1 }
-  const circle2 = { position: [2, 1, 0], radius: 1 }
+  const circle1 = { position: v(1, 1, 0), radius: 1 }
+  const circle2 = { position: v(2, 1, 0), radius: 1 }
 
   expect(intersectsCircle(circle1, circle2)).toBe(true)
 })
 
 test("it should prove that two touching circles intersect", () => {
-  const circle1 = { position: [1, 1, 0], radius: 1 }
-  const circle2 = { position: [3, 1, 0], radius: 1 }
+  const circle1 = { position: v(1, 1, 0), radius: 1 }
+  const circle2 = { position: v(3, 1, 0), radius: 1 }
 
   expect(intersectsCircle(circle1, circle2)).toBe(true)
 })
 
 test("it should prove that two non-touching circles do not intersect", () => {
-  const circle1 = { position: [1, 1, 0], radius: 1 }
-  const circle2 = { position: [4, 1, 0], radius: 1 }
+  const circle1 = { position: v(1, 1, 0), radius: 1 }
+  const circle2 = { position: v(4, 1, 0), radius: 1 }
 
   expect(intersectsCircle(circle1, circle2)).toBe(false)
 })
 
 test("it should prove that a circle inside of a rectangle intersects with it", () => {
   const circle = {
-    position: [1, 1, 0],
+    position: v(1, 1, 0),
     radius: 1,
   }
   const rectangle = {
-    position: [-1, -1, 0],
-    size: [4, 4, 0],
+    position: v(-1, -1, 0),
+    size: v(4, 4, 0),
   }
 
   expect(intersectsRectangle(circle, rectangle)).toBe(true)
@@ -59,12 +60,12 @@ test("it should prove that a circle inside of a rectangle intersects with it", (
 
 test("it should prove that a circle touching the border of a rectangle intersects with it", () => {
   const circle = {
-    position: [1, 1, 0],
+    position: v(1, 1, 0),
     radius: 1,
   }
   const rectangle = {
-    position: [-1, 1, 0], // Rectangle's right edge is at x=0, touching the circle's left edge.
-    size: [2, 2, 0],
+    position: v(-1, 1, 0), // Rectangle's right edge is at x=0, touching the circle's left edge.
+    size: v(2, 2, 0),
   }
 
   expect(intersectsRectangle(circle, rectangle)).toBe(true)
@@ -72,12 +73,12 @@ test("it should prove that a circle touching the border of a rectangle intersect
 
 test("it should prove that a circle crossing a rectangle intersects with it", () => {
   const circle = {
-    position: [1, 1, 0],
+    position: v(1, 1, 0),
     radius: 1,
   }
   const rectangle = {
-    position: [0, 0, 0],
-    size: [2, 2, 0],
+    position: v(0, 0, 0),
+    size: v(2, 2, 0),
   }
 
   expect(intersectsRectangle(circle, rectangle)).toBe(true)
@@ -85,12 +86,12 @@ test("it should prove that a circle crossing a rectangle intersects with it", ()
 
 test("it should prove that a circle outside of a rectangle does not intersect with it", () => {
   const circle = {
-    position: [1, 1, 0],
+    position: v(1, 1, 0),
     radius: 1,
   }
   const rectangle = {
-    position: [-3, 0, 0],
-    size: [2, 2, 0],
+    position: v(-3, 0, 0),
+    size: v(2, 2, 0),
   }
 
   expect(intersectsRectangle(circle, rectangle)).toBe(false)

package/src/math/{geometry/hitmask.test.js → hitmask.test.js}

@@ -1,6 +1,7 @@
 import { expect, test } from "vitest"
 
-import { findCollisions } from "./hitmask"
+import { v } from "../v.js"
+import { findCollisions } from "./hitmask.js"
 
 /**
  * Given a rectangle located at (x=1.5, y=0, z=2.5) with a size of (1, 1, 1),
@@ -17,7 +18,7 @@ import { findCollisions } from "./hitmask"
  */
 test("it should prove that a rectangle touching a wall intersects with it", () => {
   const hitmask = {
-    position: [2, 0, 1.5],
+    position: v(2, 0, 1.5),
     tileSize: [1, 1],
     columns: 4,
     // The top row (indices 0, 1, 2, 3) now has the walls.
@@ -25,8 +26,8 @@ test("it should prove that a rectangle touching a wall intersects with it", () =
   }
   const rectangle = {
     shape: "rectangle",
-    position: [1.5, 0, 2.5],
-    size: [1, 1, 1],
+    position: v(1.5, 0, 2.5),
+    size: v(1, 1, 1),
   }
 
   expect(findCollisions(hitmask, rectangle)).toBe(true)
@@ -57,8 +58,8 @@ test("it should prove that shifting operands does not change the outcome", () =>
   }
   const rectangle = {
     shape: "rectangle",
-    position: [11.5, 0, 12.5],
-    size: [1, 1, 1],
+    position: v(11.5, 0, 12.5),
+    size: v(1, 1, 1),
   }
 
   expect(findCollisions(hitmask, rectangle)).toBe(true)
@@ -79,7 +80,7 @@ test("it should prove that shifting operands does not change the outcome", () =>
  */
 test("it should prove that a rectangle not touching a wall does not intersect with it", () => {
   const hitmask = {
-    position: [2, 0, 1.5],
+    position: v(2, 0, 1.5),
     tileSize: [1, 1],
     columns: 4,
     // The top row (indices 0, 1, 2, 3) now has the walls.
@@ -87,8 +88,8 @@ test("it should prove that a rectangle not touching a wall does not intersect wi
   }
   const rectangle = {
     shape: "rectangle",
-    position: [0.5, 0, 0.5],
-    size: [1, 1, 1],
+    position: v(0.5, 0, 0.5),
+    size: v(1, 1, 1),
   }
 
   expect(findCollisions(hitmask, rectangle)).toBe(false)
@@ -109,7 +110,7 @@ test("it should prove that a rectangle not touching a wall does not intersect wi
  */
 test("it should prove that a rectangle above the tile of a hitmask does not intersect with it", () => {
   const hitmask = {
-    position: [2, 0, 1.5],
+    position: v(2, 0, 1.5),
     tileSize: [1, 1],
     columns: 4,
     // The top row (indices 0, 1, 2, 3) now has the walls.
@@ -117,8 +118,8 @@ test("it should prove that a rectangle above the tile of a hitmask does not inte
   }
   const rectangle = {
     shape: "rectangle",
-    position: [1.5, 1.6, 2.5],
-    size: [1, 1, 1],
+    position: v(1.5, 1.6, 2.5),
+    size: v(1, 1, 1),
   }
 
   expect(findCollisions(hitmask, rectangle)).toBe(false)
@@ -139,7 +140,7 @@ test("it should prove that a rectangle above the tile of a hitmask does not inte
  */
 test("it should prove that a rectangle outside of a hitmask does not intersect with it", () => {
   const hitmask = {
-    position: [2, 0, 1.5],
+    position: v(2, 0, 1.5),
     tileSize: [1, 1],
     columns: 4,
     // The top row (indices 0, 1, 2, 3) now has the walls.
@@ -147,8 +148,8 @@ test("it should prove that a rectangle outside of a hitmask does not intersect w
   }
   const rectangle = {
     shape: "rectangle",
-    position: [5.5, 0.5, 1.5],
-    size: [1, 1, 1],
+    position: v(5.5, 0.5, 1.5),
+    size: v(1, 1, 1),
   }
 
   expect(findCollisions(hitmask, rectangle)).toBe(false)

package/src/math/index.js

@@ -0,0 +1,35 @@
+import * as circle from "./circle.js"
+import * as hitmask from "./hitmask.js"
+import * as line from "./line.js"
+import * as linearInterpolation from "./linear-interpolation.js"
+import * as numbers from "./numbers.js"
+import * as point from "./point.js"
+import * as quaternion from "./quaternion.js"
+import * as quaternions from "./quaternions.js"
+import * as rectangle from "./rectangle.js"
+import * as rng from "./rng.js"
+import * as segment from "./segment.js"
+import * as statistics from "./statistics.js"
+import * as triangle from "./triangle.js"
+import * as trigonometry from "./trigonometry.js"
+import * as vector from "./vector.js"
+import * as vectors from "./vectors.js"
+
+export {
+  circle,
+  hitmask,
+  line,
+  linearInterpolation,
+  numbers,
+  point,
+  quaternion,
+  quaternions,
+  rectangle,
+  rng,
+  segment,
+  statistics,
+  triangle,
+  trigonometry,
+  vector,
+  vectors,
+}

package/src/math/{geometry/line.js → line.js}

@@ -1,10 +1,10 @@
 /**
- * @typedef {import("./types").Line} Line
- * @typedef {import("./types").Point} Point
- * @typedef {import("./types").Circle} Circle
+ * @typedef {import("./geometry/types.js").Line} Line
+ * @typedef {import("./geometry/types.js").Point} Point
+ * @typedef {import("./geometry/types.js").Circle} Circle
  */
 
-import { abs } from "../numbers.js"
+import { abs } from "./numbers.js"
 import { hypothenuse } from "./triangle.js"
 
 /**

package/src/math/{geometry/line.test.js → line.test.js}

@@ -1,27 +1,28 @@
 import { expect, test } from "vitest"
 
+import { v } from "../v.js"
 import { distanceFromPoint, intersectsCircle } from "./line.js"
 
 test("it should compute the distance between a line and a point", () => {
-  const line = [-4, 3, 0]
-  const point = [5, 0, 0]
+  const line = v(-4, 3, 0)
+  const point = v(5, 0, 0)
   const expectedResult = 4
 
   expect(distanceFromPoint(line, point)).toBe(expectedResult)
 })
 
 test("it should not compute the distance between a line and a point", () => {
-  const line = [-1, 1, 0]
-  const point = [2, 0, 2]
+  const line = v(-1, 1, 0)
+  const point = v(2, 0, 2)
   const expectedResult = 0
 
   expect(distanceFromPoint(line, point)).toBe(expectedResult)
 })
 
 test("it should prove that a line that crosses a circle intersects with it", () => {
-  const line = [-2, 2, 0]
+  const line = v(-2, 2, 0)
   const circle = {
-    position: [1, 1, 0],
+    position: v(1, 1, 0),
     radius: 1,
   }
 
@@ -29,9 +30,9 @@ test("it should prove that a line that crosses a circle intersects with it", ()
 })
 
 test("it should prove that a line tangent to a circle intersects with it", () => {
-  const line = [-2, 0, 0]
+  const line = v(-2, 0, 0)
   const circle = {
-    position: [1, 0, 1],
+    position: v(1, 0, 1),
     radius: 1,
   }
 
@@ -39,9 +40,9 @@ test("it should prove that a line tangent to a circle intersects with it", () =>
 })
 
 test("it should prove that a line that does not cross a circle does not intersect with it", () => {
-  const line = [1, 1, 0]
+  const line = v(1, 1, 0)
   const circle = {
-    position: [1, 0, 1],
+    position: v(1, 0, 1),
     radius: 1,
   }
 

package/src/math/{geometry/point.js → point.js}

@@ -1,15 +1,15 @@
 /**
- * @typedef {import("./types").Point} Point
- * @typedef {import("./types").Line} Line
- * @typedef {import("./types").Circle} Circle
- * @typedef {import("./types").Rectangle} Rectangle
+ * @typedef {import("./geometry/types.js").Point} Point
+ * @typedef {import("./geometry/types.js").Line} Line
+ * @typedef {import("./geometry/types.js").Circle} Circle
+ * @typedef {import("./geometry/types.js").Rectangle} Rectangle
  */
 
 const SQUARED = 2
 const HALF = 2
 
-import { isVector } from "../linear-algebra/vector.js"
 import { distanceFromPoint } from "./line.js"
+import { isVector } from "./vector.js"
 
 /**
  * Calculates the distance from a point to a line.

package/src/math/{geometry/point.test.js → point.test.js}

@@ -1,5 +1,6 @@
 import { expect, test } from "vitest"
 
+import { v } from "../v.js"
 import {
   intersectsCircle,
   intersectsPoint,
@@ -7,23 +8,23 @@ import {
 } from "./point.js"
 
 test("it should prove that two equal points intersect", () => {
-  const point1 = [1.5, 1.5, 0]
-  const point2 = [1.5, 1.5, 0]
+  const point1 = v(1.5, 1.5, 0)
+  const point2 = v(1.5, 1.5, 0)
 
   expect(intersectsPoint(point1, point2)).toBe(true)
 })
 
 test("it should prove that two different points do not intersect", () => {
-  const point1 = [1.5, 1.5, 0]
-  const point2 = [2, 1, 0]
+  const point1 = v(1.5, 1.5, 0)
+  const point2 = v(2, 1, 0)
 
   expect(intersectsPoint(point1, point2)).toBe(false)
 })
 
 test("it should prove that a point inside of a circle intersects with it", () => {
-  const point = [1.5, 1.5, 0]
+  const point = v(1.5, 1.5, 0)
   const circle = {
-    position: [1, 1, 0],
+    position: v(1, 1, 0),
     radius: 1,
   }
 
@@ -31,9 +32,9 @@ test("it should prove that a point inside of a circle intersects with it", () =>
 })
 
 test("it should prove that a point on the border of a circle intersects with it", () => {
-  const point = [2, 1, 0]
+  const point = v(2, 1, 0)
   const circle = {
-    position: [1, 1, 0],
+    position: v(1, 1, 0),
     radius: 1,
   }
 
@@ -41,9 +42,9 @@ test("it should prove that a point on the border of a circle intersects with it"
 })
 
 test("it should prove that a point outside of a circle does not intersect with it", () => {
-  const point = [2, 2, 0]
+  const point = v(2, 2, 0)
   const circle = {
-    position: [1, 1, 0],
+    position: v(1, 1, 0),
     radius: 1,
   }
 
@@ -51,30 +52,30 @@ test("it should prove that a point outside of a circle does not intersect with i
 })
 
 test("it should prove that a point inside of a rectangle intersects with it", () => {
-  const point = [1.5, 1.5, 0]
+  const point = v(1.5, 1.5, 0)
   const rectangle = {
-    position: [1, 1, 0],
-    size: [2, 2, 0],
+    position: v(1, 1, 0),
+    size: v(2, 2, 0),
   }
 
   expect(intersectsRectangle(point, rectangle)).toBe(true)
 })
 
 test("it should prove that a point on the border of a rectangle intersects with it", () => {
-  const point = [2, 1, 0]
+  const point = v(2, 1, 0)
   const rectangle = {
-    position: [1, 1, 0],
-    size: [2, 2, 0],
+    position: v(1, 1, 0),
+    size: v(2, 2, 0),
   }
 
   expect(intersectsRectangle(point, rectangle)).toBe(true)
 })
 
 test("it should prove that a point outside of a rectangle does not intersect with it", () => {
-  const point = [2.5, 2.5, 0]
+  const point = v(2.5, 2.5, 0)
   const rectangle = {
-    position: [1, 1, 0],
-    size: [2, 2, 0],
+    position: v(1, 1, 0),
+    size: v(2, 2, 0),
   }
 
   expect(intersectsRectangle(point, rectangle)).toBe(false)
@@ -82,11 +83,11 @@ test("it should prove that a point outside of a rectangle does not intersect wit
 
 test("it should work even if the point is an object with a position", () => {
   const point = {
-    position: [1.5, 1.5, 0],
+    position: v(1.5, 1.5, 0),
   }
   const rectangle = {
-    position: [1, 1, 0],
-    size: [2, 2, 0],
+    position: v(1, 1, 0),
+    size: v(2, 2, 0),
   }
 
   expect(intersectsRectangle(point, rectangle)).toBe(true)

package/src/math/{linear-algebra/quaternion.js → quaternion.js}

@@ -3,12 +3,13 @@
  * @typedef {import('../../../types').Quaternion} Quaternion
  */
 
-import { cos, sin } from "../trigonometry.js"
+import { v } from "../v.js"
+import { cos, sin } from "./trigonometry.js"
 
 const DEFAULT_ANGLE = 0
 const HALF = 2 // Constant representing the divisor for halving an angle.
 // eslint-disable-next-line no-magic-numbers
-const Y_AXIS = [0, 1, 0] // Default axis of rotation (Y-axis).
+const Y_AXIS = v(0, 1, 0) // Default axis of rotation (Y-axis).
 
 /**
  * Computes a quaternion representing a rotation around a given axis.

package/src/math/{linear-algebra/quaternion.test.js → quaternion.test.js}

@@ -1,7 +1,7 @@
 import { expect, test } from "vitest"
 
-import { cos, pi, sin } from "../trigonometry.js"
 import { quaternion } from "./quaternion.js"
+import { cos, pi, sin } from "./trigonometry.js"
 
 test("it should return the quaternion for no rotation", () => {
   const angle = 0

package/src/math/{linear-algebra/quaternions.test.js → quaternions.test.js}

@@ -1,8 +1,8 @@
 import { expect, test } from "vitest"
 
-import { cos, pi, sin } from "../trigonometry.js"
 import { quaternion } from "./quaternion.js"
 import { combine } from "./quaternions.js"
+import { cos, pi, sin } from "./trigonometry.js"
 
 test("it should combine two zero-angle quaternions by giving the same 0-angle quaternion", () => {
   const q1 = quaternion(0)

package/src/math/{geometry/rectangle.js → rectangle.js}

@@ -1,7 +1,7 @@
 /**
- * @typedef {import("./types").Circle} Circle
- * @typedef {import("./types").Rectangle} Rectangle
- * @typedef {import("./types").Platform} Platform
+ * @typedef {import("./geometry/types.js").Circle} Circle
+ * @typedef {import("./geometry/types.js").Rectangle} Rectangle
+ * @typedef {import("./geometry/types.js").Platform} Platform
  */
 
 import { intersectsRectangle as circleIntersectsRectangle } from "./circle.js"