avl-tree-typed 1.52.3 → 1.52.5

package/src/data-structures/trie/trie.ts

@@ -147,11 +147,6 @@ export class Trie<R = any> extends IterableElementBase<string, R, Trie<R>> {
     return this._root;
   }
 
-  /**
-   * Time Complexity: O(l), where l is the length of the word being added.
-   * Space Complexity: O(l) - Each character in the word adds a TrieNode.
-   */
-
   /**
    * Time Complexity: O(l), where l is the length of the word being added.
    * Space Complexity: O(l) - Each character in the word adds a TrieNode.
@@ -180,11 +175,6 @@ export class Trie<R = any> extends IterableElementBase<string, R, Trie<R>> {
     return isNewWord;
   }
 
-  /**
-   * Time Complexity: O(l), where l is the length of the input word.
-   * Space Complexity: O(1) - Constant space.
-   */
-
   /**
    * Time Complexity: O(l), where l is the length of the input word.
    * Space Complexity: O(1) - Constant space.
@@ -204,11 +194,6 @@ export class Trie<R = any> extends IterableElementBase<string, R, Trie<R>> {
     return cur.isEnd;
   }
 
-  /**
-   * Time Complexity: O(1)
-   * Space Complexity: O(1)
-   */
-
   /**
    * Time Complexity: O(1)
    * Space Complexity: O(1)
@@ -220,11 +205,6 @@ export class Trie<R = any> extends IterableElementBase<string, R, Trie<R>> {
     return this.size === 0;
   }
 
-  /**
-   * Time Complexity: O(1)
-   * Space Complexity: O(1)
-   */
-
   /**
    * Time Complexity: O(1)
    * Space Complexity: O(1)
@@ -236,11 +216,6 @@ export class Trie<R = any> extends IterableElementBase<string, R, Trie<R>> {
     this._root = new TrieNode('');
   }
 
-  /**
-   * Time Complexity: O(l), where l is the length of the word being deleted.
-   * Space Complexity: O(n) - Due to the recursive DFS approach.
-   */
-
   /**
    * Time Complexity: O(l), where l is the length of the word being deleted.
    * Space Complexity: O(n) - Due to the recursive DFS approach.
@@ -285,11 +260,6 @@ export class Trie<R = any> extends IterableElementBase<string, R, Trie<R>> {
     return isDeleted;
   }
 
-  /**
-   * Time Complexity: O(n), where n is the total number of nodes in the trie.
-   * Space Complexity: O(1) - Constant space.
-   */
-
   /**
    * Time Complexity: O(n), where n is the total number of nodes in the trie.
    * Space Complexity: O(1) - Constant space.
@@ -315,11 +285,6 @@ export class Trie<R = any> extends IterableElementBase<string, R, Trie<R>> {
     return maxDepth;
   }
 
-  /**
-   * Time Complexity: O(l), where l is the length of the input prefix.
-   * Space Complexity: O(1) - Constant space.
-   */
-
   /**
    * Time Complexity: O(l), where l is the length of the input prefix.
    * Space Complexity: O(1) - Constant space.
@@ -339,11 +304,6 @@ export class Trie<R = any> extends IterableElementBase<string, R, Trie<R>> {
     return !cur.isEnd;
   }
 
-  /**
-   * Time Complexity: O(l), where l is the length of the input prefix.
-   * Space Complexity: O(1) - Constant space.
-   */
-
   /**
    * Time Complexity: O(l), where l is the length of the input prefix.
    * Space Complexity: O(1) - Constant space.
@@ -363,11 +323,6 @@ export class Trie<R = any> extends IterableElementBase<string, R, Trie<R>> {
     return true;
   }
 
-  /**
-   * Time Complexity: O(n), where n is the total number of nodes in the trie.
-   * Space Complexity: O(l), where l is the length of the input prefix.
-   */
-
   /**
    * Time Complexity: O(n), where n is the total number of nodes in the trie.
    * Space Complexity: O(l), where l is the length of the input prefix.
@@ -390,11 +345,6 @@ export class Trie<R = any> extends IterableElementBase<string, R, Trie<R>> {
     return commonPre === input;
   }
 
-  /**
-   * Time Complexity: O(n), where n is the total number of nodes in the trie.
-   * Space Complexity: O(l), where l is the length of the longest common prefix.
-   */
-
   /**
    * Time Complexity: O(n), where n is the total number of nodes in the trie.
    * Space Complexity: O(l), where l is the length of the longest common prefix.
@@ -414,11 +364,6 @@ export class Trie<R = any> extends IterableElementBase<string, R, Trie<R>> {
     return commonPre;
   }
 
-  /**
-   * Time Complexity: O(w * l), where w is the number of words retrieved, and l is the average length of the words.
-   * Space Complexity: O(w * l) - The space required for the output array.
-   */
-
   /**
    * Time Complexity: O(w * l), where w is the number of words retrieved, and l is the average length of the words.
    * Space Complexity: O(w * l) - The space required for the output array.
@@ -468,11 +413,6 @@ export class Trie<R = any> extends IterableElementBase<string, R, Trie<R>> {
     return words;
   }
 
-  /**
-   * Time Complexity: O(n)
-   * Space Complexity: O(n)
-   */
-
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(n)
@@ -485,11 +425,6 @@ export class Trie<R = any> extends IterableElementBase<string, R, Trie<R>> {
     return new Trie<R>(this, { caseSensitive: this.caseSensitive, toElementFn: this.toElementFn });
   }
 
