heap-typed 1.49.4 → 1.49.5

package/src/types/data-structures/base/base.ts

@@ -1,6 +1,17 @@
-import { IterableElementBase, IterableEntryBase } from "../../../data-structures";
+import { IterableElementBase, IterableEntryBase } from '../../../data-structures';
 
 export type EntryCallback<K, V, R> = (value: V, key: K, index: number, container: IterableEntryBase<K, V>) => R;
 export type ElementCallback<V, R> = (element: V, index: number, container: IterableElementBase<V>) => R;
-export type ReduceEntryCallback<K, V, R> = (accumulator: R, value: V, key: K, index: number, container: IterableEntryBase<K, V>) => R;
-export type ReduceElementCallback<V, R> = (accumulator: R, element: V, index: number, container: IterableElementBase<V>) => R;
+export type ReduceEntryCallback<K, V, R> = (
+  accumulator: R,
+  value: V,
+  key: K,
+  index: number,
+  container: IterableEntryBase<K, V>
+) => R;
+export type ReduceElementCallback<V, R> = (
+  accumulator: R,
+  element: V,
+  index: number,
+  container: IterableElementBase<V>
+) => R;

package/src/types/data-structures/base/index.ts

@@ -1 +1 @@
-export * from './base';
+export * from './base';

package/src/types/data-structures/graph/abstract-graph.ts

@@ -1,6 +1,7 @@
 export type VertexKey = string | number;
 
