@lakuna/umath 2.0.0 → 3.0.1

package/dist/linalg/Vector.d.ts

@@ -1,163 +1,164 @@
-/**
- * An object that could be interpreted as a vector.
- * @public
- */
-export type VectorLike = Record<number, number>;
+import type { Vector4Like } from "./Vector4.js";
 /**
  * A quantity with magnitude and direction.
  * @see {@link https://en.wikipedia.org/wiki/Euclidean_vector | Euclidean vector}
  * @public
  */
 export default interface Vector extends VectorLike {
-    /**
-     * Determine whether this vector is roughly equivalent to another.
-     * @param vector - The other vector.
-     * @returns Whether the vectors are equivalent.
-     */
-    equals(vector: VectorLike): boolean;
-    /**
-     * Determine whether this vector is exactly equivalent to another.
-     * @param vector - The other vector.
-     * @returns Whether the vectors are equivalent.
-     */
-    exactEquals(vector: VectorLike): boolean;
     /**
      * Add two vectors of the same size.
      * @param vector - The other vector.
      * @returns The sum of the vectors.
      */
-    add(vector: VectorLike): VectorLike;
+    add: (vector: Readonly<Vector4Like>) => VectorLike;
+    /**
+     * Round up the components of this vector.
+     * @returns The rounded vector.
+     */
+    ceil: () => VectorLike;
     /**
      * Create a copy of this vector.
      * @returns A copy of this vector.
      */
-    clone(): VectorLike;
+    clone: () => VectorLike;
     /**
      * Copy the values of another vector into this one.
      * @param vector - The vector to copy.
      * @returns This vector.
      */
-    copy(vector: VectorLike): this;
+    copy: (vector: Readonly<Vector4Like>) => this;
     /**
-     * Multiply this vector by another.
+     * Calculate the Euclidean distance between this vector and another.
      * @param vector - The other vector.
-     * @returns The product of the vectors.
+     * @returns The distance.
      */
-    multiply(vector: VectorLike): VectorLike;
+    distance: (vector: Readonly<Vector4Like>) => number;
     /**
      * Divide this vector by another.
      * @param vector - The other vector.
      * @returns The quotient of the vectors.
      */
-    divide(vector: VectorLike): VectorLike;
+    divide: (vector: Readonly<Vector4Like>) => VectorLike;
     /**
-     * Subtract another vector from this one.
+     * Calculate the dot product of this and another vector.
      * @param vector - The other vector.
-     * @returns The difference between the vectors.
+     * @returns The dot product.
+     * @see {@link https://en.wikipedia.org/wiki/Dot_product | Dot product}
      */
-    subtract(vector: VectorLike): VectorLike;
+    dot: (vector: Readonly<Vector4Like>) => number;
     /**
-     * Round up the components of this vector.
-     * @returns The rounded vector.
+     * Determine whether this vector is roughly equivalent to another.
+     * @param vector - The other vector.
+     * @returns Whether the vectors are equivalent.
+     */
+    equals: (vector: Readonly<Vector4Like>) => boolean;
+    /**
+     * Determine whether this vector is exactly equivalent to another.
+     * @param vector - The other vector.
+     * @returns Whether the vectors are equivalent.
      */
-    ceil(): VectorLike;
+    exactEquals: (vector: Readonly<Vector4Like>) => boolean;
     /**
      * Round down the components of this vector.
      * @returns The rounded vector.
      */
-    floor(): VectorLike;
+    floor: () => VectorLike;
     /**
-     * Round the components of this vector.
-     * @returns The rounded vector.
+     * Calculate the multiplicative inverse of the components of this vector.
+     * @returns The inverted vector.
      */
-    round(): VectorLike;
+    invert: () => VectorLike;
     /**
-     * Return the minimum of this and another vector.
+     * Perform a linear interpolation between this and another vector.
      * @param vector - The other vector.
-     * @returns The minimum.
+     * @param t - The interpolation amount (in `[0,1]`).
+     * @returns The interpolated vector.
      */
-    min(vector: VectorLike): VectorLike;
+    lerp: (vector: Readonly<Vector4Like>, t: number) => VectorLike;
+    /** Get the magnitude (length) of this vector. */
+    get magnitude(): number;
     /**
      * Return the maximum of this and another vector.
      * @param vector - The other vector.
      * @returns The maximum.
      */
-    max(vector: VectorLike): VectorLike;
+    max: (vector: Readonly<Vector4Like>) => VectorLike;
+    /**
+     * Return the minimum of this and another vector.
+     * @param vector - The other vector.
+     * @returns The minimum.
+     */
+    min: (vector: Readonly<Vector4Like>) => VectorLike;
+    /**
+     * Multiply this vector by another.
+     * @param vector - The other vector.
+     * @returns The product of the vectors.
+     */
+    multiply: (vector: Readonly<Vector4Like>) => VectorLike;
+    /**
+     * Negate this vector.
+     * @returns The negated vector.
+     */
+    negate: () => VectorLike;
+    /**
+     * Normalize this vector.
+     * @returns The normalized vector.
+     * @see {@link https://en.wikipedia.org/wiki/Unit_vector | Unit vector}
+     */
+    normalize: () => VectorLike;
     /**
      * Raise each component of this vector to the given power.
      * @param exponent - The exponent (power) to raise each component to.
      * @returns The power (result of the exponentiation).
      */
-    pow(exponent: number): VectorLike;
+    pow: (exponent: number) => VectorLike;
+    /**
+     * Set this vector to a random value with the given magnitude.
+     * @param magnitude - The magnitude.
+     * @returns This vector.
+     */
+    random: (magnitude: number) => this;
+    /**
+     * Round the components of this vector.
+     * @returns The rounded vector.
+     */
+    round: () => VectorLike;
     /**
      * Scale this vector by a scalar.
      * @param scalar - The scalar.
      * @returns The scaled vector.
      */
-    scale(scalar: number): VectorLike;
+    scale: (scalar: number) => VectorLike;
     /**
      * Add another vector to this one after scaling the other by a scalar.
      * @param vector - The other vector.
      * @param scalar - The scalar.
      * @returns The sum.
      */
-    scaleAndAdd(vector: VectorLike, scalar: number): VectorLike;
-    /**
-     * Calculate the Euclidean distance between this vector and another.
-     * @param vector - The other vector.
-     * @returns The distance.
-     */
-    distance(vector: VectorLike): number;
+    scaleAndAdd: (vector: Readonly<Vector4Like>, scalar: number) => VectorLike;
     /**
      * Calculate the squared Euclidean distance between this vector and another.
      * @param vector - The other vector.
      * @returns The squared distance.
      */
-    squaredDistance(vector: VectorLike): number;
-    /** Get the magnitude (length) of this vector. */
-    get magnitude(): number;
+    squaredDistance: (vector: Readonly<Vector4Like>) => number;
     /** Get the squared magnitude (length) of this vector. */
     get squaredMagnitude(): number;
     /**
-     * Negate this vector.
-     * @returns The negated vector.
-     */
-    negate(): VectorLike;
-    /**
-     * Calculate the multiplicative inverse of the components of this vector.
-     * @returns The inverted vector.
-     */
-    invert(): VectorLike;
-    /**
-     * Normalize this vector.
-     * @returns The normalized vector.
-     * @see {@link https://en.wikipedia.org/wiki/Unit_vector | Unit vector}
-     */
-    normalize(): VectorLike;
-    /**
-     * Calculate the dot product of this and another vector.
-     * @param vector - The other vector.
-     * @returns The dot product.
-     * @see {@link https://en.wikipedia.org/wiki/Dot_product | Dot product}
-     */
-    dot(vector: VectorLike): number;
-    /**
-     * Perform a linear interpolation between this and another vector.
+     * Subtract another vector from this one.
      * @param vector - The other vector.
-     * @param t - The interpolation amount (in `[0,1]`).
-     * @returns The interpolated vector.
-     */
-    lerp(vector: VectorLike, t: number): VectorLike;
-    /**
-     * Set this vector to a random value with the given magnitude.
-     * @param magnitude - The magnitude.
-     * @returns This vector.
+     * @returns The difference between the vectors.
      */
-    random(magnitude: number): this;
+    subtract: (vector: Readonly<Vector4Like>) => VectorLike;
     /**
      * Set this to the zero vector.
      * @returns This vector.
      */
-    zero(): this;
+    zero: () => this;
 }