-  /**
-   * Time Complexity: O(n)
-   * Space Complexity: O(n)
-   */
-
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(n)
@@ -516,11 +451,6 @@ export class Trie<R = any> extends IterableElementBase<string, R, Trie<R>> {
     return results;
   }
 
-  /**
-   * Time Complexity: O(n)
-   * Space Complexity: O(n)
-   */
-
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(n)
@@ -553,11 +483,6 @@ export class Trie<R = any> extends IterableElementBase<string, R, Trie<R>> {
     return newTrie;
   }
 
-  /**
-   * Time Complexity: O(n)
-   * Space Complexity: O(n)
-   */
-
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(n)
@@ -578,11 +503,6 @@ export class Trie<R = any> extends IterableElementBase<string, R, Trie<R>> {
     yield* _dfs(this.root, '');
   }
 
-  /**
-   * Time Complexity: O(l), where l is the length of the input string.
-   * Space Complexity: O(1) - Constant space.
-   */
-
   /**
    * Time Complexity: O(l), where l is the length of the input string.
    * Space Complexity: O(1) - Constant space.

package/src/types/data-structures/binary-tree/binary-tree.ts

@@ -28,4 +28,11 @@ export type BTNPureKeyOrNodeOrEntry<K, V, NODE> = [K, OptValue<V>] | BTNPureKeyO
 
 export type BinaryTreeDeleteResult<NODE> = { deleted: OptBTNOrNull<NODE>; needBalanced: OptBTNOrNull<NODE> };
 
-export type BTNCallback<NODE, D = any> = (node: NODE) => D;
+export type BTNCallback<NODE, D = any> = (node: NODE) => D;
+
+export enum DFSOperation {
+  VISIT = 0,
+  PROCESS = 1,
+}
+
+export type DFSStackItem<NODE> = { opt: DFSOperation; node: OptBTNOrNull<NODE> }

package/src/types/utils/utils.ts

@@ -1,21 +1,23 @@
-export type ToThunkFn = () => ReturnType<TrlFn>;
-export type Thunk = () => ReturnType<ToThunkFn> & { __THUNK__: symbol };
-export type TrlFn = (...args: any[]) => any;
+export type ToThunkFn<R = any> = () => R;
+export type Thunk<R = any> = ToThunkFn<R> & { __THUNK__?: symbol };
+export type TrlFn<A extends any[] = any[], R = any> = (...args: A) => R;
 export type TrlAsyncFn = (...args: any[]) => any;
 
 export type SpecifyOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 
 export type Any = string | number | bigint | boolean | symbol | undefined | object;
 
-export type Comparable =
-  | number
-  | string
-  | bigint
-  | boolean
-  | ({ [key in string]: any } & {
-      valueOf(): Comparable;
-    })
-  | ({ [key in string]: any } & {
-      toString(): Comparable;
-    })
-  | (() => Comparable);
+export type ComparablePrimitive = number | bigint | string | boolean;
+
+// TODO type safety looks not strict
+export type ComparableObject = { [key in string]: any } & (
+  | {
+      valueOf: () => ComparablePrimitive | ComparableObject;
+      toString?: () => string;
+    }
+  | {
+      toString: () => string;
+    }
+);
+
+export type Comparable = ComparablePrimitive | Date | ComparableObject;

package/src/utils/number.ts

@@ -1,3 +1,16 @@
+/**
+ * The function `toBinaryString` converts a number to a binary string representation with a specified
+ * number of digits.
+ * @param {number} num - The `num` parameter in the `toBinaryString` function represents the number
+ * that you want to convert to a binary string.
+ * @param [digit=32] - The `digit` parameter in the `toBinaryString` function represents the number of
+ * digits the binary string should have. By default, it is set to 32, meaning that the binary string
+ * will be padded with zeros at the beginning to ensure it is 32 bits long. You can provide a
+ * @returns The function `toBinaryString` takes a number as input and converts it to a binary string
+ * representation with a specified number of digits (default is 32). The binary string is padded with
+ * zeros at the beginning to ensure it has the specified number of digits. The function returns the
+ * binary string representation of the input number.
+ */
 export function toBinaryString(num: number, digit = 32) {
   // Convert number to binary string
   let binaryString = (num >>> 0).toString(2); // Use the unsigned right shift operator to ensure you get a binary representation of a 32-bit unsigned integer

package/src/utils/utils.ts

@@ -5,8 +5,14 @@
  * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-import type { Comparable, Thunk, ToThunkFn, TrlAsyncFn, TrlFn } from '../types';
+import type { Comparable, ComparablePrimitive, Thunk, ToThunkFn, TrlAsyncFn, TrlFn } from '../types';
 
+/**
+ * The function generates a random UUID (Universally Unique Identifier) in TypeScript.
+ * @returns A randomly generated UUID (Universally Unique Identifier) in the format
+ * 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' where each 'x' is replaced with a random hexadecimal
+ * character.
+ */
 export const uuidV4 = function () {
   return 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'.replace(/[x]/g, function (c) {
     const r = (Math.random() * 16) | 0,
@@ -15,6 +21,15 @@ export const uuidV4 = function () {
   });
 };
 
