data-structure-typed 0.9.16 → 1.12.9

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

@@ -1,5 +1,14 @@
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
 export declare class MatrixNTI2D<T = number> {
     private readonly _matrix;
+    /**
+     * The constructor creates a matrix with the specified number of rows and columns, and initializes all elements to a
+     * given initial value or 0 if not provided.
+     * @param options - An object containing the following properties:
+     */
     constructor(options: {
         row: number;
         col: number;

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

@@ -1,12 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MatrixNTI2D = void 0;
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
 // todo need to be improved
 var MatrixNTI2D = /** @class */ (function () {
+    /**
+     * The constructor creates a matrix with the specified number of rows and columns, and initializes all elements to a
+     * given initial value or 0 if not provided.
+     * @param options - An object containing the following properties:
+     */
     function MatrixNTI2D(options) {
         var row = options.row, col = options.col, initialVal = options.initialVal;
         this._matrix = new Array(row).fill(undefined).map(function () { return new Array(col).fill(initialVal || 0); });
     }
+    /* The `toArray` method returns the matrix as a two-dimensional array. It converts the internal representation of the
+    matrix, which is an array of arrays, into a format that is more commonly used in JavaScript. */
     MatrixNTI2D.prototype.toArray = function () {
         return this._matrix;
     };

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

@@ -1,25 +1,105 @@
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
 import Vector2D from './vector2d';
 export declare class Matrix2D {
     private readonly _matrix;
+    /**
+     * 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[][];
     /**
-     * Initialize an identity matrix
+     * 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[][];
     /**
-     * Return the matrix values
+     * 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 "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.
+     */
     get toVector(): Vector2D;
+    /**
+     * 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;
 }
 export default Matrix2D;

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

@@ -4,8 +4,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Matrix2D = void 0;
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
 var vector2d_1 = __importDefault(require("./vector2d"));
 var Matrix2D = /** @class */ (function () {
+    /**
+     * 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.
+     */
     function Matrix2D(value) {
         if (typeof value === 'undefined') {
             this._matrix = Matrix2D.identity;
@@ -21,6 +31,10 @@ var Matrix2D = /** @class */ (function () {
         }
     }
     Object.defineProperty(Matrix2D, "empty", {
+        /**
+         * The function returns a 2D array with three empty arrays.
+         * @returns An empty 2-dimensional array with 3 empty arrays inside.
+         */
         get: function () {
             return [[], [], []];
         },
@@ -29,7 +43,8 @@ var Matrix2D = /** @class */ (function () {
     });
     Object.defineProperty(Matrix2D, "identity", {
         /**
-         * Initialize an identity matrix
+         * The above function returns a 3x3 identity matrix.
+         * @returns The method is returning a 2-dimensional array of numbers representing the identity matrix.
          */
         get: function () {
             return [
@@ -43,7 +58,9 @@ var Matrix2D = /** @class */ (function () {
     });
     Object.defineProperty(Matrix2D.prototype, "m", {
         /**
-         * Return the matrix values
+         * 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: function () {
             return this._matrix;
@@ -52,12 +69,24 @@ var Matrix2D = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(Matrix2D.prototype, "toVector", {
+        /**
+         * 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.
+         */
         get: function () {
             return new vector2d_1.default(this._matrix[0][0], this._matrix[1][0]);
         },
         enumerable: false,
         configurable: true
     });
+    /**
+     * 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.
+     */
     Matrix2D.add = function (matrix1, matrix2) {
         var result = Matrix2D.empty;
         for (var i = 0; i < 3; i++) {
@@ -67,6 +96,13 @@ var Matrix2D = /** @class */ (function () {
         }
         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.
+     */
     Matrix2D.subtract = function (matrix1, matrix2) {
         var result = Matrix2D.empty;
         for (var i = 0; i < 3; i++) {
@@ -76,6 +112,12 @@ var Matrix2D = /** @class */ (function () {
         }
         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.
+     */
     Matrix2D.multiply = function (matrix1, matrix2) {
         var result = Matrix2D.empty;
         for (var i = 0; i < 3; i++) {
@@ -88,6 +130,13 @@ var Matrix2D = /** @class */ (function () {
         }
         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.
+     */
     Matrix2D.multiplyByValue = function (matrix, value) {
         var result = Matrix2D.empty;
         for (var i = 0; i < 3; i++) {
@@ -97,9 +146,23 @@ var Matrix2D = /** @class */ (function () {
         }
         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.
+     */
     Matrix2D.multiplyByVector = function (matrix, vector) {
         return Matrix2D.multiply(matrix, new Matrix2D(vector)).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.
+     */
     Matrix2D.view = function (width, height) {
         var scaleStep = 1; // Scale every vector * scaleStep
         var centerX = width / 2;
@@ -111,9 +174,20 @@ var Matrix2D = /** @class */ (function () {
             [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.
+     */
     Matrix2D.scale = function (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.
+     */
     Matrix2D.rotate = function (radians) {
         var cos = Math.cos(radians);
         var sin = Math.sin(radians);
@@ -123,6 +197,12 @@ var Matrix2D = /** @class */ (function () {
             [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.
+     */
     Matrix2D.translate = function (vector) {
         return new Matrix2D([
             [1, 0, vector.x],

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

@@ -1,7 +1,19 @@
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
 import type { Direction, NavigatorParams, Turning } from '../types';
 export declare class Character {
     direction: Direction;
     turn: () => Character;
+    /**
+     * The constructor function takes in a direction and turning object and sets the direction and turn properties of the
+     * Character class.
+     * @param {Direction} direction - The direction parameter is used to specify the current direction of the character. It
+     * can be any value that represents a direction, such as "north", "south", "east", or "west".
+     * @param {Turning} turning - The `turning` parameter is an object that maps each direction to the corresponding
+     * turning direction. It is used to determine the new direction when the character turns.
+     */
     constructor(direction: Direction, turning: Turning);
 }
 export declare class Navigator<T = number> {
@@ -10,8 +22,28 @@ export declare class Navigator<T = number> {
     private readonly _cur;
     private _character;
     private readonly _VISITED;
+    /**
+     * The constructor initializes the Navigator object with the given parameters and sets the current position as visited
+     * in the matrix.
+     * @param  - - `matrix`: a 2D array representing the grid or map
+     */
     constructor({ matrix, turning, onMove, init: { cur, charDir, VISITED } }: NavigatorParams<T>);
+    /**
+     * The "start" function moves the character in its current direction until it encounters an obstacle, then it turns the
+     * character and repeats the process.
+     */
     start(): void;
+    /**
+     * The function checks if there is a valid move in the specified direction in a matrix.
+     * @param {Direction} direction - The direction parameter is a string that represents the direction in which to check.
+     * It can be one of the following values: 'up', 'right', 'down', or 'left'.
+     * @returns a boolean value.
+     */
     check(direction: Direction): boolean;
+    /**
+     * The `move` function updates the current position based on the given direction and updates the matrix accordingly.
+     * @param {Direction} direction - The `direction` parameter is a string that represents the direction in which to move.
+     * It can have one of the following values: 'up', 'right', 'down', or 'left'.
+     */
     move(direction: Direction): void;
 }

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

@@ -18,6 +18,14 @@ var __read = (this && this.__read) || function (o, n) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Navigator = exports.Character = void 0;
 var Character = /** @class */ (function () {
+    /**
+     * The constructor function takes in a direction and turning object and sets the direction and turn properties of the
+     * Character class.
+     * @param {Direction} direction - The direction parameter is used to specify the current direction of the character. It
+     * can be any value that represents a direction, such as "north", "south", "east", or "west".
+     * @param {Turning} turning - The `turning` parameter is an object that maps each direction to the corresponding
+     * turning direction. It is used to determine the new direction when the character turns.
+     */
     function Character(direction, turning) {
         this.direction = direction;
         this.turn = function () { return new Character(turning[direction], turning); };
@@ -26,6 +34,11 @@ var Character = /** @class */ (function () {
 }());
 exports.Character = Character;
 var Navigator = /** @class */ (function () {
+    /**
+     * The constructor initializes the Navigator object with the given parameters and sets the current position as visited
+     * in the matrix.
+     * @param  - - `matrix`: a 2D array representing the grid or map
+     */
     function Navigator(_a) {
         var matrix = _a.matrix, turning = _a.turning, onMove = _a.onMove, _b = _a.init, cur = _b.cur, charDir = _b.charDir, VISITED = _b.VISITED;
         this._matrix = matrix;
@@ -36,6 +49,10 @@ var Navigator = /** @class */ (function () {
         this._VISITED = VISITED;
         this._matrix[this._cur[0]][this._cur[1]] = this._VISITED;
     }
+    /**
+     * The "start" function moves the character in its current direction until it encounters an obstacle, then it turns the
+     * character and repeats the process.
+     */
     Navigator.prototype.start = function () {
         while (this.check(this._character.direction) || this.check(this._character.turn().direction)) {
             var direction = this._character.direction;
@@ -47,6 +64,12 @@ var Navigator = /** @class */ (function () {
             }
         }
     };
+    /**
+     * The function checks if there is a valid move in the specified direction in a matrix.
+     * @param {Direction} direction - The direction parameter is a string that represents the direction in which to check.
+     * It can be one of the following values: 'up', 'right', 'down', or 'left'.
+     * @returns a boolean value.
+     */
     Navigator.prototype.check = function (direction) {
         var forward, row;
         var matrix = this._matrix;
@@ -73,6 +96,11 @@ var Navigator = /** @class */ (function () {
         }
         return forward !== undefined && forward !== this._VISITED;
     };
+    /**
+     * The `move` function updates the current position based on the given direction and updates the matrix accordingly.
+     * @param {Direction} direction - The `direction` parameter is a string that represents the direction in which to move.
+     * It can have one of the following values: 'up', 'right', 'down', or 'left'.
+     */
     Navigator.prototype.move = function (direction) {
         switch (direction) {
             case 'up':

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

@@ -1,73 +1,197 @@
+/**
+ * @copyright 2030 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT
+ */
 export declare class Vector2D {
     x: number;
     y: number;
     w: number;
     constructor(x?: number, y?: number, w?: number);
     /**
-     * Set x and y both to zero
+     * 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 length / magnitude of the vector
+     * 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 squared length of the vector
+     * 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;
     /**
-     * Return the vector with rounded values
+     * 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;
     /**
-     * Normalizes the vector if it matches a certain condition
+     * 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;
     /**
-     * Adjusts x and y so that the length of the vector does not exceed max
+     * 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 vector that is perpendicular to this one
+     * 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;
     /**
-     * returns the vector that is the reverse of this vector
+     * 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 product of v1 and v2
+     * 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 distance between this and the vector
+     * 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 distance between this and the vector squared
+     * 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;
     /**
-     * Returns positive if v2 is clockwise of this vector, negative if counterclockwise
+     * 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;
     /**
-     * Returns the angle between origin and the given vector in radians
-     * @param vector
+     * 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;
     /**
-     * Check wether both x and y are zero
+     * The function sets the values of x and y to zero.
      */
     zero(): void;
 }