@inglorious/engine 0.1.0 → 0.2.0

package/src/docs/utils/data-structures/objects.mdx

@@ -1,30 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { extend, merge } from '@inglorious/utils/data-structures/objects'
-import { toString } from '@inglorious/utils/data-structures/object'
-
-<Meta title="Utils/Data Structures/Objects" />
-
-# Objects
-
-Functions that deal with multiple object.
-
-## Extend
-
-Extends an object with another, producing a new object as a result.
-
-<code>const obj1 = \{ a: 1, b: [2, 3], c: \{ d: 4 \}, e: [\{ f: 5 \}] \}</code>&nbsp;
-
-<code>const obj2 = \{ g: 6, b: [7], c: \{ h: 8 \}, e: [\{ i: 9 \}] \}</code>&nbsp;
-
-<code>extend(obj1, obj2) == {toString(extend({ a: 1, b: [2, 3], c: { d: 4 }, e: [{ f: 5 }] }, { g: 6, b: [7], c: { h: 8 }, e: [{ i: 9 }] }))}</code>&nbsp;
-
-## Merge
-
-Performs a deep merge between multiple objects, changing the first object in place.
-
-<code>const obj1 = \{ a: 1, b: [2, 3], c: \{ d: 4 \}, e: [\{ f: 5 \}] \}</code>&nbsp;
-
-<code>const obj2 = \{ g: 6, b: [7], c: \{ h: 8 \}, e: [\{ i: 9 \}] \}</code>&nbsp;
-
-<code>merge(obj1, obj2) == {toString(merge({ a: 1, b: [2, 3], c: { d: 4 }, e: [{ f: 5 }] }, { g: 6, b: [7], c: { h: 8 }, e: [{ i: 9 }] }))}</code>&nbsp;

package/src/docs/utils/functions/functions.mdx

