data-structure-typed 1.21.3 → 1.31.0

package/lib/data-structures/linked-list/singly-linked-list.js

@@ -0,0 +1,443 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+export class SinglyLinkedListNode {
+    /**
+     * The constructor function initializes an instance of a class with a given value and sets the next property to null.
+     * @param {T} val - The "val" parameter is of type T, which means it can be any data type. It represents the value that
+     * will be stored in the node of a linked list.
+     */
+    constructor(val) {
+        this._val = val;
+        this._next = null;
+    }
+    get val() {
+        return this._val;
+    }
+    set val(value) {
+        this._val = value;
+    }
+    get next() {
+        return this._next;
+    }
+    set next(value) {
+        this._next = value;
+    }
+}
+export class SinglyLinkedList {
+    /**
+     * The constructor initializes the linked list with an empty head, tail, and length.
+     */
+    constructor() {
+        this._head = null;
+        this._tail = null;
+        this._length = 0;
+    }
+    get head() {
+        return this._head;
+    }
+    set head(value) {
+        this._head = value;
+    }
+    get tail() {
+        return this._tail;
+    }
+    set tail(value) {
+        this._tail = value;
+    }
+    get length() {
+        return this._length;
+    }
+    /**
+     * The `fromArray` function creates a new SinglyLinkedList instance and populates it with the elements from the given
+     * array.
+     * @param {T[]} data - The `data` parameter is an array of elements of type `T`.
+     * @returns The `fromArray` function returns a `SinglyLinkedList` object.
+     */
+    static fromArray(data) {
+        const singlyLinkedList = new SinglyLinkedList();
+        for (const item of data) {
+            singlyLinkedList.push(item);
+        }
+        return singlyLinkedList;
+    }
+    getLength() {
+        return this._length;
+    }
+    /**
+     * The `push` function adds a new node with the given data to the end of a singly linked list.
+     * @param {T} data - The "data" parameter represents the value that you want to add to the linked list. It can be of
+     * any type (T) as specified in the generic type declaration of the class or function.
+     */
+    push(data) {
+        const newNode = new SinglyLinkedListNode(data);
+        if (!this.head) {
+            this.head = newNode;
+            this.tail = newNode;
+        }
+        else {
+            this.tail.next = newNode;
+            this.tail = newNode;
+        }
+        this._length++;
+    }
+    /**
+     * The `pop()` function removes and returns the value of the last element in a linked list, updating the head and tail
+     * pointers accordingly.
+     * @returns The method `pop()` returns the value of the node that is being removed from the end of the linked list. If
+     * the linked list is empty, it returns `null`.
+     */
+    pop() {
+        if (!this.head)
+            return undefined;
+        if (this.head === this.tail) {
+            const val = this.head.val;
+            this.head = null;
+            this.tail = null;
+            this._length--;
+            return val;
+        }
+        let current = this.head;
+        while (current.next !== this.tail) {
+            current = current.next;
+        }
+        const val = this.tail.val;
+        current.next = null;
+        this.tail = current;
+        this._length--;
+        return val;
+    }
+    /**
+     * The `shift()` function removes and returns the value of the first node in a linked list.
+     * @returns The value of the node that is being removed from the beginning of the linked list.
+     */
+    shift() {
+        if (!this.head)
+            return undefined;
+        const removedNode = this.head;
+        this.head = this.head.next;
+        this._length--;
+        return removedNode.val;
+    }
+    /**
+     * The unshift function adds a new node with the given value to the beginning of a singly linked list.
+     * @param {T} val - The parameter "val" represents the value of the new node that will be added to the beginning of the
+     * linked list.
+     */
+    unshift(val) {
+        const newNode = new SinglyLinkedListNode(val);
+        if (!this.head) {
+            this.head = newNode;
+            this.tail = newNode;
+        }
+        else {
+            newNode.next = this.head;
+            this.head = newNode;
+        }
+        this._length++;
+    }
+    /**
+     * The function `getAt` returns the value at a specified index in a linked list, or null if the index is out of range.
+     * @param {number} index - The index parameter is a number that represents the position of the element we want to
+     * retrieve from the list.
+     * @returns The method `getAt(index: number): T | null` returns the value at the specified index in the linked list, or
+     * `null` if the index is out of bounds.
+     */
+    getAt(index) {
+        if (index < 0 || index >= this.length)
+            return undefined;
+        let current = this.head;
+        for (let i = 0; i < index; i++) {
+            current = current.next;
+        }
+        return current.val;
+    }
+    /**
+     * The function `getNodeAt` returns the node at a given index in a singly linked list.
+     * @param {number} index - The `index` parameter is a number that represents the position of the node we want to
+     * retrieve from the linked list. It indicates the zero-based index of the node we want to access.
+     * @returns The method `getNodeAt(index: number)` returns a `SinglyLinkedListNode<T>` object if the node at the
+     * specified index exists, or `null` if the index is out of bounds.
+     */
+    getNodeAt(index) {
+        let current = this.head;
+        for (let i = 0; i < index; i++) {
+            current = current.next;
+        }
+        return current;
+    }
+    /**
+     * The `deleteAt` function removes an element at a specified index from a linked list and returns the removed element.
+     * @param {number} index - The index parameter represents the position of the element that needs to be deleted in the
+     * data structure. It is of type number.
+     * @returns The method `deleteAt` returns the value of the node that was deleted, or `null` if the index is out of
+     * bounds.
+     */
+    deleteAt(index) {
+        if (index < 0 || index >= this.length)
+            return undefined;
+        if (index === 0)
+            return this.shift();
+        if (index === this.length - 1)
+            return this.pop();
+        const prevNode = this.getNodeAt(index - 1);
+        const removedNode = prevNode.next;
+        prevNode.next = removedNode.next;
+        this._length--;
+        return removedNode.val;
+    }
+    /**
+     * The delete function removes a node with a specific value from a singly linked list.
+     * @param {T | SinglyLinkedListNode<T>} valueOrNode - The `valueOrNode` parameter can accept either a value of type `T`
+     * or a `SinglyLinkedListNode<T>` object.
+     * @returns The `delete` method returns a boolean value. It returns `true` if the value or node is found and
+     * successfully deleted from the linked list, and `false` if the value or node is not found in the linked list.
+     */
+    delete(valueOrNode) {
+        let value;
+        if (valueOrNode instanceof SinglyLinkedListNode) {
+            value = valueOrNode.val;
+        }
+        else {
+            value = valueOrNode;
+        }
+        let current = this.head, prev = null;
+        while (current) {
+            if (current.val === value) {
+                if (prev === null) {
+                    this.head = current.next;
+                    if (current === this.tail) {
+                        this.tail = null;
+                    }
+                }
+                else {
+                    prev.next = current.next;
+                    if (current === this.tail) {
+                        this.tail = prev;
+                    }
+                }
+                this._length--;
+                return true;
+            }
+            prev = current;
+            current = current.next;
+        }
+        return false;
+    }
+    /**
+     * The `insertAt` function inserts a value at a specified index in a singly linked list.
+     * @param {number} index - The index parameter represents the position at which the new value should be inserted in the
+     * linked list. It is of type number.
+     * @param {T} val - The `val` parameter represents the value that you want to insert into the linked list at the
+     * specified index.
+     * @returns The `insert` method returns a boolean value. It returns `true` if the insertion is successful, and `false`
+     * if the index is out of bounds.
+     */
+    insertAt(index, val) {
+        if (index < 0 || index > this.length)
+            return false;
+        if (index === 0) {
+            this.unshift(val);
+            return true;
+        }
+        if (index === this.length) {
+            this.push(val);
+            return true;
+        }
+        const newNode = new SinglyLinkedListNode(val);
+        const prevNode = this.getNodeAt(index - 1);
+        newNode.next = prevNode.next;
+        prevNode.next = newNode;
+        this._length++;
+        return true;
+    }
+    /**
+     * The function checks if the length of a data structure is equal to zero and returns a boolean value indicating
+     * whether it is empty or not.
+     * @returns A boolean value indicating whether the length of the object is equal to 0.
+     */
+    isEmpty() {
+        return this.length === 0;
+    }
+    /**
+     * The `clear` function resets the linked list by setting the head, tail, and length to null and 0 respectively.
+     */
+    clear() {
+        this._head = null;
+        this._tail = null;
+        this._length = 0;
+    }
+    /**
+     * The `toArray` function converts a linked list into an array.
+     * @returns The `toArray()` method is returning an array of type `T[]`.
+     */
+    toArray() {
+        const array = [];
+        let current = this.head;
+        while (current) {
+            array.push(current.val);
+            current = current.next;
+        }
+        return array;
+    }
+    /**
+     * The `reverse` function reverses the order of the nodes in a singly linked list.
+     * @returns The reverse() method does not return anything. It has a return type of void.
+     */
+    reverse() {
+        if (!this.head || this.head === this.tail)
+            return;
+        let prev = null;
+        let current = this.head;
+        let next = null;
+        while (current) {
+            next = current.next;
+            current.next = prev;
+            prev = current;
+            current = next;
+        }
+        [this.head, this.tail] = [this.tail, this.head];
+    }
+    /**
+     * The `find` function iterates through a linked list and returns the first element that satisfies a given condition.
+     * @param callback - A function that takes a value of type T as its parameter and returns a boolean value. This
+     * function is used to determine whether a particular value in the linked list satisfies a certain condition.
+     * @returns The method `find` returns the first element in the linked list that satisfies the condition specified by
+     * the callback function. If no element satisfies the condition, it returns `null`.
+     */
+    find(callback) {
+        let current = this.head;
+        while (current) {
+            if (callback(current.val)) {
+                return current.val;
+            }
+            current = current.next;
+        }
+        return null;
+    }
+    /**
+     * The `indexOf` function returns the index of the first occurrence of a given value in a linked list.
+     * @param {T} value - The value parameter is the value that you want to find the index of in the linked list.
+     * @returns The method is returning the index of the first occurrence of the specified value in the linked list. If the
+     * value is not found, it returns -1.
+     */
+    indexOf(value) {
+        let index = 0;
+        let current = this.head;
+        while (current) {
+            if (current.val === value) {
+                return index;
+            }
+            index++;
+            current = current.next;
+        }
+        return -1;
+    }
+    /**
+     * The function finds a node in a singly linked list by its value and returns the node if found, otherwise returns
+     * null.
+     * @param {T} value - The value parameter is the value that we want to search for in the linked list.
+     * @returns a `SinglyLinkedListNode<T>` if a node with the specified value is found in the linked list. If no node with
+     * the specified value is found, the function returns `null`.
+     */
+    findNode(value) {
+        let current = this.head;
+        while (current) {
+            if (current.val === value) {
+                return current;
+            }
+            current = current.next;
+        }
+        return null;
+    }
+    /**
+     * The `insertBefore` function inserts a new value before an existing value in a singly linked list.
+     * @param {T | SinglyLinkedListNode<T>} existingValueOrNode - The existing value or node that you want to insert the
+     * new value before. It can be either the value itself or a node containing the value in the linked list.
+     * @param {T} newValue - The `newValue` parameter represents the value that you want to insert into the linked list.
+     * @returns The method `insertBefore` returns a boolean value. It returns `true` if the new value was successfully
+     * inserted before the existing value, and `false` otherwise.
+     */
+    insertBefore(existingValueOrNode, newValue) {
+        if (!this.head)
+            return false;
+        let existingValue;
+        if (existingValueOrNode instanceof SinglyLinkedListNode) {
+            existingValue = existingValueOrNode.val;
+        }
+        else {
+            existingValue = existingValueOrNode;
+        }
+        if (this.head.val === existingValue) {
+            this.unshift(newValue);
+            return true;
+        }
+        let current = this.head;
+        while (current.next) {
+            if (current.next.val === existingValue) {
+                const newNode = new SinglyLinkedListNode(newValue);
+                newNode.next = current.next;
+                current.next = newNode;
+                this._length++;
+                return true;
+            }
+            current = current.next;
+        }
+        return false;
+    }
+    /**
+     * The `insertAfter` function inserts a new node with a given value after an existing node in a singly linked list.
+     * @param {T | SinglyLinkedListNode<T>} existingValueOrNode - The existing value or node in the linked list after which
+     * the new value will be inserted. It can be either the value of the existing node or the existing node itself.
+     * @param {T} newValue - The value that you want to insert into the linked list after the existing value or node.
+     * @returns The method returns a boolean value. It returns true if the new value was successfully inserted after the
+     * existing value or node, and false if the existing value or node was not found in the linked list.
+     */
+    insertAfter(existingValueOrNode, newValue) {
+        let existingNode;
+        if (existingValueOrNode instanceof SinglyLinkedListNode) {
+            existingNode = existingValueOrNode;
+        }
+        else {
+            existingNode = this.findNode(existingValueOrNode);
+        }
+        if (existingNode) {
+            const newNode = new SinglyLinkedListNode(newValue);
+            newNode.next = existingNode.next;
+            existingNode.next = newNode;
+            if (existingNode === this.tail) {
+                this.tail = newNode;
+            }
+            this._length++;
+            return true;
+        }
+        return false;
+    }
+    /**
+     * The function counts the number of occurrences of a given value in a linked list.
+     * @param {T} value - The value parameter is the value that you want to count the occurrences of in the linked list.
+     * @returns The count of occurrences of the given value in the linked list.
+     */
+    countOccurrences(value) {
+        let count = 0;
+        let current = this.head;
+        while (current) {
+            if (current.val === value) {
+                count++;
+            }
+            current = current.next;
+        }
+        return count;
+    }
+    *[Symbol.iterator]() {
+        let current = this.head;
+        while (current) {
+            yield current.val;
+            current = current.next;
+        }
+    }
+}

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

@@ -0,0 +1,2 @@
+export class SkipLinkedList {
+}

package/lib/data-structures/matrix/index.js

@@ -0,0 +1,4 @@
+export * from './matrix';
+export * from './vector2d';
+export * from './matrix2d';
+export * from './navigator';

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

@@ -0,0 +1,24 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+// todo need to be improved
+export 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/lib/data-structures/matrix/matrix2d.js

@@ -0,0 +1,195 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import Vector2D from './vector2d';
+export 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) {
+            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 "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(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++) {
+            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) {
+        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;
+        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]
+        ]);
+    }
+}
+export default Matrix2D;