-export type DijkstraResult<V> = {
+export type DijkstraResult<V> =
+  | {
   distMap: Map<V, number>;
   distPaths?: Map<V, V[]>;
   preMap: Map<V, V | undefined>;
@@ -8,4 +9,5 @@ export type DijkstraResult<V> = {
   paths: V[][];
   minDist: number;
   minPath: V[];
-} | undefined;
+}
+  | undefined;

package/src/types/data-structures/hash/hash-map.ts

@@ -7,7 +7,7 @@ export type HashMapLinkedNode<K, V> = {
 
 export type HashMapOptions<K> = {
   hashFn: (key: K) => string;
-  objHashFn: (key: K) => object
-}
+  objHashFn: (key: K) => object;
+};
 
-export type HashMapStoreItem<K, V> = { key: K, value: V };
+export type HashMapStoreItem<K, V> = { key: K; value: V };

package/src/types/data-structures/heap/heap.ts

@@ -1,3 +1,3 @@
-import { Comparator } from "../../common";
+import { Comparator } from '../../common';
 
-export type HeapOptions<T> = { comparator: Comparator<T> }
+export type HeapOptions<T> = { comparator: Comparator<T> };

package/src/types/data-structures/priority-queue/priority-queue.ts

@@ -1,3 +1,3 @@
-import { HeapOptions } from "../heap";
+import { HeapOptions } from '../heap';
 
-export type PriorityQueueOptions<T> = HeapOptions<T> & {}
+export type PriorityQueueOptions<T> = HeapOptions<T> & {};

package/src/utils/utils.ts

@@ -98,4 +98,10 @@ export const isWeakKey = (input: unknown): input is object => {
   return (inputType === 'object' && input !== null) || inputType === 'function';
 };
 
-export const calcMinUnitsRequired = (totalQuantity: number, unitSize: number) => Math.floor((totalQuantity + unitSize - 1) / unitSize)
+export const calcMinUnitsRequired = (totalQuantity: number, unitSize: number) =>
+  Math.floor((totalQuantity + unitSize - 1) / unitSize);
+
+export const roundFixed = (num: number, digit: number = 10) => {
+  const multiplier = Math.pow(10, digit);
+  return Math.round(num * multiplier) / multiplier;
+};

package/dist/data-structures/matrix/matrix2d.d.ts

@@ -1,107 +0,0 @@
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-import { Vector2D } from './vector2d';
-export declare class Matrix2D {
-    protected readonly _matrix: number[][];
-    /**
-     * The constructor function initializes a Matrix2D object with either a default identity matrix, or a provided matrix
-     * or Vector2D object.
-     * @param {number[][] | Vector2D} [value] - The `value` parameter can be either a 2D array of numbers (`number[][]`) or
-     * an instance of the `Vector2D` class.
-     */
-    constructor(value?: number[][] | Vector2D);
-    /**
-     * The function returns a 2D array with three empty arrays.
-     * @returns An empty 2-dimensional array with 3 empty arrays inside.
-     */
-    static get empty(): number[][];
-    /**
-     * The above function returns a 3x3 identity matrix.
-     * @returns The method is returning a 2-dimensional array of numbers representing the identity matrix.
-     */
-    static get identity(): number[][];
-    /**
-     * The function returns a two-dimensional array of numbers.
-     * @returns The getter method is returning the value of the private variable `_matrix`, which is a two-dimensional
-     * array of numbers.
-     */
-    get m(): number[][];
-    /**
-     * The function takes two 2D matrices as input and returns their sum as a new 2D matrix.
-     * @param {Matrix2D} matrix1 - Matrix2D - The first matrix to be added.
-     * @param {Matrix2D} matrix2 - The parameter `matrix2` is a Matrix2D object.
-     * @returns a new instance of the Matrix2D class, which is created using the result array.
-     */
-    static add(matrix1: Matrix2D, matrix2: Matrix2D): Matrix2D;
-    /**
-     * The function subtracts two 2D matrices and returns the result as a new Matrix2D object.
-     * @param {Matrix2D} matrix1 - Matrix2D - The first matrix to subtract from.
-     * @param {Matrix2D} matrix2 - Matrix2D is a class representing a 2D matrix. It has a property `m` which is a 2D array
-     * representing the matrix elements.
-     * @returns a new instance of the Matrix2D class, which is created using the result array.
-     */
-    static subtract(matrix1: Matrix2D, matrix2: Matrix2D): Matrix2D;
-    /**
-     * The function multiplies two 2D matrices and returns the result as a new Matrix2D object.
-     * @param {Matrix2D} matrix1 - A 2D matrix represented by the Matrix2D class.
-     * @param {Matrix2D} matrix2 - The parameter `matrix2` is a 2D matrix of size 3x3.
-     * @returns a new instance of the Matrix2D class, created using the result array.
-     */
-    static multiply(matrix1: Matrix2D, matrix2: Matrix2D): Matrix2D;
-    /**
-     * The function multiplies each element of a 2D matrix by a given value and returns the resulting matrix.
-     * @param {Matrix2D} matrix - The `matrix` parameter is an instance of the `Matrix2D` class, which represents a 2D
-     * matrix. It contains a property `m` that is a 2D array representing the matrix elements.
-     * @param {number} value - The `value` parameter is a number that you want to multiply each element of the `matrix` by.
-     * @returns a new instance of the Matrix2D class, which is created using the result array.
-     */
-    static multiplyByValue(matrix: Matrix2D, value: number): Matrix2D;
-    /**
-     * The function multiplies a 2D matrix by a 2D vector and returns the result as a 2D vector.
-     * @param {Matrix2D} matrix - The parameter "matrix" is of type Matrix2D. It represents a 2-dimensional matrix.
-     * @param {Vector2D} vector - The "vector" parameter is a 2D vector, represented by an object of type Vector2D.
-     * @returns a Vector2D.
-     */
-    static multiplyByVector(matrix: Matrix2D, vector: Vector2D): Vector2D;
-    /**
-     * The function returns a 2D matrix that scales and flips a vector around the center of a given width and height.
-     * @param {number} width - The width parameter represents the width of the view or the canvas. It is a number that
-     * specifies the width in pixels or any other unit of measurement.
-     * @param {number} height - The height parameter represents the height of the view or the canvas. It is used to
-     * calculate the centerY value, which is the vertical center of the view.
-     * @returns a Matrix2D object.
-     */
-    static view(width: number, height: number): Matrix2D;
-    /**
-     * The function scales a matrix by a given factor.
-     * @param {number} factor - The factor parameter is a number that represents the scaling factor by which the matrix
-     * should be scaled.
-     * @returns the result of multiplying a new instance of Matrix2D by the given factor.
-     */
-    static scale(factor: number): Matrix2D;
-    /**
-     * The function "rotate" takes an angle in radians and returns a 2D transformation matrix for rotating objects.
-     * @param {number} radians - The "radians" parameter is the angle in radians by which you want to rotate an object.
-     * @returns The code is returning a new instance of a Matrix2D object.
-     */
-    static rotate(radians: number): Matrix2D;
-    /**
-     * The translate function takes a 2D vector and returns a 2D matrix that represents a translation transformation.
-     * @param {Vector2D} vector - The parameter "vector" is of type Vector2D. It represents a 2D vector with components x
-     * and y, and an optional w component.
-     * @returns The method is returning a new instance of the Matrix2D class.
-     */
-    static translate(vector: Vector2D): Matrix2D;
-    /**
-     * The function "toVector" returns a new Vector2D object with the values from the first and second elements of the
-     * _matrix array.
-     * @returns A new instance of the Vector2D class is being returned. The values of the returned vector are taken from
-     * the first column of the matrix.
-     */
-    toVector(): Vector2D;
-}

package/dist/data-structures/matrix/matrix2d.js

@@ -1,199 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Matrix2D = void 0;
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-const vector2d_1 = require("./vector2d");
-class Matrix2D {
-    /**
-     * The constructor function initializes a Matrix2D object with either a default identity matrix, or a provided matrix
-     * or Vector2D object.
-     * @param {number[][] | Vector2D} [value] - The `value` parameter can be either a 2D array of numbers (`number[][]`) or
-     * an instance of the `Vector2D` class.
-     */
-    constructor(value) {
-        if (typeof value === 'undefined') {
-            this._matrix = Matrix2D.identity;
-        }
-        else if (value instanceof vector2d_1.Vector2D) {
-            this._matrix = Matrix2D.identity;
-            this._matrix[0][0] = value.x;
-            this._matrix[1][0] = value.y;
-            this._matrix[2][0] = value.w;
-        }
-        else {
-            this._matrix = value;
-        }
-    }
-    /**
-     * The function returns a 2D array with three empty arrays.
-     * @returns An empty 2-dimensional array with 3 empty arrays inside.
-     */
-    static get empty() {
-        return [[], [], []];
-    }
-    /**
-     * The above function returns a 3x3 identity matrix.
-     * @returns The method is returning a 2-dimensional array of numbers representing the identity matrix.
-     */
-    static get identity() {
-        return [
-            [1, 0, 0],
-            [0, 1, 0],
-            [0, 0, 1]
-        ];
-    }
-    /**
-     * The function returns a two-dimensional array of numbers.
-     * @returns The getter method is returning the value of the private variable `_matrix`, which is a two-dimensional
-     * array of numbers.
-     */
-    get m() {
-        return this._matrix;
-    }
-    /**
-     * The function takes two 2D matrices as input and returns their sum as a new 2D matrix.
-     * @param {Matrix2D} matrix1 - Matrix2D - The first matrix to be added.
-     * @param {Matrix2D} matrix2 - The parameter `matrix2` is a Matrix2D object.
-     * @returns a new instance of the Matrix2D class, which is created using the result array.
-     */
-    static add(matrix1, matrix2) {
-        const result = Matrix2D.empty;
-        for (let i = 0; i < 3; i++) {
-            for (let j = 0; j < 3; j++) {
-                result[i][j] = matrix1.m[i][j] + matrix2.m[i][j];
-            }
-        }
-        return new Matrix2D(result);
-    }
-    /**
-     * The function subtracts two 2D matrices and returns the result as a new Matrix2D object.
-     * @param {Matrix2D} matrix1 - Matrix2D - The first matrix to subtract from.
-     * @param {Matrix2D} matrix2 - Matrix2D is a class representing a 2D matrix. It has a property `m` which is a 2D array
-     * representing the matrix elements.
-     * @returns a new instance of the Matrix2D class, which is created using the result array.
-     */
-    static subtract(matrix1, matrix2) {
-        const result = Matrix2D.empty;
-        for (let i = 0; i < 3; i++) {
-            for (let j = 0; j < 3; j++) {
-                result[i][j] = matrix1.m[i][j] - matrix2.m[i][j];
-            }
-        }
-        return new Matrix2D(result);
-    }
-    /**
-     * The function multiplies two 2D matrices and returns the result as a new Matrix2D object.
-     * @param {Matrix2D} matrix1 - A 2D matrix represented by the Matrix2D class.
-     * @param {Matrix2D} matrix2 - The parameter `matrix2` is a 2D matrix of size 3x3.
-     * @returns a new instance of the Matrix2D class, created using the result array.
-     */
-    static multiply(matrix1, matrix2) {
-        const result = Matrix2D.empty;
-        for (let i = 0; i < 3; i++) {
-            for (let j = 0; j < 3; j++) {
-                result[i][j] = 0;
-                for (let k = 0; k < 3; k++) {
-                    result[i][j] += matrix1.m[i][k] * matrix2.m[k][j];
-                }
-            }
-        }
-        return new Matrix2D(result);
-    }
-    /**
-     * The function multiplies each element of a 2D matrix by a given value and returns the resulting matrix.
-     * @param {Matrix2D} matrix - The `matrix` parameter is an instance of the `Matrix2D` class, which represents a 2D
-     * matrix. It contains a property `m` that is a 2D array representing the matrix elements.
-     * @param {number} value - The `value` parameter is a number that you want to multiply each element of the `matrix` by.
-     * @returns a new instance of the Matrix2D class, which is created using the result array.
-     */
-    static multiplyByValue(matrix, value) {
-        const result = Matrix2D.empty;
-        for (let i = 0; i < 3; i++) {
-            for (let j = 0; j < 3; j++) {
-                result[i][j] = matrix.m[i][j] * value;
-            }
-        }
-        return new Matrix2D(result);
-    }
-    /**
-     * The function multiplies a 2D matrix by a 2D vector and returns the result as a 2D vector.
-     * @param {Matrix2D} matrix - The parameter "matrix" is of type Matrix2D. It represents a 2-dimensional matrix.
-     * @param {Vector2D} vector - The "vector" parameter is a 2D vector, represented by an object of type Vector2D.
-     * @returns a Vector2D.
-     */
-    static multiplyByVector(matrix, vector) {
-        const resultMatrix = Matrix2D.multiply(matrix, new Matrix2D(vector));
-        return resultMatrix.toVector();
-    }
-    /**
-     * The function returns a 2D matrix that scales and flips a vector around the center of a given width and height.
-     * @param {number} width - The width parameter represents the width of the view or the canvas. It is a number that
-     * specifies the width in pixels or any other unit of measurement.
-     * @param {number} height - The height parameter represents the height of the view or the canvas. It is used to
-     * calculate the centerY value, which is the vertical center of the view.
-     * @returns a Matrix2D object.
-     */
-    static view(width, height) {
-        const scaleStep = 1; // Scale every vector * scaleStep
-        const centerX = width / 2;
-        const centerY = height / 2;
-        const flipX = Math.cos(Math.PI); // rotate 180deg / 3.14radian around X-axis
-        return new Matrix2D([
-            [scaleStep, 0, centerX],
-            [0, flipX * scaleStep, centerY],
-            [0, 0, 1]
-        ]);
-    }
-    /**
-     * The function scales a matrix by a given factor.
-     * @param {number} factor - The factor parameter is a number that represents the scaling factor by which the matrix
-     * should be scaled.
-     * @returns the result of multiplying a new instance of Matrix2D by the given factor.
-     */
-    static scale(factor) {
-        return Matrix2D.multiplyByValue(new Matrix2D(), factor);
-    }
-    /**
-     * The function "rotate" takes an angle in radians and returns a 2D transformation matrix for rotating objects.
-     * @param {number} radians - The "radians" parameter is the angle in radians by which you want to rotate an object.
-     * @returns The code is returning a new instance of a Matrix2D object.
-     */
-    static rotate(radians) {
-        const cos = Math.cos(radians);
-        const sin = Math.sin(radians);
-        return new Matrix2D([
-            [cos, -sin, 0],
-            [sin, cos, 0],
-            [0, 0, 1]
-        ]);
-    }
-    /**
-     * The translate function takes a 2D vector and returns a 2D matrix that represents a translation transformation.
-     * @param {Vector2D} vector - The parameter "vector" is of type Vector2D. It represents a 2D vector with components x
-     * and y, and an optional w component.
-     * @returns The method is returning a new instance of the Matrix2D class.
-     */
-    static translate(vector) {
-        return new Matrix2D([
-            [1, 0, vector.x],
-            [0, 1, vector.y],
-            [0, 0, vector.w]
-        ]);
-    }
-    /**
-     * The function "toVector" returns a new Vector2D object with the values from the first and second elements of the
-     * _matrix array.
-     * @returns A new instance of the Vector2D class is being returned. The values of the returned vector are taken from
-     * the first column of the matrix.
-     */
-    toVector() {
-        return new vector2d_1.Vector2D(this._matrix[0][0], this._matrix[1][0]);
-    }
-}
-exports.Matrix2D = Matrix2D;

package/dist/data-structures/matrix/vector2d.d.ts

@@ -1,200 +0,0 @@
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-export declare class Vector2D {
-    x: number;
-    y: number;
-    w: number;
-    constructor(x?: number, y?: number, w?: number);
-    /**
-     * The function checks if the x and y values of a point are both zero.
-     * @returns A boolean value indicating whether both the x and y properties of the object are equal to 0.
-     */
-    get isZero(): boolean;
-    /**
-     * The above function calculates the length of a vector using the Pythagorean theorem.
-     * @returns The length of a vector, calculated using the Pythagorean theorem.
-     */
-    get length(): number;
-    /**
-     * The function calculates the square of the length of a vector.
-     * @returns The method is returning the sum of the squares of the x and y values.
-     */
-    get lengthSq(): number;
-    /**
-     * The "rounded" function returns a new Vector2D object with the x and y values rounded to the nearest whole number.
-     * @returns The method is returning a new instance of the Vector2D class with the x and y values rounded to the nearest
-     * whole number.
-     */
-    get rounded(): Vector2D;
-    /**
-     * The function "add" takes two Vector2D objects as parameters and returns a new Vector2D object with the sum of their
-     * x and y components.
-     * @param {Vector2D} vector1 - The parameter `vector1` is an instance of the `Vector2D` class. It represents a
-     * 2-dimensional vector with an `x` and `y` component.
-     * @param {Vector2D} vector2 - The parameter "vector2" is of type Vector2D. It represents a 2-dimensional vector with
-     * an x and y component.
-     * @returns The method is returning a new instance of the Vector2D class with the x and y components of the two input
-     * vectors added together.
-     */
-    static add(vector1: Vector2D, vector2: Vector2D): Vector2D;
-    /**
-     * The subtract function takes two Vector2D objects as parameters and returns a new Vector2D object with the x and y
-     * components subtracted.
-     * @param {Vector2D} vector1 - The parameter `vector1` is an instance of the `Vector2D` class, representing a
-     * 2-dimensional vector. It has properties `x` and `y` which represent the x and y components of the vector
-     * respectively.
-     * @param {Vector2D} vector2 - The parameter "vector2" is a Vector2D object. It represents the second vector that you
-     * want to subtract from the first vector.
-     * @returns The method is returning a new Vector2D object with the x and y components subtracted from vector1 and
-     * vector2.
-     */
-    static subtract(vector1: Vector2D, vector2: Vector2D): Vector2D;
-    /**
-     * The function subtracts a given value from the x and y components of a Vector2D object and returns a new Vector2D
-     * object.
-     * @param {Vector2D} vector - The parameter "vector" is of type Vector2D, which represents a 2-dimensional vector with
-     * x and y components.
-     * @param {number} value - The "value" parameter is a number that will be subtracted from both the x and y components
-     * of the "vector" parameter.
-     * @returns A new Vector2D object with the x and y values subtracted by the given value.
-     */
-    static subtractValue(vector: Vector2D, value: number): Vector2D;
-    /**
-     * The function multiplies a Vector2D object by a given value.
-     * @param {Vector2D} vector - The parameter "vector" is of type Vector2D, which represents a 2-dimensional vector with
-     * x and y components.
-     * @param {number} value - The "value" parameter is a number that represents the value by which the x and y components
-     * of the vector will be multiplied.
-     * @returns A new Vector2D object with the x and y values multiplied by the given value.
-     */
-    static multiply(vector: Vector2D, value: number): Vector2D;
-    /**
-     * The function divides the x and y components of a Vector2D by a given value and returns a new Vector2D.
-     * @param {Vector2D} vector - The parameter "vector" is of type Vector2D, which represents a 2-dimensional vector with
-     * x and y components.
-     * @param {number} value - The value parameter is a number that will be used to divide the x and y components of the
-     * vector.
-     * @returns A new instance of the Vector2D class with the x and y values divided by the given value.
-     */
-    static divide(vector: Vector2D, value: number): Vector2D;
-    /**
-     * The function checks if two Vector2D objects are equal by comparing their x and y values.
-     * @param {Vector2D} vector1 - The parameter `vector1` is of type `Vector2D`, which represents a 2-dimensional vector.
-     * It has two properties: `x` and `y`, which represent the x and y components of the vector, respectively.
-     * @param {Vector2D} vector2 - The parameter "vector2" is of type Vector2D.
-     * @returns a boolean value, which indicates whether the two input vectors are equal or not.
-     */
-    static equals(vector1: Vector2D, vector2: Vector2D): boolean;
-    /**
-     * The function checks if two Vector2D objects are equal within a specified rounding factor.
-     * @param {Vector2D} vector1 - The first vector to compare.
-     * @param {Vector2D} vector2 - The parameter "vector2" is a Vector2D object, which represents a 2-dimensional vector.
-     * It is used as one of the inputs for the "equalsRounded" function.
-     * @param [roundingFactor=12] - The roundingFactor parameter is used to determine the threshold for considering two
-     * vectors as equal. If the absolute difference in the x and y components of the vectors is less than the
-     * roundingFactor, the vectors are considered equal.
-     * @returns a boolean value.
-     */
-    static equalsRounded(vector1: Vector2D, vector2: Vector2D, roundingFactor?: number): boolean;
-    /**
-     * The normalize function takes a vector as input and returns a normalized version of the vector.Normalizes the vector if it matches a certain condition
-     * @param {Vector2D} vector - The parameter "vector" is of type Vector2D.
-     * @returns the normalized vector if its length is greater than a very small value (epsilon), otherwise it returns the
-     * original vector.
-     */
-    static normalize(vector: Vector2D): Vector2D;
-    /**
-     * The function truncates a vector to a maximum length if it exceeds that length.Adjusts x and y so that the length of the vector does not exceed max
-     * @param {Vector2D} vector - A 2D vector represented by the Vector2D class.
-     * @param {number} max - The `max` parameter is a number that represents the maximum length that the `vector` should
-     * have.
-     * @returns either the original vector or a truncated version of the vector, depending on whether the length of the
-     * vector is greater than the maximum value specified.
-     */
-    static truncate(vector: Vector2D, max: number): Vector2D;
-    /**
-     * The function returns a new Vector2D object that is perpendicular to the input vector.The vector that is perpendicular to this one
-     * @param {Vector2D} vector - The parameter "vector" is of type Vector2D.
-     * @returns A new Vector2D object is being returned.
-     */
-    static perp(vector: Vector2D): Vector2D;
-    /**
-     * The reverse function takes a Vector2D object and returns a new Vector2D object with the negated x and y values.
-     * @param {Vector2D} vector - The parameter "vector" is of type Vector2D, which represents a 2-dimensional vector. It
-     * has two properties: "x" and "y", which represent the x and y components of the vector, respectively.
-     * @returns A new Vector2D object with the negated x and y values of the input vector. Returns the vector that is the reverse of this vector
-     */
-    static reverse(vector: Vector2D): Vector2D;
-    /**
-     * The function takes a Vector2D object as input and returns a new Vector2D object with the absolute values of its x
-     * and y components.
-     * @param {Vector2D} vector - The parameter "vector" is of type Vector2D, which represents a 2-dimensional vector. It
-     * has two properties: "x" and "y", which represent the x and y components of the vector, respectively.
-     * @returns The method is returning a new Vector2D object with the absolute values of the x and y components of the
-     * input vector.
-     */
-    static abs(vector: Vector2D): Vector2D;
-    /**
-     * The dot function calculates the dot product of two 2D vectors.The dot product of v1 and v2
-     * @param {Vector2D} vector1 - The parameter `vector1` represents a 2D vector with its x and y components.
-     * @param {Vector2D} vector2 - The "vector2" parameter is a Vector2D object. It represents a two-dimensional vector
-     * with an x and y component.
-     * @returns The dot product of the two input vectors.
-     */
-    static dot(vector1: Vector2D, vector2: Vector2D): number;
-    /**
-     * The function calculates the distance between two points in a two-dimensional space.
-     * @param {Vector2D} vector1 - The parameter `vector1` represents the first vector in 2D space, while `vector2`
-     * represents the second vector. Each vector has an `x` and `y` component, which represent their respective coordinates
-     * in the 2D space.
-     * @param {Vector2D} vector2 - The `vector2` parameter represents the second vector in the calculation of distance. It
-     * is an instance of the `Vector2D` class, which typically has properties `x` and `y` representing the coordinates of
-     * the vector in a 2D space.
-     * @returns The distance between vector1 and vector2.
-     */
-    static distance(vector1: Vector2D, vector2: Vector2D): number;
-    /**
-     * The function calculates the squared distance between two 2D vectors.
-     * @param {Vector2D} vector1 - The parameter `vector1` represents the first vector, which is an instance of the
-     * `Vector2D` class. It contains the x and y coordinates of the vector.
-     * @param {Vector2D} vector2 - The `vector2` parameter represents the second vector in a two-dimensional space. It has
-     * properties `x` and `y` which represent the coordinates of the vector.
-     * @returns the square of the distance between the two input vectors.
-     */
-    static distanceSq(vector1: Vector2D, vector2: Vector2D): number;
-    /**
-     * The sign function determines the sign of the cross product between two 2D vectors.
-     * (assuming the Y axis is pointing down, X axis to right like a Window app)
-     * @param {Vector2D} vector1 - The parameter `vector1` is of type `Vector2D`, which represents a 2-dimensional vector.
-     * It likely has properties `x` and `y` representing the x and y components of the vector, respectively.
-     * @param {Vector2D} vector2 - The above code defines a function called "sign" that takes two parameters: vector1 and
-     * vector2. Both vector1 and vector2 are of type Vector2D.
-     * @returns either -1 or 1. Returns positive if v2 is clockwise of this vector, negative if counterclockwise
-     */
-    static sign(vector1: Vector2D, vector2: Vector2D): number;
-    /**
-     * The function calculates the angle between a given vector and the negative y-axis.
-     * @param {Vector2D} vector - The "vector" parameter is an instance of the Vector2D class, which represents a
-     * 2-dimensional vector. It has two properties: "x" and "y", which represent the x and y components of the vector,
-     * respectively.
-     * @returns the angle between the given vector and the vector (0, -1) in radians.Returns the angle between origin and the given vector in radians
-     */
-    static angle(vector: Vector2D): number;
-    /**
-     * The function "random" generates a random Vector2D object with x and y values within the specified range.
-     * @param {number} maxX - The maxX parameter represents the maximum value for the x-coordinate of the random vector.
-     * @param {number} maxY - The `maxY` parameter represents the maximum value for the y-coordinate of the generated
-     * random vector.
-     * @returns a new instance of the Vector2D class with random x and y values.
-     */
-    static random(maxX: number, maxY: number): Vector2D;
-    /**
-     * The function sets the values of x and y to zero.
-     */
-    zero(): void;
-}