@js-draw/math 1.0.0

package/dist/mjs/Mat33.mjs

@@ -0,0 +1,338 @@
+import  { Vec2 }  from './Vec2.mjs';
+import  Vec3  from './Vec3.mjs';
+/**
+ * Represents a three dimensional linear transformation or
+ * a two-dimensional affine transformation. (An affine transformation scales/rotates/shears
+ * **and** translates while a linear transformation just scales/rotates/shears).
+ */
+export class Mat33 {
+    /**
+     * Creates a matrix from inputs in the form,
+     * $$
+     * \begin{bmatrix}
+     *   a1 & a2 & a3 \\
+     *   b1 & b2 & b3 \\
+     *   c1 & c2 & c3
+     * \end{bmatrix}
+     * $$
+     */
+    constructor(a1, a2, a3, b1, b2, b3, c1, c2, c3) {
+        this.a1 = a1;
+        this.a2 = a2;
+        this.a3 = a3;
+        this.b1 = b1;
+        this.b2 = b2;
+        this.b3 = b3;
+        this.c1 = c1;
+        this.c2 = c2;
+        this.c3 = c3;
+        this.cachedInverse = undefined;
+        this.rows = [
+            Vec3.of(a1, a2, a3),
+            Vec3.of(b1, b2, b3),
+            Vec3.of(c1, c2, c3),
+        ];
+    }
+    /**
+     * Creates a matrix from the given rows:
+     * $$
+     * \begin{bmatrix}
+     *  \texttt{r1.x} & \texttt{r1.y} & \texttt{r1.z}\\
+     *  \texttt{r2.x} & \texttt{r2.y} & \texttt{r2.z}\\
+     *  \texttt{r3.x} & \texttt{r3.y} & \texttt{r3.z}\\
+     * \end{bmatrix}
+     * $$
+     */
+    static ofRows(r1, r2, r3) {
+        return new Mat33(r1.x, r1.y, r1.z, r2.x, r2.y, r2.z, r3.x, r3.y, r3.z);
+    }
+    /**
+     * Either returns the inverse of this, or, if this matrix is singular/uninvertable,
+     * returns Mat33.identity.
+     *
+     * This may cache the computed inverse and return the cached version instead of recomputing
+     * it.
+     */
+    inverse() {
+        return this.computeInverse() ?? Mat33.identity;
+    }
+    invertable() {
+        return this.computeInverse() !== null;
+    }
+    computeInverse() {
+        if (this.cachedInverse !== undefined) {
+            return this.cachedInverse;
+        }
+        const toIdentity = [
+            this.rows[0],
+            this.rows[1],
+            this.rows[2],
+        ];
+        const toResult = [
+            Vec3.unitX,
+            Vec3.unitY,
+            Vec3.unitZ,
+        ];
+        // Convert toIdentity to the identity matrix and
+        // toResult to the inverse through elementary row operations
+        for (let cursor = 0; cursor < 3; cursor++) {
+            // Select the [cursor]th diagonal entry
+            let pivot = toIdentity[cursor].at(cursor);
+            // Don't divide by zero (treat very small numbers as zero).
+            const minDivideBy = 1e-10;
+            if (Math.abs(pivot) < minDivideBy) {
+                let swapIndex = -1;
+                // For all other rows,
+                for (let i = 1; i <= 2; i++) {
+                    const otherRowIdx = (cursor + i) % 3;
+                    if (Math.abs(toIdentity[otherRowIdx].at(cursor)) >= minDivideBy) {
+                        swapIndex = otherRowIdx;
+                        break;
+                    }
+                }
+                // Can't swap with another row?
+                if (swapIndex === -1) {
+                    this.cachedInverse = null;
+                    return null;
+                }
+                const tmpIdentityRow = toIdentity[cursor];
+                const tmpResultRow = toResult[cursor];
+                // Swap!
+                toIdentity[cursor] = toIdentity[swapIndex];
+                toResult[cursor] = toResult[swapIndex];
+                toIdentity[swapIndex] = tmpIdentityRow;
+                toResult[swapIndex] = tmpResultRow;
+                pivot = toIdentity[cursor].at(cursor);
+            }
+            // Make toIdentity[k = cursor] = 1
+            let scale = 1.0 / pivot;
+            toIdentity[cursor] = toIdentity[cursor].times(scale);
+            toResult[cursor] = toResult[cursor].times(scale);
+            const cursorToIdentityRow = toIdentity[cursor];
+            const cursorToResultRow = toResult[cursor];
+            // Make toIdentity[k ≠ cursor] = 0
+            for (let i = 1; i <= 2; i++) {
+                const otherRowIdx = (cursor + i) % 3;
+                scale = -toIdentity[otherRowIdx].at(cursor);
+                toIdentity[otherRowIdx] = toIdentity[otherRowIdx].plus(cursorToIdentityRow.times(scale));
+                toResult[otherRowIdx] = toResult[otherRowIdx].plus(cursorToResultRow.times(scale));
+            }
+        }
+        const inverse = Mat33.ofRows(toResult[0], toResult[1], toResult[2]);
+        this.cachedInverse = inverse;
+        return inverse;
+    }
+    transposed() {
+        return new Mat33(this.a1, this.b1, this.c1, this.a2, this.b2, this.c2, this.a3, this.b3, this.c3);
+    }
+    rightMul(other) {
+        other = other.transposed();
+        const at = (row, col) => {
+            return this.rows[row].dot(other.rows[col]);
+        };
+        return new Mat33(at(0, 0), at(0, 1), at(0, 2), at(1, 0), at(1, 1), at(1, 2), at(2, 0), at(2, 1), at(2, 2));
+    }
+    /**
+     * Applies this as an **affine** transformation to the given vector.
+     * Returns a transformed version of `other`.
+     *
+     * Unlike {@link transformVec3}, this **does** translate the given vector.
+     */
+    transformVec2(other) {
+        // When transforming a Vec2, we want to use the z transformation
+        // components of this for translation:
+        //  ⎡ . . tX ⎤
+        //  ⎢ . . tY ⎥
+        //  ⎣ 0 0 1  ⎦
+        // For this, we need other's z component to be 1 (so that tX and tY
+        // are scaled by 1):
+        let intermediate = Vec3.of(other.x, other.y, 1);
+        intermediate = this.transformVec3(intermediate);
+        // Drop the z=1 to allow magnitude to work as expected
+        return Vec2.of(intermediate.x, intermediate.y);
+    }
+    /**
+     * Applies this as a linear transformation to the given vector (doesn't translate).
+     * This is the standard way of transforming vectors in ℝ³.
+     */
+    transformVec3(other) {
+        return Vec3.of(this.rows[0].dot(other), this.rows[1].dot(other), this.rows[2].dot(other));
+    }
+    /** @returns true iff this is the identity matrix. */
+    isIdentity() {
+        if (this === Mat33.identity) {
+            return true;
+        }
+        return this.eq(Mat33.identity);
+    }
+    /** Returns true iff this = other ± fuzz */
+    eq(other, fuzz = 0) {
+        for (let i = 0; i < 3; i++) {
+            if (!this.rows[i].eq(other.rows[i], fuzz)) {
+                return false;
+            }
+        }
+        return true;
+    }
+    toString() {
+        let result = '';
+        const maxColumnLens = [0, 0, 0];
+        // Determine the longest item in each column so we can pad the others to that
+        // length.
+        for (const row of this.rows) {
+            for (let i = 0; i < 3; i++) {
+                maxColumnLens[i] = Math.max(maxColumnLens[0], `${row.at(i)}`.length);
+            }
+        }
+        for (let i = 0; i < 3; i++) {
+            if (i === 0) {
+                result += '⎡ ';
+            }
+            else if (i === 1) {
+                result += '⎢ ';
+            }
+            else {
+                result += '⎣ ';
+            }
+            // Add each component of the ith row (after padding it)
+            for (let j = 0; j < 3; j++) {
+                const val = this.rows[i].at(j).toString();
+                let padding = '';
+                for (let i = val.length; i < maxColumnLens[j]; i++) {
+                    padding += ' ';
+                }
+                result += val + ', ' + padding;
+            }
+            if (i === 0) {
+                result += ' ⎤';
+            }
+            else if (i === 1) {
+                result += ' ⎥';
+            }
+            else {
+                result += ' ⎦';
+            }
+            result += '\n';
+        }
+        return result.trimEnd();
+    }
+    /**
+     * ```
+     * result[0] = top left element
+     * result[1] = element at row zero, column 1
+     * ...
+     * ```
+     */
+    toArray() {
+        return [
+            this.a1, this.a2, this.a3,
+            this.b1, this.b2, this.b3,
+            this.c1, this.c2, this.c3,
+        ];
+    }
+    /**
+     * Returns a new `Mat33` where each entry is the output of the function
+     * `mapping`.
+     *
+     * @example
+     * ```
+     * new Mat33(
+     *  1, 2, 3,
+     *  4, 5, 6,
+     *  7, 8, 9,
+     * ).mapEntries(component => component - 1);
+     * // → ⎡ 0, 1, 2 ⎤
+     * //   ⎢ 3, 4, 5 ⎥
+     * //   ⎣ 6, 7, 8 ⎦
+     * ```
+     */
+    mapEntries(mapping) {
+        return new Mat33(mapping(this.a1, [0, 0]), mapping(this.a2, [0, 1]), mapping(this.a3, [0, 2]), mapping(this.b1, [1, 0]), mapping(this.b2, [1, 1]), mapping(this.b3, [1, 2]), mapping(this.c1, [2, 0]), mapping(this.c2, [2, 1]), mapping(this.c3, [2, 2]));
+    }
+    /** Estimate the scale factor of this matrix (based on the first row). */
+    getScaleFactor() {
+        return Math.hypot(this.a1, this.a2);
+    }
+    /**
+     * Constructs a 3x3 translation matrix (for translating `Vec2`s) using
+     * **transformVec2**.
+     */
+    static translation(amount) {
+        // When transforming Vec2s by a 3x3 matrix, we give the input
+        // Vec2s z = 1. As such,
+        //   outVec2.x = inVec2.x * 1 + inVec2.y * 0 + 1 * amount.x
+        //   ...
+        return new Mat33(1, 0, amount.x, 0, 1, amount.y, 0, 0, 1);
+    }
+    static zRotation(radians, center = Vec2.zero) {
+        if (radians === 0) {
+            return Mat33.identity;
+        }
+        const cos = Math.cos(radians);
+        const sin = Math.sin(radians);
+        // Translate everything so that rotation is about the origin
+        let result = Mat33.translation(center);
+        result = result.rightMul(new Mat33(cos, -sin, 0, sin, cos, 0, 0, 0, 1));
+        return result.rightMul(Mat33.translation(center.times(-1)));
+    }
+    static scaling2D(amount, center = Vec2.zero) {
+        let result = Mat33.translation(center);
+        let xAmount, yAmount;
+        if (typeof amount === 'number') {
+            xAmount = amount;
+            yAmount = amount;
+        }
+        else {
+            xAmount = amount.x;
+            yAmount = amount.y;
+        }
+        result = result.rightMul(new Mat33(xAmount, 0, 0, 0, yAmount, 0, 0, 0, 1));
+        // Translate such that [center] goes to (0, 0)
+        return result.rightMul(Mat33.translation(center.times(-1)));
+    }
+    /** @see {@link fromCSSMatrix} */
+    toCSSMatrix() {
+        return `matrix(${this.a1},${this.b1},${this.a2},${this.b2},${this.a3},${this.b3})`;
+    }
+    /**
+     * Converts a CSS-form `matrix(a, b, c, d, e, f)` to a Mat33.
+     *
+     * Note that such a matrix has the form,
+     * ```
+     * ⎡ a c e ⎤
+     * ⎢ b d f ⎥
+     * ⎣ 0 0 1 ⎦
+     * ```
+     */
+    static fromCSSMatrix(cssString) {
+        if (cssString === '' || cssString === 'none') {
+            return Mat33.identity;
+        }
+        const numberExp = '([-]?\\d*(?:\\.\\d*)?(?:[eE][-]?\\d+)?)';
+        const numberSepExp = '[, \\t\\n]';
+        const regExpSource = `^\\s*matrix\\s*\\(${[
+            // According to MDN, matrix(a,b,c,d,e,f) has form:
+            // 		⎡ a c e ⎤
+            // 		⎢ b d f ⎥
+            // 		⎣ 0 0 1 ⎦
+            numberExp, numberExp, numberExp,
+            numberExp, numberExp, numberExp, // b, d, f
+        ].join(`${numberSepExp}+`)}${numberSepExp}*\\)\\s*$`;
+        const matrixExp = new RegExp(regExpSource, 'i');
+        const match = matrixExp.exec(cssString);
+        if (!match) {
+            throw new Error(`Unsupported transformation: ${cssString}`);
+        }
+        const matrixData = match.slice(1).map(entry => parseFloat(entry));
+        const a = matrixData[0];
+        const b = matrixData[1];
+        const c = matrixData[2];
+        const d = matrixData[3];
+        const e = matrixData[4];
+        const f = matrixData[5];
+        const transform = new Mat33(a, c, e, b, d, f, 0, 0, 1);
+        return transform;
+    }
+}
+Mat33.identity = new Mat33(1, 0, 0, 0, 1, 0, 0, 0, 1);
+export default Mat33;