+/**
+ * The `arrayRemove` function removes elements from an array based on a specified predicate function
+ * and returns the removed elements.
+ * @param {T[]} array - An array of elements that you want to filter based on the provided predicate
+ * function.
+ * @param predicate - The `predicate` parameter is a function that takes three arguments:
+ * @returns The `arrayRemove` function returns an array containing the elements that satisfy the given
+ * `predicate` function.
+ */
 export const arrayRemove = function <T>(array: T[], predicate: (item: T, index: number, array: T[]) => boolean): T[] {
   let i = -1,
     len = array ? array.length : 0;
@@ -34,18 +49,45 @@ export const arrayRemove = function <T>(array: T[], predicate: (item: T, index:
 
 export const THUNK_SYMBOL = Symbol('thunk');
 
+/**
+ * The function `isThunk` checks if a given value is a function with a specific symbol property.
+ * @param {any} fnOrValue - The `fnOrValue` parameter in the `isThunk` function can be either a
+ * function or a value that you want to check if it is a thunk. Thunks are functions that are wrapped
+ * around a value or computation for lazy evaluation. The function checks if the `fnOrValue` is
+ * @returns The function `isThunk` is checking if the input `fnOrValue` is a function and if it has a
+ * property `__THUNK__` equal to `THUNK_SYMBOL`. The return value will be `true` if both conditions are
+ * met, otherwise it will be `false`.
+ */
 export const isThunk = (fnOrValue: any) => {
   return typeof fnOrValue === 'function' && fnOrValue.__THUNK__ === THUNK_SYMBOL;
 };
 
+/**
+ * The `toThunk` function in TypeScript converts a function into a thunk by wrapping it in a closure.
+ * @param {ToThunkFn} fn - `fn` is a function that will be converted into a thunk.
+ * @returns A thunk function is being returned. Thunk functions are functions that delay the evaluation
+ * of an expression or operation until it is explicitly called or invoked. In this case, the `toThunk`
+ * function takes a function `fn` as an argument and returns a thunk function that, when called, will
+ * execute the `fn` function provided as an argument.
+ */
 export const toThunk = (fn: ToThunkFn): Thunk => {
   const thunk = () => fn();
   thunk.__THUNK__ = THUNK_SYMBOL;
   return thunk;
 };
 
+/**
+ * The `trampoline` function in TypeScript enables tail call optimization by using thunks to avoid
+ * stack overflow.
+ * @param {TrlFn} fn - The `fn` parameter in the `trampoline` function is a function that takes any
+ * number of arguments and returns a value.
+ * @returns The `trampoline` function returns an object with two properties:
+ * 1. A function that executes the provided function `fn` and continues to execute any thunks returned
+ * by `fn` until a non-thunk value is returned.
+ * 2. A `cont` property that is a function which creates a thunk for the provided function `fn`.
+ */
 export const trampoline = (fn: TrlFn) => {
-  const cont = (...args: [...Parameters<TrlFn>]) => toThunk(() => fn(...args));
+  const cont = (...args: [...Parameters<TrlFn>]): ReturnType<TrlFn> => toThunk(() => fn(...args));
 
   return Object.assign(
     (...args: [...Parameters<TrlFn>]) => {
@@ -61,8 +103,20 @@ export const trampoline = (fn: TrlFn) => {
   );
 };
 
+/**
+ * The `trampolineAsync` function in TypeScript allows for asynchronous trampolining of a given
+ * function.
+ * @param {TrlAsyncFn} fn - The `fn` parameter in the `trampolineAsync` function is expected to be a
+ * function that returns a Promise. This function will be called recursively until a non-thunk value is
+ * returned.
+ * @returns The `trampolineAsync` function returns an object with two properties:
+ * 1. An async function that executes the provided `TrlAsyncFn` function and continues to execute any
+ * thunks returned by the function until a non-thunk value is returned.
+ * 2. A `cont` property that is a function which wraps the provided `TrlAsyncFn` function in a thunk
+ * and returns it.
+ */
 export const trampolineAsync = (fn: TrlAsyncFn) => {
-  const cont = (...args: [...Parameters<TrlAsyncFn>]) => toThunk(() => fn(...args));
+  const cont = (...args: [...Parameters<TrlAsyncFn>]): ReturnType<TrlAsyncFn> => toThunk(() => fn(...args));
 
   return Object.assign(
     async (...args: [...Parameters<TrlAsyncFn>]) => {
@@ -78,6 +132,15 @@ export const trampolineAsync = (fn: TrlAsyncFn) => {
   );
 };
 
+/**
+ * The function `getMSB` returns the most significant bit of a given number.
+ * @param {number} value - The `value` parameter is a number for which we want to find the position of
+ * the Most Significant Bit (MSB). The function `getMSB` takes this number as input and calculates the
+ * position of the MSB in its binary representation.
+ * @returns The function `getMSB` returns the most significant bit (MSB) of the input `value`. If the
+ * input value is less than or equal to 0, it returns 0. Otherwise, it calculates the position of the
+ * MSB using the `Math.clz32` function and bitwise left shifts 1 to that position.
+ */
 export const getMSB = (value: number): number => {
   if (value <= 0) {
     return 0;
@@ -85,42 +148,135 @@ export const getMSB = (value: number): number => {
   return 1 << (31 - Math.clz32(value));
 };
 
+/**
+ * The `rangeCheck` function in TypeScript is used to validate if an index is within a specified range
+ * and throws a `RangeError` with a custom message if it is out of bounds.
+ * @param {number} index - The `index` parameter represents the value that you want to check if it
+ * falls within a specified range.
+ * @param {number} min - The `min` parameter represents the minimum value that the `index` should be
+ * compared against in the `rangeCheck` function.
+ * @param {number} max - The `max` parameter in the `rangeCheck` function represents the maximum value
+ * that the `index` parameter is allowed to have. If the `index` is greater than this `max` value, a
+ * `RangeError` will be thrown.
+ * @param [message=Index out of bounds.] - The `message` parameter is a string that represents the
+ * error message to be thrown if the index is out of bounds. By default, if no message is provided when
+ * calling the `rangeCheck` function, the message "Index out of bounds." will be used.
+ */
 export const rangeCheck = (index: number, min: number, max: number, message = 'Index out of bounds.'): void => {
   if (index < min || index > max) throw new RangeError(message);
 };
 
+/**
+ * The function `throwRangeError` throws a RangeError with a custom message if called.
+ * @param [message=The value is off-limits.] - The `message` parameter is a string that represents the
+ * error message to be displayed when a `RangeError` is thrown. If no message is provided, the default
+ * message is 'The value is off-limits.'.
+ */
 export const throwRangeError = (message = 'The value is off-limits.'): void => {
   throw new RangeError(message);
 };
 
+/**
+ * The function `isWeakKey` checks if the input is an object or a function in TypeScript.
+ * @param {unknown} input - The `input` parameter in the `isWeakKey` function is of type `unknown`,
+ * which means it can be any type. The function checks if the `input` is an object (excluding `null`)
+ * or a function, and returns a boolean indicating whether the `input` is a weak
+ * @returns The function `isWeakKey` returns a boolean value indicating whether the input is an object
+ * or a function.
+ */
 export const isWeakKey = (input: unknown): input is object => {
   const inputType = typeof input;
   return (inputType === 'object' && input !== null) || inputType === 'function';
 };
 
+/**
+ * The function `calcMinUnitsRequired` calculates the minimum number of units required to accommodate a
+ * given total quantity based on a specified unit size.
+ * @param {number} totalQuantity - The `totalQuantity` parameter represents the total quantity of items
+ * that need to be processed or handled.
+ * @param {number} unitSize - The `unitSize` parameter represents the size of each unit or package. It
+ * is used in the `calcMinUnitsRequired` function to calculate the minimum number of units required to
+ * accommodate a total quantity of items.
+ */
 export const calcMinUnitsRequired = (totalQuantity: number, unitSize: number) =>
   Math.floor((totalQuantity + unitSize - 1) / unitSize);
 
+/**
+ * The `roundFixed` function in TypeScript rounds a number to a specified number of decimal places.
+ * @param {number} num - The `num` parameter is a number that you want to round to a certain number of
+ * decimal places.
+ * @param {number} [digit=10] - The `digit` parameter in the `roundFixed` function specifies the number
+ * of decimal places to round the number to. By default, it is set to 10 if not provided explicitly.
+ * @returns The function `roundFixed` returns a number that is rounded to the specified number of
+ * decimal places (default is 10 decimal places).
+ */
 export const roundFixed = (num: number, digit: number = 10) => {
   const multiplier = Math.pow(10, digit);
   return Math.round(num * multiplier) / multiplier;
 };
 
-export function isComparable(key: any): key is Comparable {
-  const keyType = typeof key;
-  if (keyType === 'number') return !isNaN(key);
-  if (keyType === 'string') return true;
-  if (keyType === 'bigint') return true;
-  if (keyType === 'boolean') return true;
-  if (keyType === 'symbol') return false;
-  if (keyType === 'undefined') return false;
-  if (keyType === 'function') return isComparable(key());
-  if (keyType === 'object') {
-    if (key === null) return true;
-    // if (typeof key.valueOf === 'function') return isComparable(key.valueOf());   // This will keep recursing because every object has a valueOf method.
-    // if (typeof key.toString === 'function') return isComparable(key.toString()); // This will also keep recursing because every string type has a toString method.
-    return false;
+/**
+ * The function `isPrimitiveComparable` checks if a value is a primitive type that can be compared.
+ * @param {unknown} value - The `value` parameter in the `isPrimitiveComparable` function is of type
+ * `unknown`, which means it can be any type. The function checks if the `value` is a primitive type
+ * that can be compared, such as number, bigint, string, or boolean.
+ * @returns The function `isPrimitiveComparable` returns a boolean value indicating whether the input
+ * `value` is a primitive value that can be compared using standard comparison operators (<, >, <=,
+ * >=).
+ */
+function isPrimitiveComparable(value: unknown): value is ComparablePrimitive {
+  const valueType = typeof value;
+  if (valueType === 'number') return !Number.isNaN(value);
+  return valueType === 'bigint' || valueType === 'string' || valueType === 'boolean';
+}
+
+/**
+ * The function `tryObjectToPrimitive` attempts to convert an object to a comparable primitive value by
+ * first checking the `valueOf` method and then the `toString` method.
+ * @param {object} obj - The `obj` parameter in the `tryObjectToPrimitive` function is an object that
+ * you want to convert to a primitive value. The function attempts to convert the object to a primitive
+ * value by first checking if the object has a `valueOf` method. If the `valueOf` method exists, it
+ * @returns The function `tryObjectToPrimitive` returns a value of type `ComparablePrimitive` if a
+ * primitive comparable value is found within the object, or a string value if the object has a custom
+ * `toString` method that does not return `'[object Object]'`. If neither condition is met, the
+ * function returns `null`.
+ */
+function tryObjectToPrimitive(obj: object): ComparablePrimitive | null {
+  if (typeof obj.valueOf === 'function') {
+    const valueOfResult = obj.valueOf();
+    if (valueOfResult !== obj) {
+      if (isPrimitiveComparable(valueOfResult)) return valueOfResult;
+      if (typeof valueOfResult === 'object' && valueOfResult !== null) return tryObjectToPrimitive(valueOfResult);
+    }
+  }
+  if (typeof obj.toString === 'function') {
+    const stringResult = obj.toString();
+    if (stringResult !== '[object Object]') return stringResult;
   }
+  return null;
+}
+
+/**
+ * The function `isComparable` in TypeScript checks if a value is comparable, handling primitive values
+ * and objects with optional force comparison.
+ * @param {unknown} value - The `value` parameter in the `isComparable` function represents the value
+ * that you want to check if it is comparable. It can be of any type (`unknown`), and the function will
+ * determine if it is comparable based on certain conditions.
+ * @param [isForceObjectComparable=false] - The `isForceObjectComparable` parameter in the
+ * `isComparable` function is a boolean flag that determines whether to treat non-primitive values as
+ * comparable objects. When set to `true`, it forces the function to consider non-primitive values as
+ * comparable objects, regardless of their type.
+ * @returns The function `isComparable` returns a boolean value indicating whether the `value` is
+ * considered comparable or not.
+ */
+export function isComparable(value: unknown, isForceObjectComparable = false): value is Comparable {
+  if (value === null || value === undefined) return false;
+  if (isPrimitiveComparable(value)) return true;
 
-  return false;
+  if (typeof value !== 'object') return false;
+  if (value instanceof Date) return !Number.isNaN(value.getTime());
+  if (isForceObjectComparable) return true;
+  const comparableValue = tryObjectToPrimitive(value);
+  if (comparableValue === null || comparableValue === undefined) return false;
+  return isPrimitiveComparable(comparableValue);
 }