max-priority-queue-typed 2.4.5 → 2.5.1

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

@@ -113,32 +113,6 @@ export class TrieNode {
  * 10. IP Routing: Used in certain types of IP routing algorithms.
  * 11. Text Word Frequency Count: Counting and storing the frequency of words in a large amount of text data.
  * @example
- * // basic Trie creation and add words
- *  // Create a simple Trie with initial words
- *     const trie = new Trie(['apple', 'app', 'apply']);
- *
- *     // Verify size
- *     console.log(trie.size); // 3;
- *
- *     // Check if words exist
- *     console.log(trie.has('apple')); // true;
- *     console.log(trie.has('app')); // true;
- *
- *     // Add a new word
- *     trie.add('application');
- *     console.log(trie.size); // 4;
- * @example
- * // Trie getWords and prefix search
- *  const trie = new Trie(['apple', 'app', 'apply', 'application', 'apricot']);
- *
- *     // Get all words with prefix 'app'
- *     const appWords = trie.getWords('app');
- *     console.log(appWords); // contains 'app';
- *     console.log(appWords); // contains 'apple';
- *     console.log(appWords); // contains 'apply';
- *     console.log(appWords); // contains 'application';
- *     expect(appWords).not.toContain('apricot');
- * @example
  * // Trie isPrefix and isAbsolutePrefix checks
  *  const trie = new Trie(['tree', 'trial', 'trick', 'trip', 'trie']);
  *
@@ -154,23 +128,6 @@ export class TrieNode {
  *     // Verify size
  *     console.log(trie.size); // 5;
  * @example
- * // Trie delete and iteration
- *  const trie = new Trie(['car', 'card', 'care', 'careful', 'can', 'cat']);
- *
- *     // Delete a word
- *     trie.delete('card');
- *     console.log(trie.has('card')); // false;
- *
- *     // Word with same prefix still exists
- *     console.log(trie.has('care')); // true;
- *
- *     // Size decreased
- *     console.log(trie.size); // 5;
- *
- *     // Iterate through all words
- *     const allWords = [...trie];
- *     console.log(allWords.length); // 5;
- * @example
  * // Trie for autocomplete search index
  *  // Trie is perfect for autocomplete: O(m + k) where m is prefix length, k is results
  *     const searchIndex = new Trie(['typescript', 'javascript', 'python', 'java', 'rust', 'ruby', 'golang', 'kotlin']);
@@ -327,6 +284,53 @@ export class Trie<R = any> extends IterableElementBase<string, R> {
    * @remarks Time O(L), Space O(L)
    * @param word - Word to insert.
    * @returns True if the word was newly added.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // basic Trie creation and add words
+ *  // Create a simple Trie with initial words
+ *     const trie = new Trie(['apple', 'app', 'apply']);
+ *
+ *     // Verify size
+ *     console.log(trie.size); // 3;
+ *
+ *     // Check if words exist
+ *     console.log(trie.has('apple')); // true;
+ *     console.log(trie.has('app')); // true;
+ *
+ *     // Add a new word
+ *     trie.add('application');
+ *     console.log(trie.size); // 4;
    */
 
   add(word: string): boolean {
@@ -354,6 +358,42 @@ export class Trie<R = any> extends IterableElementBase<string, R> {
    * @remarks Time O(ΣL), Space O(ΣL)
    * @param words - Iterable of strings (or raw records if toElementFn is provided).
    * @returns Array of per-word 'added' flags.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Add multiple words
+ *  const trie = new Trie();
+ *     trie.addMany(['cat', 'car', 'card']);
+ *     console.log(trie.has('cat')); // true;
+ *     console.log(trie.has('car')); // true;
+ *     console.log(trie.size); // 3;
    */
 
   addMany(words: Iterable<string> | Iterable<R>): boolean[] {
@@ -373,6 +413,45 @@ export class Trie<R = any> extends IterableElementBase<string, R> {
    * @remarks Time O(L), Space O(1)
    * @param word - Word to search for.
    * @returns True if present.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Check if a word exists
+ *  const dict = new Trie(['apple', 'app', 'application']);
+ *
+ *     console.log(dict.has('app')); // true;
+ *     console.log(dict.has('apple')); // true;
+ *     console.log(dict.has('ap')); // false;
    */
 
   override has(word: string): boolean {
@@ -390,6 +469,41 @@ export class Trie<R = any> extends IterableElementBase<string, R> {
    * Check whether the trie is empty.
    * @remarks Time O(1), Space O(1)
    * @returns True if size is 0.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Check if empty
+ *  const trie = new Trie();
+ *     console.log(trie.isEmpty()); // true;
+ *     trie.add('word');
+ *     console.log(trie.isEmpty()); // false;
    */
 
   isEmpty(): boolean {
@@ -400,6 +514,40 @@ export class Trie<R = any> extends IterableElementBase<string, R> {
    * Remove all words and reset to a fresh root.
    * @remarks Time O(1), Space O(1)
    * @returns void
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Remove all words
+ *  const trie = new Trie(['a', 'b', 'c']);
+ *     trie.clear();
+ *     console.log(trie.isEmpty()); // true;
    */
 
   clear(): void {
@@ -412,6 +560,55 @@ export class Trie<R = any> extends IterableElementBase<string, R> {
    * @remarks Time O(L), Space O(1)
    * @param word - Word to delete.
    * @returns True if a word was removed.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Trie delete and iteration
+ *  const trie = new Trie(['car', 'card', 'care', 'careful', 'can', 'cat']);
+ *
+ *     // Delete a word
+ *     trie.delete('card');
+ *     console.log(trie.has('card')); // false;
+ *
+ *     // Word with same prefix still exists
+ *     console.log(trie.has('care')); // true;
+ *
+ *     // Size decreased
+ *     console.log(trie.size); // 5;
+ *
+ *     // Iterate through all words
+ *     const allWords = [...trie];
+ *     console.log(allWords.length); // 5;
    */
 
   delete(word: string): boolean {
@@ -499,6 +696,45 @@ export class Trie<R = any> extends IterableElementBase<string, R> {
    * @remarks Time O(L), Space O(1)
    * @param input - String to test as prefix.
    * @returns True if input matches a path from root.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Check if a prefix exists
+ *  const trie = new Trie(['hello', 'help', 'world']);
+ *
+ *     console.log(trie.hasPrefix('hel')); // true;
+ *     console.log(trie.hasPrefix('wor')); // true;
+ *     console.log(trie.hasPrefix('xyz')); // false;
    */
 
   hasPrefix(input: string): boolean {
@@ -537,6 +773,43 @@ export class Trie<R = any> extends IterableElementBase<string, R> {
    * Return the longest common prefix among all words.
    * @remarks Time O(H), Space O(1)
    * @returns The longest common prefix string.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Find shared prefix
+ *  const trie = new Trie(['flower', 'flow', 'flight']);
+ *
+ *     console.log(trie.getLongestCommonPrefix()); // 'fl';
    */
 
   getLongestCommonPrefix(): string {
@@ -558,6 +831,49 @@ export class Trie<R = any> extends IterableElementBase<string, R> {
    * @param [max] - Maximum number of words to return; default is Number.MAX_SAFE_INTEGER.
    * @param [isAllWhenEmptyPrefix] - When true, collect from root even if prefix is empty.
    * @returns Array of collected words (at most max).
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Trie getWords and prefix search
+ *  const trie = new Trie(['apple', 'app', 'apply', 'application', 'apricot']);
+ *
+ *     // Get all words with prefix 'app'
+ *     const appWords = trie.getWords('app');
+ *     console.log(appWords); // contains 'app';
+ *     console.log(appWords); // contains 'apple';
+ *     console.log(appWords); // contains 'apply';
+ *     console.log(appWords); // contains 'application';
+ *     expect(appWords).not.toContain('apricot');
    */
 
   getWords(prefix = '', max = Number.MAX_SAFE_INTEGER, isAllWhenEmptyPrefix = false): string[] {
@@ -599,6 +915,41 @@ export class Trie<R = any> extends IterableElementBase<string, R> {
    * Deep clone this trie by iterating and inserting all words.
    * @remarks Time O(ΣL), Space O(ΣL)
    * @returns A new trie with the same words and options.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Create independent copy
+ *  const trie = new Trie(['hello', 'world']);
+ *     const copy = trie.clone();
+ *     copy.delete('hello');
+ *     console.log(trie.has('hello')); // true;
    */
 
   clone(): this {
@@ -613,9 +964,43 @@ export class Trie<R = any> extends IterableElementBase<string, R> {
    * @param predicate - Predicate (word, index, trie) → boolean to keep word.
    * @param [thisArg] - Value for `this` inside the predicate.
    * @returns A new trie containing words that satisfy the predicate.
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Filter words
+ *  const trie = new Trie(['cat', 'car', 'dog', 'card']);
+ *     const result = trie.filter(w => w.startsWith('ca'));
+ *     console.log(result.size); // 3;
    */
 
-  filter(predicate: ElementCallback<string, R, boolean>, thisArg?: any): this {
+  filter(predicate: ElementCallback<string, R, boolean>, thisArg?: unknown): this {
     const results = this._createInstance();
     let index = 0;
     for (const word of this) {
@@ -627,7 +1012,44 @@ export class Trie<R = any> extends IterableElementBase<string, R> {
     return results;
   }
 
-  map<RM>(callback: ElementCallback<string, R, string>, options?: TrieOptions<RM>, thisArg?: any): Trie<RM>;
+    /**
+   * Transform words
+  
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+    * @example
+ * // Transform words
+ *  const trie = new Trie(['hello', 'world']);
+ *     const upper = trie.map(w => w.toUpperCase());
+ *     console.log(upper.has('HELLO')); // true;
+   */
+  map<RM>(callback: ElementCallback<string, R, string>, options?: TrieOptions<RM>, thisArg?: unknown): Trie<RM>;
 
   /**
    * Map words into a new trie (possibly different record type).
@@ -643,10 +1065,10 @@ export class Trie<R = any> extends IterableElementBase<string, R> {
   map<EM, RM>(
     callback: ElementCallback<string, R, EM>,
     options?: TrieOptions<RM>,
-    thisArg?: any
+    thisArg?: unknown
   ): IterableElementBase<EM, RM>;
 
-  map<EM, RM>(callback: ElementCallback<string, R, EM>, options?: TrieOptions<RM>, thisArg?: any): any {
+  map<EM, RM>(callback: ElementCallback<string, R, EM>, options?: TrieOptions<RM>, thisArg?: unknown): any {
     const newTrie = this._createLike<RM>([], options);
     let i = 0;
     for (const x of this) {
@@ -667,7 +1089,7 @@ export class Trie<R = any> extends IterableElementBase<string, R> {
    * @returns A new trie with mapped words.
    */
 
-  mapSame(callback: ElementCallback<string, R, string>, thisArg?: any): this {
+  mapSame(callback: ElementCallback<string, R, string>, thisArg?: unknown): this {
     const next = this._createInstance();
     let i = 0;
     for (const key of this) {

package/src/interfaces/graph.ts

@@ -40,5 +40,5 @@ export interface IGraph<V, E, VO, EO> {
 
   clone(): this;
 
-  filter(...args: any[]): this;
+  filter(...args: unknown[]): this;
 }

package/src/types/common.ts

@@ -11,11 +11,11 @@ export type DFSOrderPattern = 'PRE' | 'IN' | 'POST';
 export type NodeDisplayLayout = [string[], number, number, number];
 
 export interface IterableWithSize<T> extends Iterable<T> {
-  size: number | ((...args: any[]) => number);
+  size: number | ((...args: unknown[]) => number);
 }
 
 export interface IterableWithLength<T> extends Iterable<T> {
-  length: number | ((...args: any[]) => number);
+  length: number | ((...args: unknown[]) => number);
 }
 
 export type OptValue<V> = V | undefined;

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

@@ -1 +1 @@
-export type SegmentTreeNodeVal = number;
+export {};

package/src/types/data-structures/heap/heap.ts

@@ -1,6 +1,7 @@
 import { Comparator } from '../../common';
 import { IterableElementBaseOptions } from '../base';
 
+/** Configuration options for Heap and PriorityQueue. */
 export type HeapOptions<E, R> = IterableElementBaseOptions<E, R> & {
   comparator?: Comparator<E>;
 };

package/src/types/data-structures/linked-list/skip-linked-list.ts

@@ -1 +1,2 @@
-export type SkipLinkedListOptions = { maxLevel?: number; probability?: number };
+// SkipList types are co-located with the implementation in src/data-structures/linked-list/skip-linked-list.ts
+export {};

package/src/types/data-structures/priority-queue/priority-queue.ts

@@ -1,3 +1,4 @@
 import { HeapOptions } from '../heap';
 
+/** Configuration options for PriorityQueue, same as {@link HeapOptions}. */
 export type PriorityQueueOptions<E, R> = HeapOptions<E, R>;

package/src/types/utils/validate-type.ts

@@ -1,18 +1,18 @@
-export type KeyValueObject = { [key: string]: any };
+export type KeyValueObject = { [key: string]: unknown };
 
-export type KeyValueObjectWithKey = { [key: string]: any; key: string | number | symbol };
+export type KeyValueObjectWithKey = { [key: string]: unknown; key: string | number | symbol };
 
 export type NonNumberNonObjectButDefined = string | boolean | symbol | null;
 
 export type ObjectWithoutKey = Omit<KeyValueObject, 'key'>;
 
 export type ObjectWithNonNumberKey = {
-  [key: string]: any;
+  [key: string]: unknown;
   key: string | boolean | symbol | null | object | undefined;
 };
 
 export type ObjectWithNumberKey = {
-  [key: string]: any;
+  [key: string]: unknown;
   key: number;
 };