@math.gl/core 3.6.0-alpha.1 → 3.6.0-alpha.2

package/dist/classes/base/math-array.d.ts

@@ -1,36 +1,66 @@
-export default class MathArray extends Array<any> {
-    constructor(arrayLength?: number);
-    constructor(arrayLength: number);
-    constructor(...items: any[]);
-    get ELEMENTS(): number;
-    clone(): any;
-    from(arrayOrObject: any): any;
-    fromArray(array: any, offset?: number): MathArray;
-    to(arrayOrObject: any): any;
+import { NumericArray } from '@math.gl/types';
+import { ConfigurationOptions } from '../../lib/common';
+/** Base class for vectors and matrices */
+export default abstract class MathArray extends Array<number> {
+    /** Number of elements (values) in this array */
+    abstract get ELEMENTS(): number;
+    abstract copy(vector: Readonly<NumericArray>): this;
+    abstract fromObject(object: object): this;
+    /**
+     * Clone the current object
+     * @returns a new copy of this object
+     */
+    clone(): this;
+    fromArray(array: Readonly<NumericArray>, offset?: number): this;
+    toArray<TypedArray>(targetArray: TypedArray, offset?: number): TypedArray;
+    toArray(targetArray?: number[], offset?: number): NumericArray;
+    from(arrayOrObject: Readonly<NumericArray> | object): this;
+    to<T extends NumericArray | object>(arrayOrObject: T): T;
     toTarget(target: any): any;
-    toArray(array?: any[], offset?: number): any[];
+    /** @deprecated */
     toFloat32Array(): Float32Array;
-    formatString(opts: any): string;
-    equals(array: any): boolean;
-    exactEquals(array: any): boolean;
-    negate(): MathArray;
-    lerp(a: any, b: any, t: any): MathArray;
-    min(vector: any): MathArray;
-    max(vector: any): MathArray;
-    clamp(minVector: any, maxVector: any): MathArray;
-    add(...vectors: any[]): MathArray;
-    subtract(...vectors: any[]): MathArray;
-    scale(scale: any): any;
-    sub(a: any): MathArray;
-    setScalar(a: any): MathArray;
-    addScalar(a: any): MathArray;
-    subScalar(a: any): MathArray;
-    multiplyScalar(scalar: any): MathArray;
-    divideScalar(a: any): any;
-    clampScalar(min: any, max: any): MathArray;
-    multiplyByScalar(scalar: any): any;
-    get elements(): MathArray;
-    check(): MathArray;
+    toString(): string;
+    /** Formats string according to options */
+    formatString(opts: ConfigurationOptions): string;
+    equals(array: Readonly<NumericArray>): boolean;
+    exactEquals(array: Readonly<NumericArray>): boolean;
+    /** Negates all values in this object */
+    negate(): this;
+    /** Linearly interpolates between two values */
+    lerp(a: Readonly<NumericArray>, t: number): this;
+    lerp(a: Readonly<NumericArray>, b: Readonly<NumericArray>, t: number): this;
+    /** Minimal */
+    min(vector: Readonly<NumericArray>): this;
+    /** Maximal */
+    max(vector: Readonly<NumericArray>): this;
+    clamp(minVector: Readonly<NumericArray>, maxVector: Readonly<NumericArray>): this;
+    add(...vectors: Readonly<NumericArray>[]): this;
+    subtract(...vectors: Readonly<NumericArray>[]): this;
+    scale(scale: number | Readonly<NumericArray>): this;
+    /**
+     * Multiplies all elements by `scale`
+     * Note: `Matrix4.multiplyByScalar` only scales its 3x3 "minor"
+     */
+    multiplyByScalar(scalar: number): this;
+    /** Throws an error if array length is incorrect or contains illegal values */
+    check(): this;
+    /** Returns false if the array length is incorrect or contains illegal values */
     validate(): boolean;
+    /** @deprecated */
+    sub(a: Readonly<NumericArray>): this;
+    /** @deprecated */
+    setScalar(a: number): this;
+    /** @deprecated */
+    addScalar(a: number): this;
+    /** @deprecated */
+    subScalar(a: number): this;
+    /** @deprecated */
+    multiplyScalar(scalar: number): this;
+    /** @deprecated */
+    divideScalar(a: number): this;
+    /** @deprecated */
+    clampScalar(min: number, max: number): this;
+    /** @deprecated */
+    get elements(): NumericArray;
 }
 //# sourceMappingURL=math-array.d.ts.map

package/dist/classes/base/math-array.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"math-array.d.ts","sourceRoot":"","sources":["../../../src/classes/base/math-array.js"],"names":[],"mappings":"AAuBA;IAmOgh3D,kCAAuC;IAAA,iCAAwC;IAAA,6BAAkC;IAjO/n3D,uBAGC;IAED,aAGC;IAED,8BAGC;IAED,kDAKC;IAED,4BAMC;IAED,2BAEC;IAED,+CAKC;IAED,+BAEC;IAMD,gCAMC;IAED,4BAUC;IAED,iCAUC;IAID,oBAKC;IAED,wCAWC;IAED,4BAKC;IAED,4BAKC;IAED,iDAKC;IAED,kCAOC;IAED,uCAOC;IAED,uBASC;IAID,uBAEC;IAED,6BAKC;IAED,6BAKC;IAED,6BAEC;IAED,uCAOC;IAED,0BAEC;IAED,2CAKC;IAID,mCAEC;IAGD,0BAEC;IAID,mBAKC;IAED,oBAMC;CACF"}
+{"version":3,"file":"math-array.d.ts","sourceRoot":"","sources":["../../../src/classes/base/math-array.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAC,oBAAoB,EAAuC,MAAM,kBAAkB,CAAC;AAE5F,0CAA0C;AAC1C,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,SAAU,SAAQ,KAAK,CAAC,MAAM,CAAC;IAC3D,gDAAgD;IAChD,QAAQ,KAAK,QAAQ,IAAI,MAAM,CAAC;IAEhC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,IAAI;IAEnD,QAAQ,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIzC;;;OAGG;IACH,KAAK,IAAI,IAAI;IAKb,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAE,MAAU,GAAG,IAAI;IAOlE,OAAO,CAAC,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,UAAU;IACzE,OAAO,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,YAAY;IAS9D,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,MAAM,GAAG,IAAI;IAI1D,EAAE,CAAC,CAAC,SAAS,YAAY,GAAG,MAAM,EAAE,aAAa,EAAE,CAAC,GAAG,CAAC;IASxD,QAAQ,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG;IAI1B,kBAAkB;IAClB,cAAc,IAAI,YAAY;IAI9B,QAAQ,IAAI,MAAM;IAIlB,0CAA0C;IAC1C,YAAY,CAAC,IAAI,EAAE,oBAAoB,GAAG,MAAM;IAQhD,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,OAAO;IAY9C,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,OAAO;IAcnD,wCAAwC;IACxC,MAAM,IAAI,IAAI;IAOd,+CAA+C;IAC/C,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;IAChD,IAAI,CAAC,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;IAa3E,cAAc;IACd,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,IAAI;IAOzC,cAAc;IACd,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,IAAI;IAOzC,KAAK,CAAC,SAAS,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,IAAI;IAOjF,GAAG,CAAC,GAAG,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,IAAI;IAS/C,QAAQ,CAAC,GAAG,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,IAAI;IASpD,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAAC,YAAY,CAAC,GAAG,IAAI;IAanD;;;OAGG;IACH,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAStC,8EAA8E;IAC9E,KAAK,IAAI,IAAI;IAOb,gFAAgF;IAChF,QAAQ,IAAI,OAAO;IAUnB,kBAAkB;IAClB,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,IAAI;IAIpC,kBAAkB;IAClB,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAO1B,kBAAkB;IAClB,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAO1B,kBAAkB;IAClB,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAI1B,kBAAkB;IAClB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IASpC,kBAAkB;IAClB,YAAY,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAI7B,kBAAkB;IAClB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAO3C,kBAAkB;IAClB,IAAI,QAAQ,IAAI,YAAY,CAE3B;CACF"}

package/dist/classes/base/math-array.js

@@ -1,37 +1,14 @@
-// Copyright (c) 2017 Uber Technologies, Inc.
-//
-// Permission is hereby granted, free of charge, to any person obtaining a copy
-// of this software and associated documentation files (the "Software"), to deal
-// in the Software without restriction, including without limitation the rights
-// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-// copies of the Software, and to permit persons to whom the Software is
-// furnished to do so, subject to the following conditions:
-//
-// The above copyright notice and this permission notice shall be included in
-// all copies or substantial portions of the Software.
-//
-// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-// THE SOFTWARE.
 import { config, formatValue, equals, isArray } from '../../lib/common';
-import assert from '../../lib/assert';
+/** Base class for vectors and matrices */
 export default class MathArray extends Array {
-    // Defined by derived class
-    get ELEMENTS() {
-        assert(false);
-        return 0;
-    }
+    // Common methods
+    /**
+     * Clone the current object
+     * @returns a new copy of this object
+     */
     clone() {
-        // @ts-ignore error TS2351: Cannot use 'new' with an expression whose type lacks a call or construct signature.
-        return new this.constructor().copy(this);
-    }
-    from(arrayOrObject) {
-        // @ts-ignore error TS2339: Property 'copy' does not exist on type 'MathArray'.
-        return Array.isArray(arrayOrObject) ? this.copy(arrayOrObject) : this.fromObject(arrayOrObject);
+        // @ts-expect-error TS2351: Cannot use 'new' with an expression whose type lacks a call or construct signature.
+        return new this.constructor().copy(this); // eslint-disable-line
     }
     fromArray(array, offset = 0) {
         for (let i = 0; i < this.ELEMENTS; ++i) {
@@ -39,28 +16,34 @@ export default class MathArray extends Array {
         }
         return this.check();
     }
+    toArray(targetArray = [], offset = 0) {
+        for (let i = 0; i < this.ELEMENTS; ++i) {
+            targetArray[offset + i] = this[i];
+        }
+        return targetArray;
+    }
+    from(arrayOrObject) {
+        return Array.isArray(arrayOrObject) ? this.copy(arrayOrObject) : this.fromObject(arrayOrObject);
+    }
     to(arrayOrObject) {
+        // @ts-ignore
         if (arrayOrObject === this) {
             return this;
         }
-        // @ts-ignore error TS2339: Property 'toObject' does not exist on type 'MathArray'.
+        // @ts-expect-error TS2339: Property 'toObject' does not exist on type 'MathArray'.
         return isArray(arrayOrObject) ? this.toArray(arrayOrObject) : this.toObject(arrayOrObject);
     }
     toTarget(target) {
         return target ? this.to(target) : this;
     }
-    toArray(array = [], offset = 0) {
-        for (let i = 0; i < this.ELEMENTS; ++i) {
-            array[offset + i] = this[i];
-        }
-        return array;
-    }
+    /** @deprecated */
     toFloat32Array() {
         return new Float32Array(this);
     }
     toString() {
         return this.formatString(config);
     }
+    /** Formats string according to options */
     formatString(opts) {
         let string = '';
         for (let i = 0; i < this.ELEMENTS; ++i) {
@@ -91,6 +74,7 @@ export default class MathArray extends Array {
         return true;
     }
     // Modifiers
+    /** Negates all values in this object */
     negate() {
         for (let i = 0; i < this.ELEMENTS; ++i) {
             this[i] = -this[i];
@@ -99,9 +83,7 @@ export default class MathArray extends Array {
     }
     lerp(a, b, t) {
         if (t === undefined) {
-            t = b;
-            b = a;
-            a = this; // eslint-disable-line
+            return this.lerp(this, a, b);
         }
         for (let i = 0; i < this.ELEMENTS; ++i) {
             const ai = a[i];
@@ -109,12 +91,14 @@ export default class MathArray extends Array {
         }
         return this.check();
     }
+    /** Minimal */
     min(vector) {
         for (let i = 0; i < this.ELEMENTS; ++i) {
             this[i] = Math.min(vector[i], this[i]);
         }
         return this.check();
     }
+    /** Maximal */
     max(vector) {
         for (let i = 0; i < this.ELEMENTS; ++i) {
             this[i] = Math.max(vector[i], this[i]);
@@ -144,34 +128,68 @@ export default class MathArray extends Array {
         return this.check();
     }
     scale(scale) {
-        if (Array.isArray(scale)) {
-            // @ts-ignore error TS2339: Property 'multiply' does not exist on type 'MathArray'.
-            return this.multiply(scale);
+        if (typeof scale === 'number') {
+            for (let i = 0; i < this.ELEMENTS; ++i) {
+                this[i] *= scale;
+            }
+        }
+        else {
+            for (let i = 0; i < this.ELEMENTS && i < scale.length; ++i) {
+                this[i] *= scale[i];
+            }
         }
+        return this.check();
+    }
+    /**
+     * Multiplies all elements by `scale`
+     * Note: `Matrix4.multiplyByScalar` only scales its 3x3 "minor"
+     */
+    multiplyByScalar(scalar) {
         for (let i = 0; i < this.ELEMENTS; ++i) {
-            this[i] *= scale;
+            this[i] *= scalar;
         }
         return this.check();
     }
+    // Debug checks
+    /** Throws an error if array length is incorrect or contains illegal values */
+    check() {
+        if (config.debug && !this.validate()) {
+            throw new Error(`math.gl: ${this.constructor.name} some fields set to invalid numbers'`);
+        }
+        return this;
+    }
+    /** Returns false if the array length is incorrect or contains illegal values */
+    validate() {
+        let valid = this.length === this.ELEMENTS;
+        for (let i = 0; i < this.ELEMENTS; ++i) {
+            valid = valid && Number.isFinite(this[i]);
+        }
+        return valid;
+    }
     // three.js compatibility
+    /** @deprecated */
     sub(a) {
         return this.subtract(a);
     }
+    /** @deprecated */
     setScalar(a) {
         for (let i = 0; i < this.ELEMENTS; ++i) {
             this[i] = a;
         }
         return this.check();
     }
+    /** @deprecated */
     addScalar(a) {
         for (let i = 0; i < this.ELEMENTS; ++i) {
             this[i] += a;
         }
         return this.check();
     }
+    /** @deprecated */
     subScalar(a) {
         return this.addScalar(-a);
     }
+    /** @deprecated */
     multiplyScalar(scalar) {
         // Multiplies all elements
         // `Matrix4.scale` only scales its 3x3 "minor"
@@ -180,35 +198,19 @@ export default class MathArray extends Array {
         }
         return this.check();
     }
+    /** @deprecated */
     divideScalar(a) {
-        return this.scale(1 / a);
+        return this.multiplyByScalar(1 / a);
     }
+    /** @deprecated */
     clampScalar(min, max) {
         for (let i = 0; i < this.ELEMENTS; ++i) {
             this[i] = Math.min(Math.max(this[i], min), max);
         }
         return this.check();
     }
-    // Cesium compatibility
-    multiplyByScalar(scalar) {
-        return this.scale(scalar);
-    }
-    // THREE.js compatibility
+    /** @deprecated */
     get elements() {
         return this;
     }
-    // Debug checks
-    check() {
-        if (config.debug && !this.validate()) {
-            throw new Error(`math.gl: ${this.constructor.name} some fields set to invalid numbers'`);
-        }
-        return this;
-    }
-    validate() {
-        let valid = this.length === this.ELEMENTS;
-        for (let i = 0; i < this.ELEMENTS; ++i) {
-            valid = valid && Number.isFinite(this[i]);
-        }
-        return valid;
-    }
 }

package/dist/classes/base/matrix.d.ts

@@ -1,12 +1,14 @@
-export default class Matrix extends MathArray<any> {
-    constructor(arrayLength: number);
-    constructor(...items: number[]);
-    get RANK(): number;
-    getElementIndex(row: any, col: any): any;
-    getElement(row: any, col: any): number;
-    setElement(row: any, col: any, value: any): Matrix;
-    getColumn(columnIndex: any, result?: any[]): any[];
-    setColumn(columnIndex: any, columnVector: any): Matrix;
+import { NumericArray } from '@math.gl/types';
+import MathArray from './math-array';
+/** Base class for matrices */
+export default abstract class Matrix extends MathArray {
+    abstract get RANK(): number;
+    toString(): string;
+    getElementIndex(row: number, col: number): number;
+    getElement(row: number, col: number): number;
+    setElement(row: number, col: number, value: number): this;
+    getColumn<NumArrayT>(columnIndex: number, result: NumArrayT): NumArrayT;
+    getColumn(columnIndex: number): number[];
+    setColumn(columnIndex: number, columnVector: Readonly<NumericArray>): this;
 }
-import MathArray from "./math-array";
 //# sourceMappingURL=matrix.d.ts.map

package/dist/classes/base/matrix.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"matrix.d.ts","sourceRoot":"","sources":["../../../src/classes/base/matrix.js"],"names":[],"mappings":"AAKA;IAyE8u/D,iCAAwC;IAAA,gCAAkC;IAlEtz/D,mBAGC;IAgCD,yCAEC;IAGD,uCAEC;IAGD,mDAGC;IAED,mDAMC;IAED,uDAMC;CACF"}
+{"version":3,"file":"matrix.d.ts","sourceRoot":"","sources":["../../../src/classes/base/matrix.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAC5C,OAAO,SAAS,MAAM,cAAc,CAAC;AAIrC,8BAA8B;AAC9B,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,MAAO,SAAQ,SAAS;IACpD,QAAQ,KAAK,IAAI,IAAI,MAAM,CAAC;IAa5B,QAAQ,IAAI,MAAM;IAmBlB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM;IAKjD,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM;IAK5C,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAIzD,SAAS,CAAC,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAG,SAAS;IACvE,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE;IAUxC,SAAS,CAAC,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,IAAI;CAO3E"}

package/dist/classes/base/matrix.js

@@ -1,17 +1,8 @@
 import MathArray from './math-array';
 import { checkNumber } from '../../lib/validators';
 import { config } from '../../lib/common';
-import assert from '../../lib/assert';
+/** Base class for matrices */
 export default class Matrix extends MathArray {
-    // Defined by derived class
-    get ELEMENTS() {
-        assert(false);
-        return 0;
-    }
-    get RANK() {
-        assert(false);
-        return 0;
-    }
     // fromObject(object) {
     //   const array = object.elements;
     //   return this.fromRowMajor(array);
@@ -21,6 +12,7 @@ export default class Matrix extends MathArray {
     //   this.toRowMajor(array);
     //   return object;
     // }
+    // TODO better override formatString?
     toString() {
         let string = '[';
         if (config.printRowMajor) {

package/dist/classes/base/vector.d.ts

@@ -1,32 +1,44 @@
-export default class Vector extends MathArray<any> {
-    constructor(arrayLength: number);
-    constructor(...items: number[]);
-    copy(vector: any): Vector;
-    set x(arg: any);
-    get x(): any;
-    0: any;
-    set y(arg: any);
-    get y(): any;
-    1: any;
+import { NumericArray } from '@math.gl/types';
+import MathArray from './math-array';
+/** Base class for vectors with at least 2 elements */
+export default abstract class Vector extends MathArray {
+    get x(): number;
+    set x(value: number);
+    get y(): number;
+    set y(value: number);
+    /**
+     * Returns the length of the vector from the origin to the point described by this vector
+     *
+     * @note `length` is a reserved word for Arrays, so `v.length()` will return number of elements
+     * Instead we provide `len` and `magnitude`
+     */
     len(): number;
+    /**
+     * Returns the length of the vector from the origin to the point described by this vector
+     */
     magnitude(): number;
+    /**
+     * Returns the squared length of the vector from the origin to the point described by this vector
+     */
     lengthSquared(): number;
+    /**
+     * Returns the squared length of the vector from the origin to the point described by this vector
+     */
     magnitudeSquared(): number;
-    distance(mathArray: any): number;
-    distanceSquared(mathArray: any): any;
-    dot(mathArray: any): any;
-    normalize(): any;
-    multiply(...vectors: any[]): any;
-    divide(...vectors: any[]): any;
+    distance(mathArray: Readonly<NumericArray>): number;
+    distanceSquared(mathArray: Readonly<NumericArray>): number;
+    dot(mathArray: Readonly<NumericArray>): number;
+    normalize(): this;
+    multiply(...vectors: Readonly<NumericArray>[]): this;
+    divide(...vectors: Readonly<NumericArray>[]): this;
     lengthSq(): number;
-    distanceTo(vector: any): number;
-    distanceToSquared(vector: any): any;
-    getComponent(i: any): any;
-    setComponent(i: any, value: any): any;
-    addVectors(a: any, b: any): any;
-    subVectors(a: any, b: any): any;
-    multiplyVectors(a: any, b: any): any;
-    addScaledVector(a: any, b: any): any;
+    distanceTo(vector: Readonly<NumericArray>): number;
+    distanceToSquared(vector: Readonly<NumericArray>): number;
+    getComponent(i: number): number;
+    setComponent(i: number, value: number): this;
+    addVectors(a: Readonly<NumericArray>, b: Readonly<NumericArray>): this;
+    subVectors(a: Readonly<NumericArray>, b: Readonly<NumericArray>): this;
+    multiplyVectors(a: Readonly<NumericArray>, b: Readonly<NumericArray>): this;
+    addScaledVector(a: Readonly<NumericArray>, b: number): this;
 }
-import MathArray from "./math-array";
 //# sourceMappingURL=vector.d.ts.map

package/dist/classes/base/vector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../../src/classes/base/vector.js"],"names":[],"mappings":"AAIA;IA4Jm78D,iCAAwC;IAAA,gCAAkC;IArJ3/8D,0BAGC;IAOD,gBAEC;IALD,aAEC;IAEC,OAA4B;IAM9B,gBAEC;IALD,aAEC;IAEC,OAA4B;IAK9B,cAEC;IAED,oBAEC;IAED,wBAMC;IAED,2BAEC;IAED,iCAEC;IAED,qCAOC;IAED,yBAMC;IAID,iBAQC;IAgBD,iCAOC;IAED,+BAOC;IAGD,mBAEC;IAED,gCAEC;IAED,oCAEC;IAED,0BAGC;IAED,sCAIC;IAED,gCAEC;IAED,gCAEC;IAED,qCAEC;IAED,qCAGC;CACF"}
+{"version":3,"file":"vector.d.ts","sourceRoot":"","sources":["../../../src/classes/base/vector.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAC5C,OAAO,SAAS,MAAM,cAAc,CAAC;AAIrC,sDAAsD;AACtD,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,MAAO,SAAQ,SAAS;IAGpD,IAAI,CAAC,IAAI,MAAM,CAEd;IAED,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAElB;IAED,IAAI,CAAC,IAAI,MAAM,CAEd;IAED,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAElB;IAED;;;;;OAKG;IACH,GAAG,IAAI,MAAM;IAIb;;OAEG;IACH,SAAS,IAAI,MAAM;IAInB;;OAEG;IACH,aAAa,IAAI,MAAM;IAQvB;;OAEG;IACH,gBAAgB,IAAI,MAAM;IAI1B,QAAQ,CAAC,SAAS,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,MAAM;IAInD,eAAe,CAAC,SAAS,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,MAAM;IAS1D,GAAG,CAAC,SAAS,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,MAAM;IAU9C,SAAS,IAAI,IAAI;IAUjB,QAAQ,CAAC,GAAG,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,IAAI;IASpD,MAAM,CAAC,GAAG,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,IAAI;IAWlD,QAAQ,IAAI,MAAM;IAGlB,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,MAAM;IAGlD,iBAAiB,CAAC,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,MAAM;IAIzD,YAAY,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM;IAK/B,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAM5C,UAAU,CAAC,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,IAAI;IAItE,UAAU,CAAC,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,IAAI;IAItE,eAAe,CAAC,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,IAAI;IAI3E,eAAe,CAAC,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,IAAI;CAI5D"}

package/dist/classes/base/vector.js

@@ -1,16 +1,8 @@
 import MathArray from './math-array';
 import { checkNumber } from '../../lib/validators';
 import assert from '../../lib/assert';
+/** Base class for vectors with at least 2 elements */
 export default class Vector extends MathArray {
-    get ELEMENTS() {
-        assert(false);
-        return 0;
-    }
-    // VIRTUAL METHODS
-    copy(vector) {
-        assert(false);
-        return this;
-    }
     // ACCESSORS
     get x() {
         return this[0];
@@ -24,14 +16,24 @@ export default class Vector extends MathArray {
     set y(value) {
         this[1] = checkNumber(value);
     }
-    // NOTE: `length` is a reserved word for Arrays, so we can't use `v.length()`
-    // Offer `len` and `magnitude`
+    /**
+     * Returns the length of the vector from the origin to the point described by this vector
+     *
+     * @note `length` is a reserved word for Arrays, so `v.length()` will return number of elements
+     * Instead we provide `len` and `magnitude`
+     */
     len() {
         return Math.sqrt(this.lengthSquared());
     }
+    /**
+     * Returns the length of the vector from the origin to the point described by this vector
+     */
     magnitude() {
         return this.len();
     }
+    /**
+     * Returns the squared length of the vector from the origin to the point described by this vector
+     */
     lengthSquared() {
         let length = 0;
         for (let i = 0; i < this.ELEMENTS; ++i) {
@@ -39,6 +41,9 @@ export default class Vector extends MathArray {
         }
         return length;
     }
+    /**
+     * Returns the squared length of the vector from the origin to the point described by this vector
+     */
     magnitudeSquared() {
         return this.lengthSquared();
     }
@@ -70,18 +75,6 @@ export default class Vector extends MathArray {
         }
         return this.check();
     }
-    // negate() {
-    //   for (let i = 0; i < this.ELEMENTS; ++i) {
-    //     this[i] = -this[i];
-    //   }
-    //   return this.check();
-    // }
-    // inverse() {
-    //   for (let i = 0; i < this.ELEMENTS; ++i) {
-    //     this[i] = 1 / this[i];
-    //   }
-    //   return this.check();
-    // }
     multiply(...vectors) {
         for (const vector of vectors) {
             for (let i = 0; i < this.ELEMENTS; ++i) {
@@ -127,7 +120,7 @@ export default class Vector extends MathArray {
         return this.copy(a).multiply(b);
     }
     addScaledVector(a, b) {
-        // @ts-ignore error TS2351: Cannot use 'new' with an expression whose type lacks a call or construct signature.
+        // @ts-expect-error error TS2351: Cannot use 'new' with an expression whose type lacks a call or construct signature.
         return this.add(new this.constructor(a).multiplyScalar(b));
     }
 }