data-structure-typed 0.8.18 → 1.3.0

package/dist/data-structures/linked-list/skip-linked-list.d.ts

@@ -1 +1,2 @@
-export {};
+export declare class SkipLinkedList {
+}

package/dist/data-structures/linked-list/skip-linked-list.js

@@ -1,2 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SkipLinkedList = void 0;
+class SkipLinkedList {
+}
+exports.SkipLinkedList = SkipLinkedList;

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

@@ -1,5 +1,17 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
 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,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MatrixNTI2D = void 0;
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
 // todo need to be improved
 class MatrixNTI2D {
+    /**
+     * 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) {
         const { row, col, initialVal } = options;
         this._matrix = new Array(row).fill(undefined).map(() => 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. */
     toArray() {
         return this._matrix;
     }

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

@@ -1,25 +1,108 @@
+/**
+ * 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 {
     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);
     /**
-     * Return the matrix values
+     * The function returns a 2D array with three empty arrays.
+     * @returns An empty 2-dimensional array with 3 empty arrays inside.
      */
-    get m(): number[][];
     static get empty(): number[][];
-    get toVector(): Vector2D;
     /**
-     * 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[][];
+    /**
+     * 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,21 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 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 = __importDefault(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;
@@ -21,19 +34,15 @@ class Matrix2D {
         }
     }
     /**
-     * Return the matrix values
+     * The function returns a 2D array with three empty arrays.
+     * @returns An empty 2-dimensional array with 3 empty arrays inside.
      */
-    get m() {
-        return this._matrix;
-    }
     static get empty() {
         return [[], [], []];
     }
-    get toVector() {
-        return new vector2d_1.default(this._matrix[0][0], this._matrix[1][0]);
-    }
     /**
-     * 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() {
         return [
@@ -42,6 +51,29 @@ class Matrix2D {
             [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 "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() {
+        return new vector2d_1.default(this._matrix[0][0], this._matrix[1][0]);
+    }
+    /**
+     * 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++) {
@@ -51,6 +83,13 @@ class Matrix2D {
         }
         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++) {
@@ -60,6 +99,12 @@ class Matrix2D {
         }
         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++) {
@@ -72,6 +117,13 @@ class Matrix2D {
         }
         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++) {
@@ -81,9 +133,23 @@ class Matrix2D {
         }
         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) {
         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.
+     */
     static view(width, height) {
         const scaleStep = 1; // Scale every vector * scaleStep
         const centerX = width / 2;
@@ -95,9 +161,20 @@ class Matrix2D {
             [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);
@@ -107,6 +184,12 @@ class Matrix2D {
             [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],

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

@@ -1,31 +1,52 @@
-type Direction = 'up' | 'right' | 'down' | 'left';
-type Turning = {
-    [key in Direction]: Direction;
-};
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+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);
 }
-interface NavigatorParams<T> {
-    matrix: T[][];
-    turning: Turning;
-    onMove: (cur: [number, number]) => void;
-    init: {
-        cur: [number, number];
-        charDir: Direction;
-        VISITED: T;
-    };
-}
 export declare class Navigator<T = number> {
+    onMove: (cur: [number, number]) => void;
     private readonly _matrix;
     private readonly _cur;
     private _character;
     private readonly _VISITED;
-    onMove: (cur: [number, number]) => void;
+    /**
+     * 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;
 }
-export {};

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

@@ -2,6 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Navigator = exports.Character = void 0;
 class 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, turning) {
         this.direction = direction;
         this.turn = () => new Character(turning[direction], turning);
@@ -9,6 +17,11 @@ class Character {
 }
 exports.Character = Character;
 class Navigator {
+    /**
+     * 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 } }) {
         this._matrix = matrix;
         this._cur = cur;
@@ -18,6 +31,10 @@ class Navigator {
         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.
+     */
     start() {
         while (this.check(this._character.direction) || this.check(this._character.turn().direction)) {
             const { direction } = this._character;
@@ -29,6 +46,12 @@ class Navigator {
             }
         }
     }
+    /**
+     * 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) {
         let forward, row;
         const matrix = this._matrix;
@@ -55,6 +78,11 @@ class Navigator {
         }
         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'.
+     */
     move(direction) {
         switch (direction) {
             case 'up':