priority-queue-typed 1.19.3

package/dist/priority-queue.js

@@ -0,0 +1,365 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+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;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PriorityQueue = void 0;
+var PriorityQueue = /** @class */ (function () {
+    /**
+     * The constructor initializes a priority queue with the given options, including an array of nodes and a comparator
+     * function.
+     * @param options - The `options` parameter is an object that contains the following properties:
+     */
+    function PriorityQueue(options) {
+        this._nodes = [];
+        this._comparator = function (a, b) {
+            var aKey = a, bKey = b;
+            return aKey - bKey;
+        };
+        var nodes = options.nodes, comparator = options.comparator, _a = options.isFix, isFix = _a === void 0 ? true : _a;
+        this._comparator = comparator;
+        if (nodes && Array.isArray(nodes) && nodes.length > 0) {
+            // TODO support distinct
+            this._nodes = __spreadArray([], __read(nodes), false);
+            isFix && this._fix();
+        }
+    }
+    Object.defineProperty(PriorityQueue.prototype, "nodes", {
+        get: function () {
+            return this._nodes;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(PriorityQueue.prototype, "size", {
+        get: function () {
+            return this.nodes.length;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * The `heapify` function creates a new PriorityQueue instance and fixes the heap property.
+     * @param options - The "options" parameter is an object that contains the configuration options for the PriorityQueue.
+     * It can include properties such as "comparator" which specifies the comparison function used to order the elements in
+     * the priority queue, and "initialValues" which is an array of initial values to be added to the priority
+     * @returns a new instance of the PriorityQueue class after performing the heapify operation on it.
+     */
+    PriorityQueue.heapify = function (options) {
+        var heap = new PriorityQueue(options);
+        heap._fix();
+        return heap;
+    };
+    /**
+     * The function checks if a priority queue is valid by creating a new priority queue with a fix option and then calling
+     * the isValid method.
+     * @param options - An object containing options for creating a priority queue. The options object should have the
+     * following properties:
+     * @returns the result of calling the `isValid()` method on a new instance of the `PriorityQueue` class.
+     */
+    PriorityQueue.isPriorityQueueified = function (options) {
+        return new PriorityQueue(__assign(__assign({}, options), { isFix: false })).isValid();
+    };
+    /**
+     * Starting from TypeScript version 5.0 and onwards, the use of distinct access modifiers for Getters and Setters is not permitted. As an alternative, to ensure compatibility, it is necessary to adopt a Java-style approach for Setters (using the same name as the property) while utilizing separate method names for Getters.
+     */
+    PriorityQueue.prototype.getNodes = function () {
+        return this._nodes;
+    };
+    /**
+     * The "add" function adds a node to the heap and ensures that the heap property is maintained.
+     * @param {T} node - The parameter "node" is of type T, which means it can be any data type. It represents the node
+     * that needs to be added to the heap.
+     */
+    PriorityQueue.prototype.add = function (node) {
+        this.nodes.push(node);
+        this._heapifyUp(this.size - 1);
+    };
+    /**
+     * The "has" function checks if a given node is present in the list of nodes.
+     * @param {T} node - The parameter `node` is of type `T`, which means it can be any type. It represents the node that
+     * we want to check if it exists in the `nodes` array.
+     * @returns a boolean value indicating whether the given node is included in the array of nodes.
+     */
+    PriorityQueue.prototype.has = function (node) {
+        return this.nodes.includes(node);
+    };
+    /**
+     * The `peek` function returns the first element of the `nodes` array if it exists, otherwise it returns `null`.
+     * @returns The `peek()` function is returning the first element (`T`) of the `nodes` array if the `size` is not zero.
+     * Otherwise, it returns `null`.
+     */
+    PriorityQueue.prototype.peek = function () {
+        return this.size ? this.nodes[0] : null;
+    };
+    /**
+     * The `poll` function removes and returns the top element from a heap data structure.
+     * @returns The `poll()` method returns a value of type `T` or `null`.
+     */
+    PriorityQueue.prototype.poll = function () {
+        var _a, _b;
+        var res = null;
+        if (this.size > 1) {
+            this._swap(0, this.nodes.length - 1);
+            res = (_a = this.nodes.pop()) !== null && _a !== void 0 ? _a : null;
+            this._heapifyDown(0);
+        }
+        else if (this.size === 1) {
+            res = (_b = this.nodes.pop()) !== null && _b !== void 0 ? _b : null;
+        }
+        return res;
+    };
+    /**
+     * The `leaf` function returns the last element in the `nodes` array or `null` if the array is empty.
+     * @returns The method `leaf()` is returning the last element (`T`) in the `nodes` array if it exists. If the array is
+     * empty or the last element is `null`, then it returns `null`.
+     */
+    PriorityQueue.prototype.leaf = function () {
+        var _a;
+        return (_a = this.nodes[this.size - 1]) !== null && _a !== void 0 ? _a : null;
+    };
+    /**
+     * The function checks if the size of an object is equal to zero and returns a boolean value indicating whether the
+     * object is empty or not.
+     * @returns The method `isEmpty()` is returning a boolean value indicating whether the size of the object is equal to
+     * 0.
+     */
+    PriorityQueue.prototype.isEmpty = function () {
+        return this.size === 0;
+    };
+    /**
+     * The clear function clears the nodes array.
+     */
+    PriorityQueue.prototype.clear = function () {
+        this._setNodes([]);
+    };
+    /**
+     * The toArray function returns an array containing all the elements in the nodes property.
+     * @returns An array of type T, which is the elements of the nodes property.
+     */
+    PriorityQueue.prototype.toArray = function () {
+        return __spreadArray([], __read(this.nodes), false);
+    };
+    /**
+     * The `clone` function returns a new instance of the `PriorityQueue` class with the same nodes and comparator as the
+     * original instance.
+     * @returns The `clone()` method is returning a new instance of the `PriorityQueue` class with the same `nodes` and
+     * `comparator` properties as the original instance.
+     */
+    PriorityQueue.prototype.clone = function () {
+        return new PriorityQueue({ nodes: this.nodes, comparator: this._comparator });
+    };
+    // --- start additional methods ---
+    /**
+     * The `isValid` function recursively checks if a binary tree satisfies a certain condition.
+     * @returns The function `isValid()` returns a boolean value.
+     */
+    PriorityQueue.prototype.isValid = function () {
+        for (var i = 0; i < this.nodes.length; i++) {
+            var leftChildIndex = this._getLeft(i);
+            var rightChildIndex = this._getRight(i);
+            if (this._isValidIndex(leftChildIndex) && !this._compare(leftChildIndex, i)) {
+                return false;
+            }
+            if (this._isValidIndex(rightChildIndex) && !this._compare(rightChildIndex, i)) {
+                return false;
+            }
+        }
+        return true;
+    };
+    /**
+     * Plan to support sorting of duplicate elements.
+     */
+    /**
+     * The function sorts the elements in a data structure and returns them in an array.
+     * Plan to support sorting of duplicate elements.
+     * @returns The `sort()` method is returning an array of type `T[]`.
+     */
+    PriorityQueue.prototype.sort = function () {
+        // TODO Plan to support sorting of duplicate elements.
+        var visitedNode = [];
+        while (this.size !== 0) {
+            var top = this.poll();
+            if (top)
+                visitedNode.push(top);
+        }
+        return visitedNode;
+    };
+    /**
+     * The DFS function performs a depth-first search traversal on a binary tree and returns an array of visited nodes
+     * based on the specified traversal order.
+     * @param {PriorityQueueDFSOrderPattern} dfsMode - The dfsMode parameter is a string that specifies the order in which
+     * the nodes should be visited during the Depth-First Search (DFS) traversal. It can have one of the following values:
+     * @returns an array of type `(T | null)[]`.
+     */
+    PriorityQueue.prototype.DFS = function (dfsMode) {
+        var _this = this;
+        var visitedNode = [];
+        var traverse = function (cur) {
+            var _a, _b, _c;
+            var leftChildIndex = _this._getLeft(cur);
+            var rightChildIndex = _this._getRight(cur);
+            switch (dfsMode) {
+                case 'in':
+                    _this._isValidIndex(leftChildIndex) && traverse(leftChildIndex);
+                    visitedNode.push((_a = _this.nodes[cur]) !== null && _a !== void 0 ? _a : null);
+                    _this._isValidIndex(rightChildIndex) && traverse(rightChildIndex);
+                    break;
+                case 'pre':
+                    visitedNode.push((_b = _this.nodes[cur]) !== null && _b !== void 0 ? _b : null);
+                    _this._isValidIndex(leftChildIndex) && traverse(leftChildIndex);
+                    _this._isValidIndex(rightChildIndex) && traverse(rightChildIndex);
+                    break;
+                case 'post':
+                    _this._isValidIndex(leftChildIndex) && traverse(leftChildIndex);
+                    _this._isValidIndex(rightChildIndex) && traverse(rightChildIndex);
+                    visitedNode.push((_c = _this.nodes[cur]) !== null && _c !== void 0 ? _c : null);
+                    break;
+            }
+        };
+        this._isValidIndex(0) && traverse(0);
+        return visitedNode;
+    };
+    PriorityQueue.prototype._setNodes = function (value) {
+        this._nodes = value;
+    };
+    /**
+     * The function compares two numbers using a custom comparator function.
+     * @param {number} a - The parameter "a" is a number that represents the index of a node in an array.
+     * @param {number} b - The parameter "b" is a number.
+     * @returns the result of the comparison between the elements at indices `a` and `b` in the `nodes` array. The
+     * comparison is done using the `_comparator` function, and if the result is greater than 0, `true` is returned,
+     * indicating that the element at index `a` is greater than the element at index `b`.
+     */
+    PriorityQueue.prototype._compare = function (a, b) {
+        return this._comparator(this.nodes[a], this.nodes[b]) > 0;
+    };
+    /**
+     * The function swaps two elements in an array.
+     * @param {number} a - The parameter "a" is a number that represents the index of an element in an array.
+     * @param {number} b - The parameter "b" is a number.
+     */
+    PriorityQueue.prototype._swap = function (a, b) {
+        var temp = this.nodes[a];
+        this.nodes[a] = this.nodes[b];
+        this.nodes[b] = temp;
+    };
+    /**
+     * The function checks if a given index is valid within an array.
+     * @param {number} index - The parameter "index" is of type number and represents the index value that needs to be
+     * checked for validity.
+     * @returns A boolean value indicating whether the given index is valid or not.
+     */
+    PriorityQueue.prototype._isValidIndex = function (index) {
+        return index > -1 && index < this.nodes.length;
+    };
+    /**
+     * The function returns the index of the parent node given the index of a child node in a binary tree.
+     * @param {number} child - The "child" parameter is a number representing the index of a child node in a binary tree.
+     * @returns the parent of the given child node.
+     */
+    PriorityQueue.prototype._getParent = function (child) {
+        return Math.floor((child - 1) / 2);
+    };
+    /**
+     * The function returns the index of the left child node in a binary tree given the index of its parent node.
+     * @param {number} parent - The parameter "parent" is a number that represents the index of a node in a binary tree.
+     * @returns the left child of a given parent node in a binary tree.
+     */
+    PriorityQueue.prototype._getLeft = function (parent) {
+        return (2 * parent) + 1;
+    };
+    /**
+     * The function returns the index of the right child node in a binary tree given the index of its parent node.
+     * @param {number} parent - The parameter "parent" is a number that represents the index of a node in a binary tree.
+     * @returns the right child of a given parent node in a binary tree.
+     */
+    PriorityQueue.prototype._getRight = function (parent) {
+        return (2 * parent) + 2;
+    };
+    /**
+     * The function returns the index of the smallest child node of a given parent node.
+     * @param {number} parent - The parent parameter is a number that represents the index of the parent node in a binary
+     * tree.
+     * @returns the minimum value between the parent node and its left and right child nodes.
+     */
+    PriorityQueue.prototype._getComparedChild = function (parent) {
+        var min = parent;
+        var left = this._getLeft(parent), right = this._getRight(parent);
+        if (left < this.size && this._compare(min, left)) {
+            min = left;
+        }
+        if (right < this.size && this._compare(min, right)) {
+            min = right;
+        }
+        return min;
+    };
+    /**
+     * The function `_heapifyUp` is used to maintain the heap property by moving an element up the heap until it is in the
+     * correct position.
+     * @param {number} start - The start parameter is the index of the element that needs to be moved up in the heap.
+     */
+    PriorityQueue.prototype._heapifyUp = function (start) {
+        while (start > 0 && this._compare(this._getParent(start), start)) {
+            var parent = this._getParent(start);
+            this._swap(start, parent);
+            start = parent;
+        }
+    };
+    /**
+     * The function performs a heapify operation by comparing and swapping elements in a binary heap.
+     * @param {number} start - The start parameter is the index of the element in the heap from where the heapifyDown
+     * operation should start.
+     */
+    PriorityQueue.prototype._heapifyDown = function (start) {
+        var min = this._getComparedChild(start);
+        while (this._compare(start, min)) {
+            this._swap(min, start);
+            start = min;
+            min = this._getComparedChild(start);
+        }
+    };
+    /**
+     * The _fix function performs a heapify operation on the elements of the heap starting from the middle and moving
+     * towards the root.
+     */
+    PriorityQueue.prototype._fix = function () {
+        for (var i = Math.floor(this.size / 2); i > -1; i--)
+            this._heapifyDown(i);
+    };
+    return PriorityQueue;
+}());
+exports.PriorityQueue = PriorityQueue;

package/jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    testMatch: ['<rootDir>/tests/**/*.test.ts'],
+};

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "priority-queue-typed",
+  "version": "1.19.3",
+  "description": "Priority Queue, Min Priority Queue, Max Priority Queue. Javascript & Typescript Data Structure.",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "rm -rf dist && npx tsc",
+    "test": "jest",
+    "build:docs": "typedoc --out docs ./src",
+    "deps:check": "dependency-cruiser src",
+    "build:publish": "npm run build && npm run build:docs && npm publish"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zrwusa/data-structure-typed"
+  },
+  "keywords": [
+    "Priority queue",
+    "Heap data structure",
+    "Binary heap",
+    "Priority management",
+    "Insertion",
+    "Deletion",
+    "Heap property",
+    "Complete binary tree",
+    "Heapify",
+    "Extract min/max",
+    "Heap operations",
+    "Data structure",
+    "Efficient priority handling",
+    "Ordering property",
+    "Heap operations complexity",
+    "Binary tree",
+    "Data management",
+    "Dynamic resizing",
+    "Priority-based processing",
+    "Data sorting",
+    "Element priority",
+    "Queue with priorities"
+  ],
+  "author": "Tyler Zeng zrwusa@gmail.com",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/zrwusa/data-structure-typed/issues"
+  },
+  "homepage": "https://github.com/zrwusa/data-structure-typed#readme",
+  "types": "dist/index.d.ts",
+  "devDependencies": {
+    "@types/jest": "^29.5.3",
+    "@types/node": "^20.4.9",
+    "dependency-cruiser": "^13.1.2",
+    "jest": "^29.6.2",
+    "ts-jest": "^29.1.1",
+    "typedoc": "^0.24.8",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "data-structure-typed": "^1.19.3",
+    "zod": "^3.22.2"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,37 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "./dist",
+    "module": "commonjs",
+    "target": "es5",
+    "lib": [
+      "esnext",
+    ],
+    "strict": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "declarationDir": "./dist",
+    "skipLibCheck": true,
+    "downlevelIteration": true,
+    "experimentalDecorators": true,
+    //    "allowJs": true,
+    //    "allowSyntheticDefaultImports": true,
+    //    "forceConsistentCasingInFileNames": true,
+    //    "noFallthroughCasesInSwitch": true,
+    //    "resolveJsonModule": true,
+    //    "isolatedModules": true,
+    //    "noEmit": true,
+    "typeRoots": [
+      "node_modules/@types"
+    ]
+  },
+
+  "include": [
+    "src",
+  ],
+  "exclude": [
+//    "node_modules/data-structure-typed",
+    "node_modules",
+    "dist"
+  ]
+}