directed-graph-typed 1.46.2 → 1.46.5

package/src/data-structures/queue/deque.ts

@@ -7,8 +7,8 @@
  */
 
 
-import { IterableWithSizeOrLength, IterateDirection } from "../../types";
-import { calcMinUnitsRequired, rangeCheck, throwRangeError } from "../../utils";
+import { IterableWithSizeOrLength } from "../../types";
+import { calcMinUnitsRequired, rangeCheck } from "../../utils";
 
 /**
  * Deque can provide random access with O(1) time complexity
@@ -17,89 +17,6 @@ import { calcMinUnitsRequired, rangeCheck, throwRangeError } from "../../utils";
  * Deque is implemented using a dynamic array. Inserting or deleting beyond both ends of the array may require moving elements or reallocating space.
  */
 
-export class DequeIterator<E> {
-  iterateDirection: IterateDirection;
-
-  index: number;
-  readonly deque: Deque<E>;
-
-  /**
-   * The constructor initializes the index, iterate direction, and prev/next functions for a
-   * DequeIterator object.
-   * @param {number} index - The index parameter represents the current index position of the iterator
-   * within the deque. It is a number that indicates the position of the element that the iterator is
-   * currently pointing to.
-   * @param deque - The `deque` parameter is an instance of the `Deque` class. It represents a
-   * double-ended queue data structure, which allows elements to be added or removed from both ends.
-   * @param iterateDirection - The `iterateDirection` parameter is an optional parameter that specifies
-   * the direction in which the iterator should iterate over the elements of the `deque`. It has a
-   * default value of `IterateDirection.DEFAULT`.
-   * @returns The constructor is not returning anything. It is used to initialize the properties of the
-   * object being created.
-   */
-  constructor(index: number, deque: Deque<E>, iterateDirection = IterateDirection.DEFAULT) {
-    this.index = index;
-    this.iterateDirection = iterateDirection;
-    if (this.iterateDirection === IterateDirection.DEFAULT) {
-      this.prev = function () {
-        if (this.index === 0) {
-          throwRangeError();
-        }
-        this.index -= 1;
-        return this;
-      };
-      this.next = function () {
-        if (this.index === this.deque.size) {
-          throwRangeError();
-        }
-        this.index += 1;
-        return this;
-      };
-    } else {
-      this.prev = function () {
-        if (this.index === this.deque.size - 1) {
-          throwRangeError();
-        }
-        this.index += 1;
-        return this;
-      };
-      this.next = function () {
-        if (this.index === -1) {
-          throwRangeError();
-        }
-        this.index -= 1;
-        return this;
-      };
-    }
-    this.deque = deque;
-  }
-
-  get current() {
-    return this.deque.getAt(this.index);
-  }
-
-  set current(newElement: E) {
-    this.deque.setAt(this.index, newElement);
-  }
-
-  isAccessible() {
-    return this.index !== this.deque.size;
-  }
-
-  prev(): DequeIterator<E> {
-    return this;
-  }
-
-  next(): DequeIterator<E> {
-    return this;
-  }
-
-  clone() {
-    return new DequeIterator<E>(this.index, this.deque, this.iterateDirection);
-  }
-
-}
-
 export class Deque<E> {
   protected _bucketFirst = 0;
   protected _firstInBucket = 0;
@@ -123,7 +40,7 @@ export class Deque<E> {
     if ('length' in elements) {
       if (elements.length instanceof Function) _size = elements.length(); else _size = elements.length;
     } else {
-      if (elements.size instanceof Function) _size = elements.size();else _size = elements.size;
+      if (elements.size instanceof Function) _size = elements.size(); else _size = elements.size;
     }
 
     this._bucketSize = bucketSize;
@@ -245,38 +162,26 @@ export class Deque<E> {
   }
 
   /**
-   * The `begin()` function returns a new iterator for a deque starting from the first element.
-   * @returns A new instance of the DequeIterator class is being returned.
-   */
-  begin() {
-    return new DequeIterator<E>(0, this);
-  }
-
-  /**
-   * The `end()` function returns a new `DequeIterator` object with the size and reference to the
-   * current deque.
-   * @returns A new instance of the DequeIterator class is being returned.
+   * The below function is a generator that yields elements from a collection one by one.
    */
-  end() {
-    return new DequeIterator<E>(this.size, this);
-  }
-
-  /**
-   * The reverseBegin function returns a new DequeIterator object that starts at the last element of
-   * the deque and iterates in reverse direction.
-   * @returns A new instance of the DequeIterator class is being returned.
-   */
-  reverseBegin() {
-    return new DequeIterator<E>(this.size - 1, this, IterateDirection.REVERSE);
+  * begin(): Generator<E> {
+    let index = 0;
+    while (index < this.size) {
+      yield this.getAt(index);
+      index++;
+    }
   }
 
   /**
-   * The reverseEnd() function returns a new DequeIterator object that iterates over the elements of a
-   * Deque in reverse order.
-   * @returns A new instance of the DequeIterator class is being returned.
+   * The function `reverseBegin()` is a generator that yields elements in reverse order starting from
+   * the last element.
    */
-  reverseEnd() {
-    return new DequeIterator<E>(-1, this, IterateDirection.REVERSE);
+  * reverseBegin(): Generator<E> {
+    let index = this.size - 1;
+    while (index >= 0) {
+      yield this.getAt(index);
+      index--;
+    }
   }
 
   /**
@@ -431,7 +336,7 @@ export class Deque<E> {
    * @returns The element at the specified position in the data structure is being returned.
    */
   getAt(pos: number): E {
-    rangeCheck!(pos, 0, this.size - 1);
+    rangeCheck(pos, 0, this.size - 1);
     const {
       bucketIndex,
       indexInBucket
@@ -456,7 +361,7 @@ export class Deque<E> {
    * position in the data structure.
    */
   setAt(pos: number, element: E) {
-    rangeCheck!(pos, 0, this.size - 1);
+    rangeCheck(pos, 0, this.size - 1);
     const {
       bucketIndex,
       indexInBucket
@@ -486,7 +391,7 @@ export class Deque<E> {
    */
   insertAt(pos: number, element: E, num = 1) {
     const length = this.size;
-    rangeCheck!(pos, 0, length);
+    rangeCheck(pos, 0, length);
     if (pos === 0) {
       while (num--) this.unshift(element);
     } else if (pos === this.size) {
@@ -550,7 +455,7 @@ export class Deque<E> {
    * @returns The size of the data structure after the deletion operation is performed.
    */
   deleteAt(pos: number) {
-    rangeCheck!(pos, 0, this.size - 1);
+    rangeCheck(pos, 0, this.size - 1);
     if (pos === 0) this.shift();
     else if (pos === this.size - 1) this.pop();
     else {
@@ -605,50 +510,6 @@ export class Deque<E> {
     return this.size;
   }
 
-  /**
-   * Time Complexity: O(n)
-   * Space Complexity: O(1)
-   */
-
-  /**
-   * Time Complexity: O(n)
-   * Space Complexity: O(1)
-   *
-   * The function deletes an element from a deque using an iterator and returns the next iterator.
-   * @param iter - The parameter `iter` is of type `DequeIterator<E>`. It represents an iterator object
-   * that is used to iterate over elements in a deque (double-ended queue).
-   * @returns the updated iterator after deleting an element from the deque.
-   */
-  deleteByIterator(iter: DequeIterator<E>) {
-    const index = iter.index;
-    this.deleteAt(index);
-    iter = iter.next();
-    return iter;
-  }
-
-  /**
-   * Time Complexity: O(n)
-   * Space Complexity: O(1)
-   */
-
-  /**
-   * Time Complexity: O(n)
-   * Space Complexity: O(1)
-   *
-   * The function `findIterator` searches for an element in a deque and returns an iterator pointing to
-   * the element if found, otherwise it returns an iterator pointing to the end of the deque.
-   * @param {E} element - The `element` parameter is the element that you want to find in the deque.
-   * @returns The method `findIterator(element: E)` returns a `DequeIterator<E>` object.
-   */
-  findIterator(element: E) {
-    for (let i = 0; i < this.size; ++i) {
-      if (this.getAt(i) === element) {
-        return new DequeIterator<E>(i, this);
-      }
-    }
-    return this.end();
-  }
-
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(1)

package/src/types/data-structures/hash/hash-map.ts

@@ -4,3 +4,9 @@ export type HashMapLinkedNode<K, V> = {
   next: HashMapLinkedNode<K, V>;
   prev: HashMapLinkedNode<K, V>;
 };
+
+export type HashMapOptions<K, V> = {
+  elements: Iterable<[K, V]>;
+  hashFn: (key: K) => string;
+  objHashFn: (key: K) => object
+}

package/src/types/data-structures/hash/index.ts

@@ -1,8 +1,4 @@
-export * from './coordinate-map';
-export * from './coordinate-set';
 export * from './hash-map';
 export * from './hash-table';
-export * from './tree-map';
-export * from './tree-set';
 
 export type HashFunction<K> = (key: K) => number;

package/src/utils/utils.ts

@@ -93,7 +93,7 @@ export const throwRangeError = (message = 'The value is off-limits.'): void => {
   throw new RangeError(message);
 };
 
-export const isObjOrFunc = (input: unknown): input is Record<string, unknown> | ((...args: any[]) => any) => {
+export const isWeakKey = (input: unknown): input is object => {
   const inputType = typeof input;
   return (inputType === 'object' && input !== null) || inputType === 'function';
 };

package/dist/data-structures/hash/coordinate-map.d.ts

@@ -1,44 +0,0 @@
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-export declare class CoordinateMap<V> extends Map<any, V> {
-    constructor(joint?: string);
-    protected _joint: string;
-    get joint(): string;
-    /**
-     * The "has" function overrides the base class's "has" function and checks if a key exists in the map by joining the
-     * key array with a specified delimiter.
-     * @param {number[]} key - The parameter "key" is an array of numbers.
-     * @returns The `has` method is being overridden to return the result of calling the `has` method of the superclass
-     * (`super.has`) with the `key` array joined together using the `_joint` property.
-     */
-    has(key: number[]): boolean;
-    /**
-     * The function overrides the set method of a Map object to convert the key from an array to a string using a specified
-     * delimiter before calling the original set method.
-     * @param {number[]} key - The key parameter is an array of numbers.
-     * @param {V} value - The value parameter is the value that you want to associate with the specified key.
-     * @returns The `set` method is returning the result of calling the `set` method of the superclass
-     * (`super.set(key.join(this._joint), value)`).
-     */
-    set(key: number[], value: V): this;
-    /**
-     * The function overrides the get method to join the key array with a specified joint and then calls the super get
-     * method.
-     * @param {number[]} key - An array of numbers
-     * @returns The code is returning the value associated with the specified key in the map.
-     */
-    get(key: number[]): V | undefined;
-    /**
-     * The function overrides the delete method and joins the key array using a specified joint character before calling
-     * the super delete method.
-     * @param {number[]} key - An array of numbers that represents the key to be deleted.
-     * @returns The `delete` method is returning the result of calling the `delete` method on the superclass, with the
-     * `key` array joined together using the `_joint` property.
-     */
-    delete(key: number[]): boolean;
-}

package/dist/data-structures/hash/coordinate-map.js

@@ -1,62 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CoordinateMap = void 0;
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-class CoordinateMap extends Map {
-    constructor(joint) {
-        super();
-        this._joint = '_';
-        if (joint !== undefined)
-            this._joint = joint;
-    }
-    get joint() {
-        return this._joint;
-    }
-    /**
-     * The "has" function overrides the base class's "has" function and checks if a key exists in the map by joining the
-     * key array with a specified delimiter.
-     * @param {number[]} key - The parameter "key" is an array of numbers.
-     * @returns The `has` method is being overridden to return the result of calling the `has` method of the superclass
-     * (`super.has`) with the `key` array joined together using the `_joint` property.
-     */
-    has(key) {
-        return super.has(key.join(this._joint));
-    }
-    /**
-     * The function overrides the set method of a Map object to convert the key from an array to a string using a specified
-     * delimiter before calling the original set method.
-     * @param {number[]} key - The key parameter is an array of numbers.
-     * @param {V} value - The value parameter is the value that you want to associate with the specified key.
-     * @returns The `set` method is returning the result of calling the `set` method of the superclass
-     * (`super.set(key.join(this._joint), value)`).
-     */
-    set(key, value) {
-        return super.set(key.join(this._joint), value);
-    }
-    /**
-     * The function overrides the get method to join the key array with a specified joint and then calls the super get
-     * method.
-     * @param {number[]} key - An array of numbers
-     * @returns The code is returning the value associated with the specified key in the map.
-     */
-    get(key) {
-        return super.get(key.join(this._joint));
-    }
-    /**
-     * The function overrides the delete method and joins the key array using a specified joint character before calling
-     * the super delete method.
-     * @param {number[]} key - An array of numbers that represents the key to be deleted.
-     * @returns The `delete` method is returning the result of calling the `delete` method on the superclass, with the
-     * `key` array joined together using the `_joint` property.
-     */
-    delete(key) {
-        return super.delete(key.join(this._joint));
-    }
-}
-exports.CoordinateMap = CoordinateMap;

package/dist/data-structures/hash/coordinate-set.d.ts

@@ -1,36 +0,0 @@
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-export declare class CoordinateSet extends Set<any> {
-    constructor(joint?: string);
-    protected _joint: string;
-    get joint(): string;
-    /**
-     * The "has" function overrides the "has" method of the superclass and checks if a value exists in an array after
-     * joining its elements with a specified separator.
-     * @param {number[]} value - The parameter "value" is an array of numbers.
-     * @returns The overridden `has` method is returning the result of calling the `has` method of the superclass, passing
-     * in the joined value as an argument.
-     */
-    has(value: number[]): boolean;
-    /**
-     * The "add" function overrides the parent class's "add" function by joining the elements of the input array with a
-     * specified delimiter before calling the parent class's "add" function.
-     * @param {number[]} value - An array of numbers
-     * @returns The overridden `add` method is returning the result of calling the `add` method of the superclass
-     * (`super.add`) with the joined string representation of the `value` array (`value.join(this._joint)`).
-     */
-    add(value: number[]): this;
-    /**
-     * The function overrides the delete method and deletes an element from a Set by joining the elements of the input
-     * array with a specified joint and then calling the delete method of the parent class.
-     * @param {number[]} value - An array of numbers
-     * @returns The `delete` method is returning the result of calling the `delete` method of the superclass, with the
-     * `value` array joined together using the `_joint` property.
-     */
-    delete(value: number[]): boolean;
-}

package/dist/data-structures/hash/coordinate-set.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CoordinateSet = void 0;
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-class CoordinateSet extends Set {
-    constructor(joint) {
-        super();
-        this._joint = '_';
-        if (joint !== undefined)
-            this._joint = joint;
-    }
-    get joint() {
-        return this._joint;
-    }
-    /**
-     * The "has" function overrides the "has" method of the superclass and checks if a value exists in an array after
-     * joining its elements with a specified separator.
-     * @param {number[]} value - The parameter "value" is an array of numbers.
-     * @returns The overridden `has` method is returning the result of calling the `has` method of the superclass, passing
-     * in the joined value as an argument.
-     */
-    has(value) {
-        return super.has(value.join(this._joint));
-    }
-    /**
-     * The "add" function overrides the parent class's "add" function by joining the elements of the input array with a
-     * specified delimiter before calling the parent class's "add" function.
-     * @param {number[]} value - An array of numbers
-     * @returns The overridden `add` method is returning the result of calling the `add` method of the superclass
-     * (`super.add`) with the joined string representation of the `value` array (`value.join(this._joint)`).
-     */
-    add(value) {
-        return super.add(value.join(this._joint));
-    }
-    /**
-     * The function overrides the delete method and deletes an element from a Set by joining the elements of the input
-     * array with a specified joint and then calling the delete method of the parent class.
-     * @param {number[]} value - An array of numbers
-     * @returns The `delete` method is returning the result of calling the `delete` method of the superclass, with the
-     * `value` array joined together using the `_joint` property.
-     */
-    delete(value) {
-        return super.delete(value.join(this._joint));
-    }
-}
-exports.CoordinateSet = CoordinateSet;

package/dist/data-structures/hash/tree-map.d.ts

@@ -1,2 +0,0 @@
-export declare class TreeMap {
-}

package/dist/data-structures/hash/tree-map.js

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

package/dist/data-structures/hash/tree-set.d.ts

@@ -1,2 +0,0 @@
-export declare class TreeSet {
-}

package/dist/data-structures/hash/tree-set.js

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

package/dist/types/data-structures/hash/coordinate-map.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/data-structures/hash/coordinate-map.js

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

package/dist/types/data-structures/hash/coordinate-set.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/data-structures/hash/coordinate-set.js

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

package/dist/types/data-structures/hash/tree-map.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/data-structures/hash/tree-map.js

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

package/dist/types/data-structures/hash/tree-set.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/data-structures/hash/tree-set.js

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

package/src/data-structures/hash/coordinate-map.ts

@@ -1,63 +0,0 @@
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-export class CoordinateMap<V> extends Map<any, V> {
-  constructor(joint?: string) {
-    super();
-    if (joint !== undefined) this._joint = joint;
-  }
-
-  protected _joint = '_';
-
-  get joint(): string {
-    return this._joint;
-  }
-
-  /**
-   * The "has" function overrides the base class's "has" function and checks if a key exists in the map by joining the
-   * key array with a specified delimiter.
-   * @param {number[]} key - The parameter "key" is an array of numbers.
-   * @returns The `has` method is being overridden to return the result of calling the `has` method of the superclass
-   * (`super.has`) with the `key` array joined together using the `_joint` property.
-   */
-  override has(key: number[]) {
-    return super.has(key.join(this._joint));
-  }
-
-  /**
-   * The function overrides the set method of a Map object to convert the key from an array to a string using a specified
-   * delimiter before calling the original set method.
-   * @param {number[]} key - The key parameter is an array of numbers.
-   * @param {V} value - The value parameter is the value that you want to associate with the specified key.
-   * @returns The `set` method is returning the result of calling the `set` method of the superclass
-   * (`super.set(key.join(this._joint), value)`).
-   */
-  override set(key: number[], value: V) {
-    return super.set(key.join(this._joint), value);
-  }
-
-  /**
-   * The function overrides the get method to join the key array with a specified joint and then calls the super get
-   * method.
-   * @param {number[]} key - An array of numbers
-   * @returns The code is returning the value associated with the specified key in the map.
-   */
-  override get(key: number[]) {
-    return super.get(key.join(this._joint));
-  }
-
-  /**
-   * The function overrides the delete method and joins the key array using a specified joint character before calling
-   * the super delete method.
-   * @param {number[]} key - An array of numbers that represents the key to be deleted.
-   * @returns The `delete` method is returning the result of calling the `delete` method on the superclass, with the
-   * `key` array joined together using the `_joint` property.
-   */
-  override delete(key: number[]) {
-    return super.delete(key.join(this._joint));
-  }
-}

package/src/data-structures/hash/coordinate-set.ts

@@ -1,52 +0,0 @@
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-export class CoordinateSet extends Set<any> {
-  constructor(joint?: string) {
-    super();
-    if (joint !== undefined) this._joint = joint;
-  }
-
-  protected _joint = '_';
-
-  get joint(): string {
-    return this._joint;
-  }
-
-  /**
-   * The "has" function overrides the "has" method of the superclass and checks if a value exists in an array after
-   * joining its elements with a specified separator.
-   * @param {number[]} value - The parameter "value" is an array of numbers.
-   * @returns The overridden `has` method is returning the result of calling the `has` method of the superclass, passing
-   * in the joined value as an argument.
-   */
-  override has(value: number[]) {
-    return super.has(value.join(this._joint));
-  }
-
-  /**
-   * The "add" function overrides the parent class's "add" function by joining the elements of the input array with a
-   * specified delimiter before calling the parent class's "add" function.
-   * @param {number[]} value - An array of numbers
-   * @returns The overridden `add` method is returning the result of calling the `add` method of the superclass
-   * (`super.add`) with the joined string representation of the `value` array (`value.join(this._joint)`).
-   */
-  override add(value: number[]) {
-    return super.add(value.join(this._joint));
-  }
-
-  /**
-   * The function overrides the delete method and deletes an element from a Set by joining the elements of the input
-   * array with a specified joint and then calling the delete method of the parent class.
-   * @param {number[]} value - An array of numbers
-   * @returns The `delete` method is returning the result of calling the `delete` method of the superclass, with the
-   * `value` array joined together using the `_joint` property.
-   */
-  override delete(value: number[]) {
-    return super.delete(value.join(this._joint));
-  }
-}

package/src/data-structures/hash/tree-map.ts

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

package/src/data-structures/hash/tree-set.ts

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

package/src/types/data-structures/hash/coordinate-map.ts

@@ -1 +0,0 @@
-export {};

package/src/types/data-structures/hash/coordinate-set.ts

@@ -1 +0,0 @@
-export {};

package/src/types/data-structures/hash/tree-map.ts

@@ -1 +0,0 @@
-export {};

package/src/types/data-structures/hash/tree-set.ts

@@ -1 +0,0 @@
-export {};