package/dist/mjs/Vec2.d.ts

@@ -0,0 +1,42 @@
+import Vec3 from './Vec3';
+/**
+ * Utility functions that facilitate treating `Vec3`s as 2D vectors.
+ *
+ * @example
+ * ```ts,runnable,console
+ * import { Vec2 } from '@js-draw/math';
+ * console.log(Vec2.of(1, 2));
+ * ```
+ */
+export declare namespace Vec2 {
+    /**
+     * Creates a `Vec2` from an x and y coordinate.
+     *
+     * For example,
+     * ```ts
+     * const v = Vec2.of(3, 4); // x=3, y=4.
+     * ```
+     */
+    const of: (x: number, y: number) => Vec2;
+    /**
+     * Creates a `Vec2` from an object containing x and y coordinates.
+     *
+     * For example,
+     * ```ts
+     * const v1 = Vec2.ofXY({ x: 3, y: 4.5 });
+     * const v2 = Vec2.ofXY({ x: -123.4, y: 1 });
+     * ```
+     */
+    const ofXY: ({ x, y }: {
+        x: number;
+        y: number;
+    }) => Vec2;
+    /** A vector of length 1 in the X direction (→). */
+    const unitX: Vec3;
+    /** A vector of length 1 in the Y direction (↑). */
+    const unitY: Vec3;
+    /** The zero vector: A vector with x=0, y=0. */
+    const zero: Vec3;
+}
+export type Point2 = Vec3;
+export type Vec2 = Vec3;

