linked-list-typed 1.19.3 → 1.19.5

package/dist/singly-linked-list.d.ts

@@ -1,156 +0,0 @@
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-export declare class SinglyLinkedListNode<T = number> {
-    /**
-     * 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: T);
-    private _val;
-    get val(): T;
-    set val(value: T);
-    private _next;
-    get next(): SinglyLinkedListNode<T> | null;
-    set next(value: SinglyLinkedListNode<T> | null);
-}
-export declare class SinglyLinkedList<T = number> {
-    /**
-     * The constructor initializes the linked list with an empty head, tail, and length.
-     */
-    constructor();
-    private _head;
-    get head(): SinglyLinkedListNode<T> | null;
-    set head(value: SinglyLinkedListNode<T> | null);
-    private _tail;
-    get tail(): SinglyLinkedListNode<T> | null;
-    set tail(value: SinglyLinkedListNode<T> | null);
-    private _length;
-    get length(): number;
-    /**
-     * 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<T>(data: T[]): SinglyLinkedList<T>;
-    getLength(): number;
-    /**
-     * 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: T): void;
-    /**
-     * 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(): T | null;
-    /**
-     * 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(): T | null;
-    /**
-     * 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: T): void;
-    /**
-     * 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: number): T | null;
-    /**
-     * 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: number): SinglyLinkedListNode<T> | null;
-    /**
-     * 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: number): T | null;
-    delete(valueOrNode: T): boolean;
-    delete(valueOrNode: SinglyLinkedListNode<T>): boolean;
-    /**
-     * 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: number, val: T): boolean;
-    /**
-     * 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(): boolean;
-    /**
-     * The `clear` function resets the linked list by setting the head, tail, and length to null and 0 respectively.
-     */
-    clear(): void;
-    /**
-     * The `toArray` function converts a linked list into an array.
-     * @returns The `toArray()` method is returning an array of type `T[]`.
-     */
-    toArray(): T[];
-    /**
-     * 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(): void;
-    /**
-     * 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: (val: T) => boolean): T | 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: T): number;
-    /**
-     * 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: T): SinglyLinkedListNode<T> | null;
-    insertBefore(existingValue: T, newValue: T): boolean;
-    insertBefore(existingValue: SinglyLinkedListNode<T>, newValue: T): boolean;
-    insertAfter(existingValueOrNode: T, newValue: T): boolean;
-    insertAfter(existingValueOrNode: SinglyLinkedListNode<T>, newValue: T): boolean;
-    /**
-     * 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: T): number;
-}

package/dist/singly-linked-list.js

@@ -1,502 +0,0 @@
-"use strict";
-var __values = (this && this.__values) || function(o) {
-    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
-    if (m) return m.call(o);
-    if (o && typeof o.length === "number") return {
-        next: function () {
-            if (o && i >= o.length) o = void 0;
-            return { value: o && o[i++], done: !o };
-        }
-    };
-    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
-};
-var __read = (this && this.__read) || function (o, n) {
-    var m = typeof Symbol === "function" && o[Symbol.iterator];
-    if (!m) return o;
-    var i = m.call(o), r, ar = [], e;
-    try {
-        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
-    }
-    catch (error) { e = { error: error }; }
-    finally {
-        try {
-            if (r && !r.done && (m = i["return"])) m.call(i);
-        }
-        finally { if (e) throw e.error; }
-    }
-    return ar;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SinglyLinkedList = exports.SinglyLinkedListNode = void 0;
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-var SinglyLinkedListNode = /** @class */ (function () {
-    /**
-     * 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.
-     */
-    function SinglyLinkedListNode(val) {
-        this._val = val;
-        this._next = null;
-    }
-    Object.defineProperty(SinglyLinkedListNode.prototype, "val", {
-        get: function () {
-            return this._val;
-        },
-        set: function (value) {
-            this._val = value;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(SinglyLinkedListNode.prototype, "next", {
-        get: function () {
-            return this._next;
-        },
-        set: function (value) {
-            this._next = value;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    return SinglyLinkedListNode;
-}());
-exports.SinglyLinkedListNode = SinglyLinkedListNode;
-var SinglyLinkedList = /** @class */ (function () {
-    /**
-     * The constructor initializes the linked list with an empty head, tail, and length.
-     */
-    function SinglyLinkedList() {
-        this._head = null;
-        this._tail = null;
-        this._length = 0;
-    }
-    Object.defineProperty(SinglyLinkedList.prototype, "head", {
-        get: function () {
-            return this._head;
-        },
-        set: function (value) {
-            this._head = value;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(SinglyLinkedList.prototype, "tail", {
-        get: function () {
-            return this._tail;
-        },
-        set: function (value) {
-            this._tail = value;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(SinglyLinkedList.prototype, "length", {
-        get: function () {
-            return this._length;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    /**
-     * 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.
-     */
-    SinglyLinkedList.fromArray = function (data) {
-        var e_1, _a;
-        var singlyLinkedList = new SinglyLinkedList();
-        try {
-            for (var data_1 = __values(data), data_1_1 = data_1.next(); !data_1_1.done; data_1_1 = data_1.next()) {
-                var item = data_1_1.value;
-                singlyLinkedList.push(item);
-            }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (data_1_1 && !data_1_1.done && (_a = data_1.return)) _a.call(data_1);
-            }
-            finally { if (e_1) throw e_1.error; }
-        }
-        return singlyLinkedList;
-    };
-    SinglyLinkedList.prototype.getLength = function () {
-        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.
-     */
-    SinglyLinkedList.prototype.push = function (data) {
-        var 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`.
-     */
-    SinglyLinkedList.prototype.pop = function () {
-        if (!this.head)
-            return null;
-        if (this.head === this.tail) {
-            var val_1 = this.head.val;
-            this.head = null;
-            this.tail = null;
-            this._length--;
-            return val_1;
-        }
-        var current = this.head;
-        while (current.next !== this.tail) {
-            current = current.next;
-        }
-        var 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.
-     */
-    SinglyLinkedList.prototype.shift = function () {
-        if (!this.head)
-            return null;
-        var 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.
-     */
-    SinglyLinkedList.prototype.unshift = function (val) {
-        var 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.
-     */
-    SinglyLinkedList.prototype.getAt = function (index) {
-        if (index < 0 || index >= this.length)
-            return null;
-        var current = this.head;
-        for (var 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.
-     */
-    SinglyLinkedList.prototype.getNodeAt = function (index) {
-        var current = this.head;
-        for (var 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.
-     */
-    SinglyLinkedList.prototype.deleteAt = function (index) {
-        if (index < 0 || index >= this.length)
-            return null;
-        if (index === 0)
-            return this.shift();
-        if (index === this.length - 1)
-            return this.pop();
-        var prevNode = this.getNodeAt(index - 1);
-        var 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.
-     */
-    SinglyLinkedList.prototype.delete = function (valueOrNode) {
-        var value;
-        if (valueOrNode instanceof SinglyLinkedListNode) {
-            value = valueOrNode.val;
-        }
-        else {
-            value = valueOrNode;
-        }
-        var 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.
-     */
-    SinglyLinkedList.prototype.insertAt = function (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;
-        }
-        var newNode = new SinglyLinkedListNode(val);
-        var 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.
-     */
-    SinglyLinkedList.prototype.isEmpty = function () {
-        return this.length === 0;
-    };
-    /**
-     * The `clear` function resets the linked list by setting the head, tail, and length to null and 0 respectively.
-     */
-    SinglyLinkedList.prototype.clear = function () {
-        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[]`.
-     */
-    SinglyLinkedList.prototype.toArray = function () {
-        var array = [];
-        var 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.
-     */
-    SinglyLinkedList.prototype.reverse = function () {
-        var _a;
-        if (!this.head || this.head === this.tail)
-            return;
-        var prev = null;
-        var current = this.head;
-        var next = null;
-        while (current) {
-            next = current.next;
-            current.next = prev;
-            prev = current;
-            current = next;
-        }
-        _a = __read([this.tail, this.head], 2), this.head = _a[0], this.tail = _a[1];
-    };
-    /**
-     * 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`.
-     */
-    SinglyLinkedList.prototype.find = function (callback) {
-        var 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.
-     */
-    SinglyLinkedList.prototype.indexOf = function (value) {
-        var index = 0;
-        var 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`.
-     */
-    SinglyLinkedList.prototype.findNode = function (value) {
-        var 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.
-     */
-    SinglyLinkedList.prototype.insertBefore = function (existingValueOrNode, newValue) {
-        if (!this.head)
-            return false;
-        var existingValue;
-        if (existingValueOrNode instanceof SinglyLinkedListNode) {
-            existingValue = existingValueOrNode.val;
-        }
-        else {
-            existingValue = existingValueOrNode;
-        }
-        if (this.head.val === existingValue) {
-            this.unshift(newValue);
-            return true;
-        }
-        var current = this.head;
-        while (current.next) {
-            if (current.next.val === existingValue) {
-                var 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.
-     */
-    SinglyLinkedList.prototype.insertAfter = function (existingValueOrNode, newValue) {
-        var existingNode;
-        if (existingValueOrNode instanceof SinglyLinkedListNode) {
-            existingNode = existingValueOrNode;
-        }
-        else {
-            existingNode = this.findNode(existingValueOrNode);
-        }
-        if (existingNode) {
-            var 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.
-     */
-    SinglyLinkedList.prototype.countOccurrences = function (value) {
-        var count = 0;
-        var current = this.head;
-        while (current) {
-            if (current.val === value) {
-                count++;
-            }
-            current = current.next;
-        }
-        return count;
-    };
-    return SinglyLinkedList;
-}());
-exports.SinglyLinkedList = SinglyLinkedList;