data-structure-typed 1.35.0 → 1.40.0-rc

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

@@ -2,6 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Heap = exports.HeapItem = void 0;
 class HeapItem {
+    /**
+     * The constructor function initializes an instance of a class with a priority and a value.
+     * @param {number} priority - The `priority` parameter is a number that represents the priority of the value. It is
+     * optional and has a default value of `NaN`.
+     * @param {V | null} [val=null] - The `val` parameter is of type `V | null`, which means it can accept a value of type
+     * `V` or `null`.
+     */
     constructor(priority = Number.MAX_SAFE_INTEGER, val = null) {
         this._val = val;
         this._priority = priority;
@@ -21,6 +28,11 @@ class HeapItem {
 }
 exports.HeapItem = HeapItem;
 class Heap {
+    /**
+     * The function is a constructor for a class that initializes a priority callback function based on the
+     * options provided.
+     * @param [options] - An optional object that contains configuration options for the Heap.
+     */
     constructor(options) {
         if (options) {
             const { priorityExtractor } = options;
@@ -39,27 +51,57 @@ class Heap {
     get priorityExtractor() {
         return this._priorityExtractor;
     }
+    /**
+     * The function returns the size of a priority queue.
+     * @returns The size of the priority queue.
+     */
     get size() {
         return this._pq.size;
     }
+    /**
+     * The function checks if a priority queue is empty.
+     * @returns {boolean} A boolean value indicating whether the size of the priority queue is less than 1.
+     */
     isEmpty() {
         return this._pq.size < 1;
     }
+    /**
+     * The `peek` function returns the top item in the priority queue without removing it.
+     * @returns The `peek()` method is returning either a `HeapItem<V>` object or `null`.Returns an val with the highest priority in the queue
+     */
     peek(isItem) {
         isItem = isItem !== null && isItem !== void 0 ? isItem : false;
         const peeked = this._pq.peek();
         return isItem ? peeked : peeked === null || peeked === void 0 ? void 0 : peeked.val;
     }
+    /**
+     * The `peekLast` function returns the last item in the heap.
+     * @returns The method `peekLast()` returns either a `HeapItem<V>` object or `null`.Returns an val with the lowest priority in the queue
+     */
     peekLast(isItem) {
         isItem = isItem !== null && isItem !== void 0 ? isItem : false;
         const leafItem = this._pq.leaf();
         return isItem ? leafItem : leafItem === null || leafItem === void 0 ? void 0 : leafItem.val;
     }
+    /**
+     * The `add` function adds an val to a priority queue with an optional priority value.
+     * @param {V} val - The `val` parameter represents the value that you want to add to the heap. It can be of any
+     * type.
+     * @param {number} [priority] - The `priority` parameter is an optional number that represents the priority of the
+     * val being added to the heap. If the `val` parameter is a number, then the `priority` parameter is set to
+     * the value of `val`. If the `val` parameter is not a number, then the
+     * @returns The `add` method returns the instance of the `Heap` class.
+     * @throws {Error} if priority is not a valid number
+     */
     add(priority, val) {
         val = val === undefined ? priority : val;
         this._pq.add(new HeapItem(priority, val));
         return this;
     }
+    /**
+     * The `poll` function returns the top item from a priority queue or null if the queue is empty.Removes and returns an val with the highest priority in the queue
+     * @returns either a HeapItem<V> object or null.
+     */
     poll(isItem) {
         isItem = isItem !== null && isItem !== void 0 ? isItem : false;
         const top = this._pq.poll();
@@ -68,6 +110,11 @@ class Heap {
         }
         return isItem ? top : top.val;
     }
+    /**
+     * The function checks if a given node or value exists in the priority queue.
+     * @param {V | HeapItem<V>} node - The parameter `node` can be of type `V` or `HeapItem<V>`.
+     * @returns a boolean value.
+     */
     has(node) {
         if (node instanceof HeapItem) {
             return this.pq.getNodes().includes(node);
@@ -78,16 +125,31 @@ class Heap {
             }) !== -1);
         }
     }
+    /**
+     * The `toArray` function returns an array of `HeapItem<V>` objects.
+     * @returns An array of HeapItem<V> objects.Returns a sorted list of vals
+     */
     toArray(isItem) {
         isItem = isItem !== null && isItem !== void 0 ? isItem : false;
         const itemArray = this._pq.toArray();
         return isItem ? itemArray : itemArray.map(item => item.val);
     }
+    /**
+     * The function sorts the elements in the priority queue and returns either the sorted items or their values depending
+     * on the value of the isItem parameter.
+     * @param {boolean} [isItem] - The `isItem` parameter is a boolean flag that indicates whether the sorted result should
+     * be an array of `HeapItem<V>` objects or an array of the values (`V`) of those objects. If `isItem` is `true`, the
+     * sorted result will be an array of `HeapItem
+     * @returns an array of either `HeapItem<V>`, `null`, `V`, or `undefined` values.
+     */
     sort(isItem) {
         isItem = isItem !== null && isItem !== void 0 ? isItem : false;
         const sorted = this._pq.sort();
         return isItem ? sorted : sorted.map(item => item.val);
     }
+    /**
+     * The clear function clears the priority queue.
+     */
     clear() {
         this._pq.clear();
     }

package/dist/data-structures/heap/heap.js.map

@@ -1 +1 @@
-{"version":3,"file":"heap.js","sourceRoot":"","sources":["../../../src/data-structures/heap/heap.ts"],"names":[],"mappings":";;;AAUA,MAAa,QAAQ;IAQnB,YAAY,WAAmB,MAAM,CAAC,gBAAgB,EAAE,MAAgB,IAAI;QAC1E,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAID,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAI,QAAQ,CAAC,KAAa;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;IAID,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,IAAI,GAAG,CAAC,KAAe;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;IACpB,CAAC;CACF;AAhCD,4BAgCC;AAED,MAAsB,IAAI;IAMxB,YAAsB,OAAwB;QAC5C,IAAI,OAAO,EAAE;YACX,MAAM,EAAC,iBAAiB,EAAC,GAAG,OAAO,CAAC;YACpC,IAAI,iBAAiB,KAAK,SAAS,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE;gBAC9E,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;aACnE;YACD,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;SAC5D;aAAM;YACL,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;SACrC;IACH,CAAC;IAID,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAGD,IAAI,iBAAiB;QACnB,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACjC,CAAC;IAMD,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;IACvB,CAAC;IAMD,OAAO;QACL,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC;IAC3B,CAAC;IAUD,IAAI,CAAC,MAAgB;QACnB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,CAAC;QACzB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAE/B,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,CAAC;IACvC,CAAC;IAUD,QAAQ,CAAC,MAAgB;QACvB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAEjC,OAAO,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,GAAG,CAAC;IAC3C,CAAC;IAYD,GAAG,CAAC,QAAgB,EAAE,GAAO;QAC3B,GAAG,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAE,QAAyB,CAAC,CAAC,CAAC,GAAG,CAAC;QAC3D,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAI,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;QAE7C,OAAO,IAAI,CAAC;IACd,CAAC;IAUD,IAAI,CAAC,MAAgB;QACnB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,CAAC;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAC5B,IAAI,CAAC,GAAG,EAAE;YACR,OAAO,IAAI,CAAC;SACb;QAED,OAAO,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAChC,CAAC;IAOD,GAAG,CAAC,IAAqB;QACvB,IAAI,IAAI,YAAY,QAAQ,EAAE;YAC5B,OAAO,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;SAC1C;aAAM;YACL,OAAO,CACL,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;gBAClC,OAAO,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC;YAC3B,CAAC,CAAC,KAAK,CAAC,CAAC,CACV,CAAC;SACH;IACH,CAAC;IAUD,OAAO,CAAC,MAAgB;QACtB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,CAAC;QACzB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QAErC,OAAO,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9D,CAAC;IAcD,IAAI,CAAC,MAAgB;QACnB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,CAAC;QACzB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAE/B,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxD,CAAC;IAKD,KAAK;QACH,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;IACnB,CAAC;CACF;AAvKD,oBAuKC"}
+{"version":3,"file":"heap.js","sourceRoot":"","sources":["../../../src/data-structures/heap/heap.ts"],"names":[],"mappings":";;;AAUA,MAAa,QAAQ;IACnB;;;;;;OAMG;IACH,YAAY,WAAmB,MAAM,CAAC,gBAAgB,EAAE,MAAgB,IAAI;QAC1E,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAID,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAI,QAAQ,CAAC,KAAa;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;IAID,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,IAAI,GAAG,CAAC,KAAe;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC;IACpB,CAAC;CACF;AAhCD,4BAgCC;AAED,MAAsB,IAAI;IACxB;;;;OAIG;IACH,YAAsB,OAAwB;QAC5C,IAAI,OAAO,EAAE;YACX,MAAM,EAAC,iBAAiB,EAAC,GAAG,OAAO,CAAC;YACpC,IAAI,iBAAiB,KAAK,SAAS,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE;gBAC9E,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;aACnE;YACD,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;SAC5D;aAAM;YACL,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;SACrC;IACH,CAAC;IAID,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAGD,IAAI,iBAAiB;QACnB,OAAO,IAAI,CAAC,kBAAkB,CAAC;IACjC,CAAC;IAED;;;OAGG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC;IAC3B,CAAC;IAMD;;;OAGG;IACH,IAAI,CAAC,MAAgB;QACnB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,CAAC;QACzB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAE/B,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,CAAC;IACvC,CAAC;IAMD;;;OAGG;IACH,QAAQ,CAAC,MAAgB;QACvB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAEjC,OAAO,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,GAAG,CAAC;IAC3C,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,QAAgB,EAAE,GAAO;QAC3B,GAAG,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAE,QAAyB,CAAC,CAAC,CAAC,GAAG,CAAC;QAC3D,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAI,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;QAE7C,OAAO,IAAI,CAAC;IACd,CAAC;IAMD;;;OAGG;IACH,IAAI,CAAC,MAAgB;QACnB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,CAAC;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAC5B,IAAI,CAAC,GAAG,EAAE;YACR,OAAO,IAAI,CAAC;SACb;QAED,OAAO,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,IAAqB;QACvB,IAAI,IAAI,YAAY,QAAQ,EAAE;YAC5B,OAAO,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;SAC1C;aAAM;YACL,OAAO,CACL,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;gBAClC,OAAO,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC;YAC3B,CAAC,CAAC,KAAK,CAAC,CAAC,CACV,CAAC;SACH;IACH,CAAC;IAMD;;;OAGG;IACH,OAAO,CAAC,MAAgB;QACtB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,CAAC;QACzB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QAErC,OAAO,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9D,CAAC;IAMD;;;;;;;OAOG;IACH,IAAI,CAAC,MAAgB;QACnB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,KAAK,CAAC;QACzB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAE/B,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACH,KAAK;QACH,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;IACnB,CAAC;CACF;AAvKD,oBAuKC"}

package/dist/data-structures/heap/index.d.ts

@@ -0,0 +1,3 @@
+export * from './max-heap';
+export * from './min-heap';
+export * from './heap';

package/dist/data-structures/heap/max-heap.d.ts

@@ -0,0 +1,23 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import { Heap, HeapItem } from './heap';
+import { PriorityQueue } from '../priority-queue';
+import type { HeapOptions } from '../../types';
+/**
+ * @class MaxHeap
+ * @extends Heap
+ */
+export declare class MaxHeap<V = any> extends Heap<V> {
+    protected _pq: PriorityQueue<HeapItem<V>>;
+    /**
+     * The constructor initializes a PriorityQueue with a custom comparator function.
+     * @param [options] - The `options` parameter is an optional object that can be passed to the constructor. It is of
+     * type `HeapOptions<V>`, which is a generic type that represents the options for the heap.
+     */
+    constructor(options?: HeapOptions<V>);
+}

package/dist/data-structures/heap/max-heap.js

@@ -1,9 +1,25 @@
 "use strict";
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MaxHeap = void 0;
 const heap_1 = require("./heap");
 const priority_queue_1 = require("../priority-queue");
+/**
+ * @class MaxHeap
+ * @extends Heap
+ */
 class MaxHeap extends heap_1.Heap {
+    /**
+     * The constructor initializes a PriorityQueue with a custom comparator function.
+     * @param [options] - The `options` parameter is an optional object that can be passed to the constructor. It is of
+     * type `HeapOptions<V>`, which is a generic type that represents the options for the heap.
+     */
     constructor(options) {
         super(options);
         this._pq = new priority_queue_1.PriorityQueue({

package/dist/data-structures/heap/max-heap.js.map

@@ -1 +1 @@
-{"version":3,"file":"max-heap.js","sourceRoot":"","sources":["../../../src/data-structures/heap/max-heap.ts"],"names":[],"mappings":";;;AAQA,iCAAsC;AACtC,sDAAgD;AAOhD,MAAa,OAAiB,SAAQ,WAAO;IAQ3C,YAAY,OAAwB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,IAAI,8BAAa,CAAc;YACxC,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ;SAC9C,CAAC,CAAC;IACL,CAAC;CACF;AAdD,0BAcC"}
+{"version":3,"file":"max-heap.js","sourceRoot":"","sources":["../../../src/data-structures/heap/max-heap.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAEH,iCAAsC;AACtC,sDAAgD;AAGhD;;;GAGG;AACH,MAAa,OAAiB,SAAQ,WAAO;IAG3C;;;;OAIG;IACH,YAAY,OAAwB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,IAAI,8BAAa,CAAc;YACxC,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ;SAC9C,CAAC,CAAC;IACL,CAAC;CACF;AAdD,0BAcC"}

package/dist/data-structures/heap/min-heap.d.ts

@@ -0,0 +1,24 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import { Heap, HeapItem } from './heap';
+import { PriorityQueue } from '../priority-queue';
+import type { HeapOptions } from '../../types';
+/**
+ * @class MinHeap
+ * @extends Heap
+ */
+export declare class MinHeap<V = any> extends Heap<V> {
+    protected _pq: PriorityQueue<HeapItem<V>>;
+    /**
+     * The constructor initializes a PriorityQueue with a comparator function that compares the priority of two HeapItem
+     * objects.
+     * @param [options] - The `options` parameter is an optional object that can be passed to the constructor. It is of
+     * type `HeapOptions<V>`, which is a generic type that represents the options for the heap.
+     */
+    constructor(options?: HeapOptions<V>);
+}

package/dist/data-structures/heap/min-heap.js

@@ -1,9 +1,26 @@
 "use strict";
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MinHeap = void 0;
 const heap_1 = require("./heap");
 const priority_queue_1 = require("../priority-queue");
+/**
+ * @class MinHeap
+ * @extends Heap
+ */
 class MinHeap extends heap_1.Heap {
+    /**
+     * The constructor initializes a PriorityQueue with a comparator function that compares the priority of two HeapItem
+     * objects.
+     * @param [options] - The `options` parameter is an optional object that can be passed to the constructor. It is of
+     * type `HeapOptions<V>`, which is a generic type that represents the options for the heap.
+     */
     constructor(options) {
         super(options);
         this._pq = new priority_queue_1.PriorityQueue({

package/dist/data-structures/heap/min-heap.js.map

@@ -1 +1 @@
-{"version":3,"file":"min-heap.js","sourceRoot":"","sources":["../../../src/data-structures/heap/min-heap.ts"],"names":[],"mappings":";;;AAQA,iCAAsC;AACtC,sDAAgD;AAOhD,MAAa,OAAiB,SAAQ,WAAO;IAS3C,YAAY,OAAwB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,IAAI,8BAAa,CAAc;YACxC,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ;SAC9C,CAAC,CAAC;IACL,CAAC;CACF;AAfD,0BAeC"}
+{"version":3,"file":"min-heap.js","sourceRoot":"","sources":["../../../src/data-structures/heap/min-heap.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAEH,iCAAsC;AACtC,sDAAgD;AAGhD;;;GAGG;AACH,MAAa,OAAiB,SAAQ,WAAO;IAG3C;;;;;OAKG;IACH,YAAY,OAAwB;QAClC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,GAAG,GAAG,IAAI,8BAAa,CAAc;YACxC,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ;SAC9C,CAAC,CAAC;IACL,CAAC;CACF;AAfD,0BAeC"}

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

@@ -0,0 +1,11 @@
+export * from './hash';
+export * from './linked-list';
+export * from './stack';
+export * from './queue';
+export * from './graph';
+export * from './binary-tree';
+export * from './tree';
+export * from './heap';
+export * from './priority-queue';
+export * from './matrix';
+export * from './trie';

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

@@ -0,0 +1,234 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+export declare class DoublyLinkedListNode<E = any> {
+    /**
+     * The constructor function initializes the value, next, and previous properties of an object.
+     * @param {E} val - The "val" parameter is the value that will be stored in the node. It can be of any data type, as it
+     * is defined as a generic type "E".
+     */
+    constructor(val: E);
+    private _val;
+    get val(): E;
+    set val(value: E);
+    private _next;
+    get next(): DoublyLinkedListNode<E> | null;
+    set next(value: DoublyLinkedListNode<E> | null);
+    private _prev;
+    get prev(): DoublyLinkedListNode<E> | null;
+    set prev(value: DoublyLinkedListNode<E> | null);
+}
+export declare class DoublyLinkedList<E = any> {
+    /**
+     * The constructor initializes the linked list with an empty head, tail, and length.
+     */
+    constructor();
+    private _head;
+    get head(): DoublyLinkedListNode<E> | null;
+    set head(value: DoublyLinkedListNode<E> | null);
+    private _tail;
+    get tail(): DoublyLinkedListNode<E> | null;
+    set tail(value: DoublyLinkedListNode<E> | null);
+    private _length;
+    get length(): number;
+    /**
+     * The `fromArray` function creates a new instance of a DoublyLinkedList and populates it with the elements from the
+     * given array.
+     * @param {E[]} data - The `data` parameter is an array of elements of type `E`.
+     * @returns The `fromArray` function returns a DoublyLinkedList object.
+     */
+    static fromArray<E>(data: E[]): DoublyLinkedList<E>;
+    /**
+     * The push function adds a new node with the given value to the end of the doubly linked list.
+     * @param {E} val - The value to be added to the linked list.
+     */
+    push(val: E): void;
+    /**
+     * The addLast function adds a new node with the given value to the end of the doubly linked list.
+     * @param {E} val - The value to be added to the linked list.
+     */
+    addLast(val: E): void;
+    /**
+     * The `pop()` function removes and returns the value of the last node in a doubly linked list.
+     * @returns The method is returning the value of the removed node (removedNode.val) if the list is not empty. If the
+     * list is empty, it returns null.
+     */
+    pop(): E | undefined;
+    /**
+     * The `pollLast()` function removes and returns the value of the last node in a doubly linked list.
+     * @returns The method is returning the value of the removed node (removedNode.val) if the list is not empty. If the
+     * list is empty, it returns null.
+     */
+    pollLast(): E | undefined;
+    /**
+     * The `shift()` function removes and returns the value of the first node in a doubly linked list.
+     * @returns The method `shift()` returns the value of the node that is removed from the beginning of the doubly linked
+     * list.
+     */
+    shift(): E | undefined;
+    /**
+     * The `pollFirst()` function removes and returns the value of the first node in a doubly linked list.
+     * @returns The method `shift()` returns the value of the node that is removed from the beginning of the doubly linked
+     * list.
+     */
+    pollFirst(): E | undefined;
+    /**
+     * The unshift function adds a new node with the given value to the beginning of a doubly linked list.
+     * @param {E} val - The `val` parameter represents the value of the new node that will be added to the beginning of the
+     * doubly linked list.
+     */
+    unshift(val: E): void;
+    /**
+     * The addFirst function adds a new node with the given value to the beginning of a doubly linked list.
+     * @param {E} val - The `val` parameter represents the value of the new node that will be added to the beginning of the
+     * doubly linked list.
+     */
+    addFirst(val: E): void;
+    /**
+     * The `peekFirst` function returns the first node in a doubly linked list, or null if the list is empty.
+     * @returns The method `peekFirst()` returns the first node of the doubly linked list, or `null` if the list is empty.
+     */
+    peekFirst(): E | undefined;
+    /**
+     * The `peekLast` function returns the last node in a doubly linked list, or null if the list is empty.
+     * @returns The method `peekLast()` returns the last node of the doubly linked list, or `null` if the list is empty.
+     */
+    peekLast(): E | undefined;
+    get size(): number;
+    /**
+     * The `getAt` function returns the value at a specified index in a linked list, or null if the index is out of bounds.
+     * @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 is returning the value at the specified index in the linked list. If the index is out of bounds
+     * or the linked list is empty, it will return null.
+     */
+    getAt(index: number): E | undefined;
+    /**
+     * The function `getNodeAt` returns the node at a given index in a doubly 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 node we want to
+     * retrieve from the doubly linked list. It indicates the zero-based index of the node we want to access.
+     * @returns The method `getNodeAt(index: number)` returns a `DoublyLinkedListNode<E>` object if the index is within the
+     * valid range of the linked list, otherwise it returns `null`.
+     */
+    getNodeAt(index: number): DoublyLinkedListNode<E> | null;
+    /**
+     * The function `findNodeByValue` searches for a node with a specific value in a doubly linked list and returns the
+     * node if found, otherwise it returns null.
+     * @param {E} val - The `val` parameter is the value that we want to search for in the doubly linked list.
+     * @returns The function `findNodeByValue` returns a `DoublyLinkedListNode<E>` if a node with the specified value `val`
+     * is found in the linked list. If no such node is found, it returns `null`.
+     */
+    findNode(val: E): DoublyLinkedListNode<E> | null;
+    /**
+     * The `insert` function inserts a value at a specified index in a doubly linked list.
+     * @param {number} index - The index parameter represents the position at which the new value should be inserted in the
+     * DoublyLinkedList. It is of type number.
+     * @param {E} val - The `val` parameter represents the value that you want to insert into the Doubly 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: E): boolean;
+    /**
+     * 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): E | undefined;
+    delete(valOrNode: E): boolean;
+    delete(valOrNode: DoublyLinkedListNode<E>): boolean;
+    /**
+     * The `toArray` function converts a linked list into an array.
+     * @returns The `toArray()` method is returning an array of type `E[]`.
+     */
+    toArray(): E[];
+    /**
+     * The function checks if a variable has a length greater than zero and returns a boolean value.
+     * @returns A boolean value is being returned.
+     */
+    isEmpty(): boolean;
+    /**
+     * The `clear` function resets the linked list by setting the head, tail, and length to null and 0 respectively.
+     */
+    clear(): 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 E 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: E) => boolean): E | null;
+    /**
+     * The function returns the index of the first occurrence of a given value in a linked list.
+     * @param {E} val - The parameter `val` is of type `E`, which means it can be any data type. It represents the value
+     * that we are searching for in the linked list.
+     * @returns The method `indexOf` returns the index of the first occurrence of the specified value `val` in the linked
+     * list. If the value is not found, it returns -1.
+     */
+    indexOf(val: E): number;
+    /**
+     * The `findLast` function iterates through a linked list from the last node to the first node and returns the last
+     * value that satisfies the given callback function, or null if no value satisfies the callback.
+     * @param callback - A function that takes a value of type E as its parameter and returns a boolean value. This
+     * function is used to determine whether a given value satisfies a certain condition.
+     * @returns The method `findLast` returns the last value in the linked list that satisfies the condition specified by
+     * the callback function. If no value satisfies the condition, it returns `null`.
+     */
+    findLast(callback: (val: E) => boolean): E | null;
+    /**
+     * The `toArrayReverse` function converts a doubly linked list into an array in reverse order.
+     * @returns The `toArrayReverse()` function returns an array of type `E[]`.
+     */
+    toArrayReverse(): E[];
+    /**
+     * The `reverse` function reverses the order of the elements in a doubly linked list.
+     */
+    reverse(): void;
+    /**
+     * The `forEach` function iterates over each element in a linked list and applies a callback function to each element.
+     * @param callback - The callback parameter is a function that takes two arguments: val and index. The val argument
+     * represents the value of the current node in the linked list, and the index argument represents the index of the
+     * current node in the linked list.
+     */
+    forEach(callback: (val: E, index: number) => void): void;
+    /**
+     * The `map` function takes a callback function and applies it to each element in the DoublyLinkedList, returning a new
+     * DoublyLinkedList with the transformed values.
+     * @param callback - The callback parameter is a function that takes a value of type E (the type of values stored in
+     * the original DoublyLinkedList) and returns a value of type U (the type of values that will be stored in the mapped
+     * DoublyLinkedList).
+     * @returns The `map` function is returning a new instance of `DoublyLinkedList<U>` that contains the mapped values.
+     */
+    map<U>(callback: (val: E) => U): DoublyLinkedList<U>;
+    /**
+     * The `filter` function iterates through a DoublyLinkedList and returns a new DoublyLinkedList containing only the
+     * elements that satisfy the given callback function.
+     * @param callback - The `callback` parameter is a function that takes a value of type `E` and returns a boolean value.
+     * It is used to determine whether a value should be included in the filtered list or not.
+     * @returns The filtered list, which is an instance of the DoublyLinkedList class.
+     */
+    filter(callback: (val: E) => boolean): DoublyLinkedList<E>;
+    /**
+     * The `reduce` function iterates over a linked list and applies a callback function to each element, accumulating a
+     * single value.
+     * @param callback - The `callback` parameter is a function that takes two arguments: `accumulator` and `val`. It is
+     * used to perform a specific operation on each element of the linked list.
+     * @param {U} initialValue - The `initialValue` parameter is the initial value of the accumulator. It is the starting
+     * point for the reduction operation.
+     * @returns The `reduce` method is returning the final value of the accumulator after iterating through all the
+     * elements in the linked list.
+     */
+    reduce<U>(callback: (accumulator: U, val: E) => U, initialValue: U): U;
+    insertAfter(existingValueOrNode: E, newValue: E): boolean;
+    insertAfter(existingValueOrNode: DoublyLinkedListNode<E>, newValue: E): boolean;
+    insertBefore(existingValueOrNode: E, newValue: E): boolean;
+    insertBefore(existingValueOrNode: DoublyLinkedListNode<E>, newValue: E): boolean;
+}