package/dist/mjs/Vec2.mjs

@@ -0,0 +1,42 @@
+import  Vec3  from './Vec3.mjs';
+/**
+ * Utility functions that facilitate treating `Vec3`s as 2D vectors.
+ *
+ * @example
+ * ```ts,runnable,console
+ * import { Vec2 } from '@js-draw/math';
+ * console.log(Vec2.of(1, 2));
+ * ```
+ */
+export var Vec2;
+(function (Vec2) {
+    /**
+     * Creates a `Vec2` from an x and y coordinate.
+     *
+     * For example,
+     * ```ts
+     * const v = Vec2.of(3, 4); // x=3, y=4.
+     * ```
+     */
+    Vec2.of = (x, y) => {
+        return Vec3.of(x, y, 0);
+    };
+    /**
+     * Creates a `Vec2` from an object containing x and y coordinates.
+     *
+     * For example,
+     * ```ts
+     * const v1 = Vec2.ofXY({ x: 3, y: 4.5 });
+     * const v2 = Vec2.ofXY({ x: -123.4, y: 1 });
+     * ```
+     */
+    Vec2.ofXY = ({ x, y }) => {
+        return Vec3.of(x, y, 0);
+    };
+    /** A vector of length 1 in the X direction (→). */
+    Vec2.unitX = Vec2.of(1, 0);
+    /** A vector of length 1 in the Y direction (↑). */
+    Vec2.unitY = Vec2.of(0, 1);
+    /** The zero vector: A vector with x=0, y=0. */
+    Vec2.zero = Vec2.of(0, 0);
+})(Vec2 || (Vec2 = {}));