+/**
+ * An object that could be interpreted as a vector.
+ * @public
+ */
+export type VectorLike = Record<number, number>;
 //# sourceMappingURL=Vector.d.ts.map

package/dist/linalg/Vector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Vector.d.ts","sourceRoot":"","sources":["../../src/linalg/Vector.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEhD;;;;GAIG;AACH,MAAM,CAAC,OAAO,WAAW,MAAO,SAAQ,UAAU;IACjD;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC;IAEpC;;;;OAIG;IACH,WAAW,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC;IAEzC;;;;OAIG;IACH,GAAG,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC;IAEpC;;;OAGG;IACH,KAAK,IAAI,UAAU,CAAC;IAEpB;;;;OAIG;IACH,IAAI,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC;IAEzC;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC;IAEvC;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC;IAEzC;;;OAGG;IACH,IAAI,IAAI,UAAU,CAAC;IAEnB;;;OAGG;IACH,KAAK,IAAI,UAAU,CAAC;IAEpB;;;OAGG;IACH,KAAK,IAAI,UAAU,CAAC;IAEpB;;;;OAIG;IACH,GAAG,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC;IAEpC;;;;OAIG;IACH,GAAG,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC;IAEpC;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU,CAAC;IAElC;;;;OAIG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC;IAElC;;;;;OAKG;IACH,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC;IAE5D;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC;IAErC;;;;OAIG;IACH,eAAe,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC;IAE5C,iDAAiD;IACjD,IAAI,SAAS,IAAI,MAAM,CAAC;IAExB,yDAAyD;IACzD,IAAI,gBAAgB,IAAI,MAAM,CAAC;IAE/B;;;OAGG;IACH,MAAM,IAAI,UAAU,CAAC;IAErB;;;OAGG;IACH,MAAM,IAAI,UAAU,CAAC;IAErB;;;;OAIG;IACH,SAAS,IAAI,UAAU,CAAC;IAExB;;;;;OAKG;IACH,GAAG,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC;IAEhC;;;;;OAKG;IACH,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;IAEhD;;;;OAIG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;OAGG;IACH,IAAI,IAAI,IAAI,CAAC;CACb"}
+{"version":3,"file":"Vector.d.ts","sourceRoot":"","sources":["../../src/linalg/Vector.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAEhD;;;;GAIG;AACH,MAAM,CAAC,OAAO,WAAW,MAAO,SAAQ,UAAU;IACjD;;;;OAIG;IACH,GAAG,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,UAAU,CAAC;IAEnD;;;OAGG;IACH,IAAI,EAAE,MAAM,UAAU,CAAC;IAEvB;;;OAGG;IACH,KAAK,EAAE,MAAM,UAAU,CAAC;IAExB;;;;OAIG;IACH,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;IAE9C;;;;OAIG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,MAAM,CAAC;IAEpD;;;;OAIG;IACH,MAAM,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,UAAU,CAAC;IAEtD;;;;;OAKG;IACH,GAAG,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,MAAM,CAAC;IAE/C;;;;OAIG;IACH,MAAM,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,OAAO,CAAC;IAEnD;;;;OAIG;IACH,WAAW,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,OAAO,CAAC;IAExD;;;OAGG;IACH,KAAK,EAAE,MAAM,UAAU,CAAC;IAExB;;;OAGG;IACH,MAAM,EAAE,MAAM,UAAU,CAAC;IAEzB;;;;;OAKG;IACH,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,MAAM,KAAK,UAAU,CAAC;IAE/D,iDAAiD;IACjD,IAAI,SAAS,IAAI,MAAM,CAAC;IAExB;;;;OAIG;IACH,GAAG,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,UAAU,CAAC;IAEnD;;;;OAIG;IACH,GAAG,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,UAAU,CAAC;IAEnD;;;;OAIG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,UAAU,CAAC;IAExD;;;OAGG;IACH,MAAM,EAAE,MAAM,UAAU,CAAC;IAEzB;;;;OAIG;IACH,SAAS,EAAE,MAAM,UAAU,CAAC;IAE5B;;;;OAIG;IACH,GAAG,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,UAAU,CAAC;IAEtC;;;;OAIG;IACH,MAAM,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;IAEpC;;;OAGG;IACH,KAAK,EAAE,MAAM,UAAU,CAAC;IAExB;;;;OAIG;IACH,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,UAAU,CAAC;IAEtC;;;;;OAKG;IACH,WAAW,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,MAAM,KAAK,UAAU,CAAC;IAE3E;;;;OAIG;IACH,eAAe,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,MAAM,CAAC;IAE3D,yDAAyD;IACzD,IAAI,gBAAgB,IAAI,MAAM,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,KAAK,UAAU,CAAC;IAExD;;;OAGG;IACH,IAAI,EAAE,MAAM,IAAI,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC"}