@@ -1,34 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { compose, pipe } from '@inglorious/utils/functions/functions'
-import { toString } from '@inglorious/utils/data-structures/object'
-
-<Meta title="Utils/Functions/Functions" />
-
-# Functions
-
-Basic functions that deal with ...functions.
-
-## Compose
-
-Implements function composition, which expects functions to wrap each other.
-
-<code>const shout = (x) => x.toUpperCase()</code>&nbsp;
-
-<code>const punctuate = (mark) => (x) => \`$\{x\}$\{mark\}\`</code>&nbsp;
-
-<code>const html = (tag) => (x) => \`\<$\{tag\}>$\{x\}\</$\{tag\}>\`</code>&nbsp;
-
-<code>compose(html('p'), punctuate('!'), shout)("Hello world") == {toString(compose((x) => `<${"p"}>${x}</${"p"}>`, (x) => `${x}${"!"}`, (x) => x.toUpperCase())("Hello world"))}</code>&nbsp;
-
-## Pipe
-
-Implements function piping, which functions to be processed one after the other in order.
-
-<code>const shout = (x) => x.toUpperCase()</code>&nbsp;
-
-<code>const punctuate = (mark) => (x) => \`$\{x\}$\{mark\}\`</code>&nbsp;
-
-<code>const html = (tag) => (x) => \`\<$\{tag\}>$\{x\}\</$\{tag\}>\`</code>&nbsp;
-
-<code>pipe(shout, punctuate('!'), html('p'))("Hello world") == {toString(pipe((x) => x.toUpperCase(), ((mark) => (x) => `${x}${mark}`)("!"), ((tag) => (x) => `<${tag}>${x}</${tag}>`)("p"))("Hello world"))}</code>&nbsp;

package/src/docs/utils/math/geometry/circle.mdx

@@ -1,55 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { toString } from '@inglorious/utils/data-structures/boolean.js'
-import { intersectsCircle, intersectsPlatform, intersectsPoint, intersectsRectangle } from '@inglorious/utils/math/geometry/circle.js'
-
-<Meta title="Utils/Math/Geometry/Circle" />
-
-# Circle
-
-Intersection functions for a circle.
-
-## Intersects Point
-
-Checks if a circle intersects with a point.
-
-<code>intersectsPoint(\{ position: [1, 1, 0], radius: 1 }, [1.5, 1.5, 0]) == {toString(intersectsPoint({ position: [1, 1, 0], radius: 1 }, [1.5, 1.5, 0]))}</code>&nbsp;
-
-
-## Intersects Circle
-
-Checks if a circle intersects with another circle.
-
-<code>intersectsCircle(\{ position: [1, 1, 0], radius: 1 }, \{ position: [1, 1, 0], radius: 1 \}) == {toString(intersectsCircle({ position: [1, 1, 0], radius: 1 }, { position: [1, 1, 0], radius: 1 }))}</code>&nbsp;
-
-<code>intersectsCircle(\{ position: [1, 1, 0], radius: 1 }, \{ position: [2, 1, 0], radius: 1 \}) == {toString(intersectsCircle({ position: [1, 1, 0], radius: 1 }, { position: [2, 1, 0], radius: 1 }))}</code>&nbsp;
-
-<code>intersectsCircle(\{ position: [1, 1, 0], radius: 1 }, \{ position: [3, 1, 0], radius: 1 \}) == {toString(intersectsCircle({ position: [1, 1, 0], radius: 1 }, { position: [3, 1, 0], radius: 1 }))}</code>&nbsp;
-
-<code>intersectsCircle(\{ position: [1, 1, 0], radius: 1 }, \{ position: [4, 1, 0], radius: 1 \}) == {toString(intersectsCircle({ position: [1, 1, 0], radius: 1 }, { position: [4, 1, 0], radius: 1 }))}</code>&nbsp;
-
-## Intersects Rectangle
-
-Checks if a circle intersects with a rectangle.
-
-<code>intersectsRectangle(\{ position: [1, 1, 0], radius: 1 }, \{ position: [-1, -1, 0], size: [4, 4, 0] \}) == {toString(intersectsRectangle({ position: [1, 1, 0], radius: 1 }, { position: [-1, -1, 0], size: [4, 4, 0] }))}</code>&nbsp;
-
-<code>intersectsRectangle(\{ position: [1, 1, 0], radius: 1 }, \{ position: [-2, 0, 0], size: [2, 2, 0] \}) == {toString(intersectsRectangle({ position: [1, 1, 0], radius: 1 }, { position: [-2, 0, 0], size: [2, 2, 0] }))}</code>&nbsp;
-
-<code>intersectsRectangle(\{ position: [1, 1, 0], radius: 1 }, \{ position: [-1, -1, 0], size: [2, 2, 0] \}) == {toString(intersectsRectangle({ position: [1, 1, 0], radius: 1 }, { position: [-1, -1, 0], size: [2, 2, 0] }))}</code>&nbsp;
-
-<code>intersectsRectangle(\{ position: [1, 1, 0], radius: 1 }, \{ position: [-3, 0, 0], size: [2, 2, 0] \}) == {toString(intersectsRectangle({ position: [1, 1, 0], radius: 1 }, { position: [-3, 0, 0], size: [2, 2, 0] }))}</code>&nbsp;
-
-## Intersects Platform
-
-Checks if a circle intersects with a platform.
-
-<code>intersectsPlatform(\{ position: [1, 0, 1], radius: 1 }, \{ position: [-1, 0, 0], size: [2, 1] \}) == {toString(intersectsPlatform({ position: [1, 1, 0], radius: 1 }, { position: [-1, 0, 0], size: [2, 1, 0] }))}</code>&nbsp;
-
-<code>intersectsPlatform(\{ position: [1, 0, 1], radius: 1 }, \{ position: [0, 0, -2], size: [2, 1] \}) == {toString(intersectsPlatform({ position: [1, 1, 0], radius: 1 }, { position: [0, -1, ], size: [2, 1, 0] }))}</code>&nbsp;
-
-<code>intersectsPlatform(\{ position: [1, 0, 1], radius: 1 }, \{ position: [-1, 0, -1], size: [2, 2] \}) == {toString(intersectsPlatform({ position: [1, 1, 0], radius: 1 }, { position: [-1, -1, 0], size: [2, 2, 0] }))}</code>&nbsp;
-
-<code>intersectsPlatform(\{ position: [1, 0, 1], radius: 1 }, \{ position: [0, 0, 2], size: [2, 1] \}) == {toString(intersectsPlatform({ position: [1, 1, 0], radius: 1 }, { position: [0, 2, 0], size: [2, 1, 0] }))}</code>&nbsp;
-
-<code>intersectsPlatform(\{ position: [1, 0, 1], radius: 1 }, \{ position: [-3, 0, -1], size: [2, 1] \}) == {toString(intersectsPlatform({ position: [1, 1, 0], radius: 1 }, { position: [-3, -1, 0], size: [2, 1, 0] }))}</code>&nbsp;

package/src/docs/utils/math/geometry/point.mdx

@@ -1,38 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { toString } from '@inglorious/utils/data-structures/boolean.js'
-import { intersectsPoint, intersectsCircle, intersectsRectangle } from '@inglorious/utils/math/geometry/point.js'
-
-<Meta title="Utils/Math/Geometry/Point" />
-
-# Point
-
-Intersection functions for a point.
-
-## Intersects Point
-
-Checks if a point is in the same place as another.
-
-<code>intersectsPoint([1.5, 1.5, 0], [1.5, 1.5, 0]) == {toString(intersectsPoint([1.5, 1.5, 0], [1.5, 1.5, 0]))}</code>&nbsp;
-
-<code>intersectsPoint([1.5, 1.5, 0], [2, 1, 0]) == {toString(intersectsPoint([1.5, 1.5, 0], [2, 1, 0]))}</code>&nbsp;
-
-## Intersects Circle
-
-Checks if a point is inside of a circle.
-
-<code>intersectsCircle([1.5, 1.5, 0], \{ position: [1, 1, 0], radius: 1 \}) == {toString(intersectsCircle([1.5, 1.5, 0], { position: [1, 1, 0], radius: 1 }))}</code>&nbsp;
-
-<code>intersectsCircle([2, 1, 0], \{ position: [1, 1, 0], radius: 1 \}) == {toString(intersectsCircle([2, 1, 0], { position: [1, 1, 0], radius: 1 }))}</code>&nbsp;
-
-<code>intersectsCircle([2, 2, 0], \{ position: [1, 1, 0], radius: 1 \}) == {toString(intersectsCircle([2, 2, 0], { position: [1, 1, 0], radius: 1 }))}</code>&nbsp;
-
-## Intersects Rectangle
-
-Checks if a point is inside of a rectangle.
-
-<code>intersectsRectangle([1.5, 1.5, 0], \{ position: [1, 1, 0], size: [2, 2, 0] \}) == {toString(intersectsRectangle([1.5, 1.5, 0], { position: [1, 1, 0], size: [2, 2, 0] }))}</code>&nbsp;
-
-<code>intersectsRectangle([2, 1, 0], \{ position: [1, 1, 0], size: [2, 2, 0] \}) == {toString(intersectsRectangle([2, 1, 0], { position: [1, 1, 0], size: [2, 2, 0] }))}</code>&nbsp;
-
-<code>intersectsRectangle([2.5, 2.5, 0], \{ position: [1, 1, 0], size: [2, 2, 0] \}) == {toString(intersectsRectangle([2.5, 2.5, 0], { position: [1, 1, 0], size: [2, 2, 0] }))}</code>&nbsp;

package/src/docs/utils/math/geometry/rectangle.mdx

@@ -1,24 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { toString } from '@inglorious/utils/data-structures/boolean.js'
-import { intersectsPlatform } from '@inglorious/utils/math/geometry/rectangle.js'
-
-<Meta title="Utils/Math/Geometry/Rectangle" />
-
-# Rectangle
-
-Intersection functions for a rectangle.
-
-## Intersects Platform
-
-Checks if a rectangle intersects with a platform.
-
-<code>intersectsPlatform(\{ position: [0, 0, 0], size: [2, 2, 0] }, \{ position: [0, -1, 0], size: [2, 2, 0] \}) == {toString(intersectsPlatform({ position: [0, 0, 0], size: [2, 2, 0] }, { position: [0, -1, 0], size: [2, 2, 0] }))}</code>&nbsp;
-
-<code>intersectsPlatform(\{ position: [0, 0, 0], size: [2, 2, 0] }, \{ position: [0, -2, 0], size: [2, 2, 0] \}) == {toString(intersectsPlatform({ position: [0, 0, 0], size: [2, 2, 0] }, { position: [0, -2, 0], size: [2, 2, 0] }))}</code>&nbsp;
-
-<code>intersectsPlatform(\{ position: [0, 0, 0], size: [2, 2, 0] }, \{ position: [0, 1, 0], size: [2, 2, 0] \}) == {toString(intersectsPlatform({ position: [0, 0, 0], size: [2, 2, 0] }, { position: [0, 1, 0], size: [2, 2, 0] }))}</code>&nbsp;
-
-<code>intersectsPlatform(\{ position: [0, 0, 0], size: [2, 2, 0] }, \{ position: [0, -3, 0], size: [2, 2, 0] \}) == {toString(intersectsPlatform({ position: [0, 0, 0], size: [2, 2, 0] }, { position: [0, -3, 0], size: [2, 2, 0] }))}</code>&nbsp;
-
-<code>intersectsPlatform(\{ position: [0, 0, 0], size: [2, 2, 0] }, \{ position: [-3, 0, 0], size: [2, 2, 0] \}) == {toString(intersectsPlatform({ position: [0, 0, 0], size: [2, 2, 0] }, { position: [-3, 0, 0], size: [2, 2, 0] }))}</code>&nbsp;

package/src/docs/utils/math/geometry/segment.mdx

@@ -1,55 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { toString } from '@inglorious/utils/data-structures/boolean.js'
-import { toString as vToString } from '@inglorious/utils/math/linear-algebra/vector.js'
-import { coefficients, distanceFromPoint, intersectsCircle } from '@inglorious/utils/math/geometry/segment.js'
-
-<Meta title="Utils/Math/Geometry/Segment" />
-
-# Segment
-
-Utility functions for line segments.
-
-## Coefficients
-
-Retrieves values of *a*, *b*, and *c* from a segment, so it looks like a line in the form *ax + by + c = 0*.
-
-<code>coefficients(\{ from: [0, 0, 0], to: [2, 0, 1] \}) == {vToString(coefficients({ from: [0, 0, 0], to: [2, 0, 1] }))}</code>&nbsp;
-
-## Distance from point
-
-Computes the distance between a segment and a point.
-
-<code>distanceFromPoint(\{ from: [0, 0, 0], to: [3, 0, 4] \}, [5, 0, 0]) == {distanceFromPoint({ from: [0, 0, 0], to: [3, 0, 4] }, [5, 0, 0])}</code>&nbsp;
-
-If the point rests on the segment, it will return zero.
-
-<code>distanceFromPoint(\{ from: [0, 0, 0], to: [2, 0, 2] \}, [1, 0, 1]) == {distanceFromPoint({ from: [0, 0, 0], to: [2, 0, 2] }, [1, 0, 1]).toFixed(0)}</code>&nbsp;
-
-If the point does not project on the segment, returns the distance between the point and the closest end of the segment.
-
-<code>distanceFromPoint(\{ from: [0, 0, 0], to: [3, 0, 4] \}, [-2, 0, 0]) == {distanceFromPoint({ from: [0, 0, 0], to: [3, 0, 4] }, [-2, 0, 0])}</code>&nbsp;
-
-<code>distanceFromPoint(\{ from: [0, 0, 0], to: [3, 0, 4] \}, [5, 0, 4]) == {distanceFromPoint({ from: [0, 0, 0], to: [3, 0, 4] }, [5, 0, 4])}</code>&nbsp;
-
-## Intersects circle
-
-Checks if a segment overlaps with a circle.
-
-<code>intersectsCircle(\{ from: [0, 0, 0], to: [2, 0, 2] \}, \{ position: [1, 0, 1], radius: 1 \}) == {toString(intersectsCircle({ from: [0, 0, 0], to: [2, 0, 2] }, { position: [1, 0, 1], radius: 1 }))}</code>&nbsp;
-
-A segment tangent to the circle is considered to be intersecting with it.
-
-<code>intersectsCircle(\{ from: [0, 0, 0], to: [0, 0, 2] \}, \{ position: [1, 0, 1], radius: 1 \}) == {toString(intersectsCircle({ from: [0, 0, 0], to: [0, 0, 2] }, { position: [1, 0, 1], radius: 1 }))}</code>&nbsp;
-
-A segment resting inside of the circle is considered to be intersecting with it.
-
-<code>intersectsCircle(\{ from: [0.5, 0, 0.5], to: [1.5, 0, 1.5] \}, \{ position: [1, 0, 1], radius: 1 \}) == {toString(intersectsCircle({ from: [0.5, 0, 0.5], to: [1.5, 0, 1.5] }, { position: [1, 0, 1], radius: 1 }))}</code>&nbsp;
-
-A segment that does not cross a circle does not intersect with it.
-
-<code>intersectsCircle(\{ from: [0, 0, 0], to: [-2, 0, -2] \}, \{ position: [1, 0, 1], radius: 1 \}) == {toString(intersectsCircle({ from: [0, 0, 0], to: [-2, 0, 2] }, { position: [1, 0, 1], radius: 1 }))}</code>&nbsp;
-
-A segment is different from a line: even if its continuation would cross the circle, the segment itself does not.
-
-<code>intersectsCircle(\{ from: [0, 0, 0], to: [-1, 0, -2] \}, \{ position: [1, 0, 1], radius: 1 \}) == {toString(intersectsCircle({ from: [0, 0, 0], to: [-1, 0, 2] }, { position: [1, 0, 1], radius: 1 }))}</code>&nbsp;

package/src/docs/utils/math/geometry/triangle.mdx

@@ -1,22 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { toString } from '@inglorious/utils/data-structures/boolean.js'
-import { hypothenuse, pythagoras } from '@inglorious/utils/math/geometry/triangle.js'
-
-<Meta title="Utils/Math/Geometry/Triangle" />
-
-# Triangle
-
-Basic triangle geometry functions.
-
-## Hypothenuse
-
-Uses Pythagora's theorem to calculate the hypothenuse of a right triangle (alias `pythagoras`).
-
-<code>hypothenuse(3, 4) == {hypothenuse(3, 4)}</code>&nbsp;
-
-## Pythagoras
-
-Alias of `hypothenuse`.
-
-<code>pythagoras(3, 4) == {pythagoras(3, 4)}</code>&nbsp;

package/src/docs/utils/math/linear-algebra/2d.mdx

@@ -1,22 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { from2D, to2D } from '@inglorious/utils/math/linear-algebra/2d'
-import { toString } from '@inglorious/utils/math/linear-algebra/vector'
-
-<Meta title="Utils/Math/Linear Algebra/2D" />
-
-# 2D
-
-Functions to convert any vector to 2D and viceversa.
-
-## From 2D
-
-Builds a 3D vector from a 2D one.
-
-<code>from2D([3, 4]) == {toString(from2D([3, 4]))}</code>&nbsp;
-
-## To 2D
-
-Builds a 2D vector from a 3D one.
-
-<code>to2D([3, 0, 4]) == {toString(to2D([3, 0, 4]))}</code>&nbsp;

package/src/docs/utils/math/linear-algebra/quaternion.mdx

@@ -1,21 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { quaternion } from '@inglorious/utils/math/linear-algebra/quaternion'
-import { toString } from '@inglorious/utils/math/linear-algebra/vector'
-import { pi } from '@inglorious/utils/math/trigonometry'
-
-<Meta title="Utils/Math/Linear Algebra/Quaternion" />
-
-# Quaternion
-
-Functions to deal with a single quaternion.
-
-## Quaternion
-
-Creates a quaternion from any angle.
-
-<code>quaternion(0) == {toString(quaternion(0))}</code>&nbsp;
-
-<code>quaternion(pi() / 2) == {toString(quaternion(pi() / 2), 3)}</code> (&asymp;[cos(&pi;/4), 0, sin(&pi;/4), 0])
-
-<code>quaternion(-pi() / 2) == {toString(quaternion(-pi() / 2), 3)}</code> (&asymp;[cos(-&pi;/4), 0, sin(-&pi;/4), 0])

package/src/docs/utils/math/linear-algebra/quaternions.mdx

@@ -1,22 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { combine } from '@inglorious/utils/math/linear-algebra/quaternions'
-import { quaternion } from '@inglorious/utils/math/linear-algebra/quaternion'
-import { toString } from '@inglorious/utils/math/linear-algebra/vector'
-import { pi } from '@inglorious/utils/math/trigonometry'
-
-<Meta title="Utils/Math/Linear Algebra/Quaternions" />
-
-# Quaternions
-
-Functions that deal with multiple quaternions.
-
-## Combine
-
-Multiplies two quaternions together. The algorithm used is the second approach described in [Wikipedia](https://en.wikipedia.org/wiki/Quaternions_and_spatial_rotation#Used_methods).
-
-<code>combine(quaternion(0), quaternion(0)) == {toString(combine(quaternion(0), quaternion(0)))}</code>&nbsp;
-
-<code>combine(quaternion(0), quaternion(pi() / 2)) == {toString(combine(quaternion(0), quaternion(pi() / 2)), 3)}</code> (&asymp;[cos(&pi;/4), 0, sin(&pi;/4), 0])
-
-<code>combine(quaternion(pi() / 2), quaternion(pi() / 2)) == {toString(combine(quaternion(pi() / 2), quaternion(pi() / 2)))}</code>&nbsp;

package/src/docs/utils/math/linear-algebra/vector.mdx

@@ -1,177 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import {
-angle,
-clamp,
-conjugate,
-divide,
-fromAngle,
-magnitude,
-mod,
-multiply,
-normalize,
-rotate,
-setAngle,
-setMagnitude,
-shift,
-toCartesian,
-toCylindrical,
-toPolar,
-toString,
-unit,
-} from '@inglorious/utils/math/linear-algebra/vector'
-import { pi, cos, sin } from '@inglorious/utils/math/trigonometry'
-
-<Meta title="Utils/Math/Linear Algebra/Vector" />
-
-# Vector
-
-Functions that deal with a single vector.
-
-## Angle
-
-Returns the angle of a vector, calculated as the `atan2` between the last and first coordinate.
-
-<code>angle([1, 1]) == {angle([1, 1]).toFixed(3)}</code> (&asymp;&pi;/4)
-
-<code>angle([1, 0, 1]) == {angle([1, 0, 1]).toFixed(3)}</code> (&asymp;&pi;/4)
-
-## Clamp
-
-Limits the magnitude of a vector to a lower and upper bound.
-
-<code>clamp([6, 8], 0, 5) == {toString(clamp([6, 8], 0, 5))}</code>&nbsp;
-
-<code>clamp([3, 4], 0, 5) == {toString(clamp([3, 4], 0, 5))}</code>&nbsp;
-
-Bounds can be specified as other vectors too.
-
-<code>clamp([6, 8], [0, 0], [3, 4]) == {toString(clamp([6, 8], [0, 0], [3, 4]))}</code>&nbsp;
-
-## Conjugate
-
-Flips the sign of all coordinates except the first one.
-
-<code>conjugate([1, 2, 3]) == {toString(conjugate([1, 2, 3]))}</code>&nbsp;
-
-## Divide
-
-Divides any vector by a scalar.
-
-<code>divide([4, 8, 12], 4) == {toString(divide([4, 8, 12], 4))}</code>&nbsp;
-
-## From Angle
-
-Creates a 3D unit vector from a given angle.
-
-<code>fromAngle(pi() / 4) == {toString(fromAngle(pi() / 4))}</code>&nbsp;
-
-## Length
-
-Alias of `magnitude`.
-
-## Magnitude
-
-Computes the magnitude of any vector (alias `length`).
-
-<code>magnitude([3, 4]) == {magnitude([3, 4])}</code>&nbsp;
-
-## Mod
-
-Applies the `mod` operator on any vector (alias `remainder`).
-
-<code>mod([10, 12, -18], 12) == {toString(mod([10, 12, -18], 12))}</code>&nbsp;
-
-## Multiply
-
-Multiplies a vector with a scalar (alias `times`).
-
-<code>multiply([1, 2, 3], 4) == {toString(multiply([1, 2, 3], 4))}</code>&nbsp;
-
-## Normalize
-
-Gives the vector unit length while maintaining its angle.
-
-<code>normalize([3, 4]) == {toString(normalize([3, 4]), 1)}</code>&nbsp;
-
-<code>normalize([-3, -4]) == {toString(normalize([-3, -4]), 1)}</code>&nbsp;
-
-## Remainder
-
-Alias of `mod`.
-
-## Rotate
-
-Adds the given angle to a 2D or 3D vector using quaternions.
-
-<code>rotate([1, 0], 0) == {toString(rotate([1, 0], 0))}</code>&nbsp;
-
-<code>rotate([1, 0], pi() / 4) == {toString(rotate([1, 0], pi() / 4), 3)}</code> (&asymp;[cos(&pi;/4), sin(&pi;/4)])
-
-<code>rotate([1, 0, 0], 0) == {toString(rotate([1, 0, 0], 0))}</code>&nbsp;
-
-<code>rotate([1, 0, 0], pi() / 4) == {toString(rotate([1, 0, 0], pi() / 4), 3)}</code> (&asymp;[cos(&pi;/4), 0, sin(&pi;/4)])
-
-<code>rotate([-1, 0, 0], pi() / 4) == {toString(rotate([-1, 0, 0], pi() / 4), 3)}</code> (&asymp;[cos(-3/4*&pi;), 0, sin(-3/4*&pi;)])
-
-## Set Angle
-
-Changes the angle of a vector.
-
-<code>setAngle([cos(pi() / 4), 0, sin(pi() / 4)], pi() / 2) == {toString(setAngle([cos(pi() / 4), 0, sin(pi() / 4)], pi() / 2))}</code>&nbsp;
-
-## Set Magnitude
-
-Changes the magnitude of any vector, keeping its angle.
-
-<code>setMagnitude([3, 4], 10) == {toString(setMagnitude([3, 4], 10))}</code>&nbsp;
-
-<code>setMagnitude([-3, -4], 10) == {toString(setMagnitude([-3, -4], 10))}</code>&nbsp;
-
-## Shift
-
-Moves coordinates around by a certain index.
-
-<code>shift([1, 2, 3, 4, 5], 2) == {toString(shift([1, 2, 3, 4, 5], 2))}</code>&nbsp;
-
-## Times
-
-Alias of `multiply`.
-
-## To Cartesian
-
-Converts a 2D polar vector into cartesian coordinates.
-
-<code>toCartesian([2 ** 0.5, pi() / 4]) == {toString(toCartesian([2 ** 0.5, pi() / 4]))}</code>&nbsp;
-
-## To Cylindrical
-
-Converts a 3D cartesian vector to cylindrical coordinates.
-
-<code>toCylindrical([1, 1, 1]) == {toString(toCylindrical([1, 1, 1]), 3)}</code>&nbsp;
-
-## To Polar
-
-Converts a 2D cartesian vector to polar coordinates.
-
-<code>toPolar([1, 1]) == {toString(toPolar([1, 1]))}</code> (&asymp;[&#8730;2, &pi;/4])
-
-## To Spherical
-
-TBD
-
-## To String
-
-Returns a string representation of any vector, up to optional decimal points.
-
-<code>toString([1, 0]) == "{toString([1, 0])}"</code>&nbsp;
-
-<code>toString([cos(pi() / 4), 0], 3) == "{toString([cos(pi() / 4), 0], 3)}"</code>&nbsp;
-
-## Unit
-
-Returns a unit 3D vector at a given optional angle.
-
-<code>unit() == {toString(unit())}</code>&nbsp;
-
-<code>unit(pi() / 2) == {toString(unit(pi() / 2))}</code>&nbsp;

package/src/docs/utils/math/linear-algebra/vectors.mdx

@@ -1,58 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import {
-cross,
-dot,
-scalarProduct,
-subtract,
-sum,
-vectorProduct,
-} from '@inglorious/utils/math/linear-algebra/vectors'
-import { toString } from '@inglorious/utils/math/linear-algebra/vector'
-import { pi, cos, sin } from '@inglorious/utils/math/trigonometry'
-
-<Meta title="Utils/Math/Linear Algebra/Vectors" />
-
-# Vectors
-
-Functions that deal with a multiple vectors.
-
-## Cross
-
-Performs the cross product between multiple vectors (alias `vectorProduct`).
-
-<code>cross([1, 2, 3], [4, 5, 6]) == {toString(cross([1, 2, 3], [4, 5, 6]))}</code>&nbsp;
-
-<code>cross([1, 2, 3], [4, 5, 6], [7, 8, 9]) == {toString(cross([1, 2, 3], [4, 5, 6], [7, 8, 9]))}</code>&nbsp;
-
-## Dot
-
-Performs the dot product between multiple vectors (alias `scalarProduct`).
-
-<code>dot([1, 2, 3], [4, 5, 6]) == {dot([1, 2, 3], [4, 5, 6])}</code>&nbsp;
-
-<code>dot([1, 2, 3], [4, 5, 6], [7, 8, 9]) == {dot([1, 2, 3], [4, 5, 6], [7, 8, 9])}</code>&nbsp;
-
-## Scalar Product
-
-Alias of `dot`.
-
-## Subtract
-
-Subtracts all other vectors from the first one.
-
-<code>subtract([1, 2, 3], [4, 5, 6]) == {toString(subtract([1, 2, 3], [4, 5, 6]))}</code>&nbsp;
-
-<code>subtract([1, 2, 3], [4, 5, 6], [7, 8, 9]) == {toString(subtract([1, 2, 3], [4, 5, 6], [7, 8, 9]))}</code>&nbsp;
-
-## Sum
-
-Sums all coordinates together.
-
-<code>sum([1, 2, 3], [4, 5, 6]) == {toString(sum([1, 2, 3], [4, 5, 6]))}</code>&nbsp;
-
-<code>sum([1, 2, 3], [4, 5, 6], [7, 8, 9]) == {toString(sum([1, 2, 3], [4, 5, 6], [7, 8, 9]))}</code>&nbsp;
-
-## Vector Product
-
-Alias of `cross`.

package/src/docs/utils/math/numbers.mdx

@@ -1,76 +0,0 @@
-import { Meta } from '@storybook/blocks'
-
-import { toString } from '@inglorious/utils/data-structures/boolean.js'
-import { abs, clamp, isClose, mod, sign, sqrt } from '@inglorious/utils/math/numbers.js'
-
-<Meta title="Utils/Math/Numbers" />
-
-# Numbers
-
-Basic functions that deal with numbers.
-
-## Abs
-
-Returns the absolute value of any number.
-
-<code>abs(42) == {abs(42)}</code>&nbsp;
-
-<code>abs(-42) == {abs(-42)}</code>&nbsp;
-
-## Clamp
-
-Limits the given number to the specified bounds.
-
-<code>clamp(42, 0, 100) == {clamp(42, 0, 100)}</code>&nbsp;
-
-<code>clamp(-42, 0, 100) == {clamp(-42, 0, 100)}</code>&nbsp;
-
-<code>clamp(142, 0, 100) == {clamp(142, 0, 100)}</code>&nbsp;
-
-## Is Close
-
-Checks if two numbers are close to each other, given some tolerance (which is *0.1* by default).
-
-<code>isClose(42, 42.1, 0.2) == {toString(isClose(42, 42.1, 0.2))}</code>&nbsp;
-
-<code>isClose(42, 43, 0.2) == {toString(isClose(42, 43, 0.2))}</code>&nbsp;
-
-<code>isClose(42, 42.1) == {toString(isClose(42, 42.1))}</code>&nbsp;
-
-## Mod
-
-Computes the remainder of the integer division, always giving a positive value (alias `remainder`).
-
-<code>mod(2, 2) == {mod(2, 2)}</code>&nbsp;
-
-<code>mod(3, 2) == {mod(3, 2)}</code>&nbsp;
-
-<code>mod(-3, 2) == {mod(-3, 2)}</code>&nbsp;
-
-<code>mod(5 / 4, 1) == {mod(5 / 4, 1)}</code> (=1/4)&nbsp;
-
-<code>mod(5 / 4, 1) == {mod(5 / 4, 1)}</code> (=1/4)&nbsp;
-
-<code>mod(13 / 4, 1) == {mod(13 / 4, 1)}</code> (=1/4)&nbsp;
-
-<code>mod(-5 / 4, 1) == {mod(-5 / 4, 1)}</code> (=3/4)&nbsp;
-
-## Remainder
-
-Alias of `mod`.
-
-## Sign
-
-Returns +1 if the given number is positive, -1 if negative, 0 otherwise.
-
-<code>sign(42) == {sign(42)}</code>&nbsp;
-
-<code>sign(-42) == {sign(-42)}</code>&nbsp;
-
-<code>sign(0) == {sign(0)}</code>&nbsp;
-
-## Sqrt
-
-Return the square roo of the given number.
-
-<code>sqrt(9) == {sqrt(9)}</code>&nbsp;