package/dist/mjs/Vec3.d.ts

@@ -0,0 +1,126 @@
+/**
+ * A vector with three components, $\begin{pmatrix} x \\ y \\ z \end{pmatrix}$.
+ * Can also be used to represent a two-component vector.
+ *
+ * A `Vec3` is immutable.
+ *
+ * @example
+ *
+ * ```ts,runnable,console
+ * import { Vec3 } from '@js-draw/math';
+ *
+ * console.log('Vector addition:', Vec3.of(1, 2, 3).plus(Vec3.of(0, 1, 0)));
+ * console.log('Scalar multiplication:', Vec3.of(1, 2, 3).times(2));
+ * console.log('Cross products:', Vec3.unitX.cross(Vec3.unitY));
+ * console.log('Magnitude:', Vec3.of(1, 2, 3).length(), 'or', Vec3.of(1, 2, 3).magnitude());
+ * console.log('Square Magnitude:', Vec3.of(1, 2, 3).magnitudeSquared());
+ * console.log('As an array:', Vec3.unitZ.asArray());
+ * ```
+ */
+export declare class Vec3 {
+    readonly x: number;
+    readonly y: number;
+    readonly z: number;
+    private constructor();
+    /** Returns the x, y components of this. */
+    get xy(): {
+        x: number;
+        y: number;
+    };
+    /** Construct a vector from three components. */
+    static of(x: number, y: number, z: number): Vec3;
+    /** Returns this' `idx`th component. For example, `Vec3.of(1, 2, 3).at(1) → 2`. */
+    at(idx: number): number;
+    /** Alias for this.magnitude. */
+    length(): number;
+    magnitude(): number;
+    magnitudeSquared(): number;
+    /**
+     * Return this' angle in the XY plane (treats this as a Vec2).
+     *
+     * This is equivalent to `Math.atan2(vec.y, vec.x)`.
+     */
+    angle(): number;
+    /**
+     * Returns a unit vector in the same direction as this.
+     *
+     * If `this` has zero length, the resultant vector has `NaN` components.
+     */
+    normalized(): Vec3;
+    /**
+     * Like {@link normalized}, except returns zero if this has zero magnitude.
+     */
+    normalizedOrZero(): Vec3;
+    /** @returns A copy of `this` multiplied by a scalar. */
+    times(c: number): Vec3;
+    plus(v: Vec3): Vec3;
+    minus(v: Vec3): Vec3;
+    dot(other: Vec3): number;
+    cross(other: Vec3): Vec3;
+    /**
+     * If `other` is a `Vec3`, multiplies `this` component-wise by `other`. Otherwise,
+     * if `other is a `number`, returns the result of scalar multiplication.
+     *
+     * @example
+     * ```
+     * Vec3.of(1, 2, 3).scale(Vec3.of(2, 4, 6)); // → Vec3(2, 8, 18)
+     * ```
+     */
+    scale(other: Vec3 | number): Vec3;
+    /**
+     * Returns a vector orthogonal to this. If this is a Vec2, returns `this` rotated
+     * 90 degrees counter-clockwise.
+     */
+    orthog(): Vec3;
+    /** Returns this plus a vector of length `distance` in `direction`. */
+    extend(distance: number, direction: Vec3): Vec3;
+    /** Returns a vector `fractionTo` of the way to target from this. */
+    lerp(target: Vec3, fractionTo: number): Vec3;
+    /**
+     * `zip` Maps a component of this and a corresponding component of
+     * `other` to a component of the output vector.
+     *
+     * @example
+     * ```
+     * const a = Vec3.of(1, 2, 3);
+     * const b = Vec3.of(0.5, 2.1, 2.9);
+     *
+     * const zipped = a.zip(b, (aComponent, bComponent) => {
+     *   return Math.min(aComponent, bComponent);
+     * });
+     *
+     * console.log(zipped.toString()); // → Vec(0.5, 2, 2.9)
+     * ```
+     */
+    zip(other: Vec3, zip: (componentInThis: number, componentInOther: number) => number): Vec3;
+    /**
+     * Returns a vector with each component acted on by `fn`.
+     *
+     * @example
+     * ```
+     * console.log(Vec3.of(1, 2, 3).map(val => val + 1)); // → Vec(2, 3, 4)
+     * ```
+     */
+    map(fn: (component: number, index: number) => number): Vec3;
+    asArray(): [number, number, number];
+    /**
+     * [fuzz] The maximum difference between two components for this and [other]
+     * to be considered equal.
+     *
+     * @example
+     * ```
+     * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 100);  // → true
+     * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 0.1);  // → false
+     * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 3);    // → true
+     * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 3.01); // → true
+     * Vec3.of(1, 2, 3).eq(Vec3.of(4, 5, 6), 2.99); // → false
+     * ```
+     */
+    eq(other: Vec3, fuzz?: number): boolean;
+    toString(): string;
+    static unitX: Vec3;
+    static unitY: Vec3;
+    static unitZ: Vec3;
+    static zero: Vec3;
+}
+export default Vec3;