atomic-fns 1.2.0 → 2.0.0

package/dist/collections/SplayTree.js

@@ -1,351 +0,0 @@
-import { compare } from '../operators/index.js';
-import { Mapping } from './abc.js';
-/**
- * Base SplayTree node class.
- * @private
- */
-class Node {
-    key;
-    value;
-    left;
-    right;
-    constructor(key, value) {
-        this.key = key;
-        this.value = value;
-    }
-    get height() {
-        let height = -1;
-        let level = [this];
-        while (level.length) {
-            height += 1;
-            level = level.flatMap((node) => [node.left, node.right].filter(Boolean));
-        }
-        return height;
-    }
-}
-// In-order snapshot of a tree: reads splay it, so a live walk would lose its place
-function traverse(node) {
-    const nodes = [];
-    const stack = [];
-    while (node || stack.length) {
-        while (node) {
-            stack.push(node);
-            node = node.left;
-        }
-        node = stack.pop();
-        nodes.push(node);
-        node = node.right;
-    }
-    return nodes;
-}
-/**
- * A splay tree is a *self-balancing binary* search tree with the additional property that recently accessed elements are quick to access again.
- * Insertion, look-up and removal in O(log n) *amortized* time.
- * For many patterns of non-random operations splay trees can take better than logarithmic time, without requiring advance knowledge of the pattern.
- * @see {@link https://en.wikipedia.org/wiki/Splay_tree Splay tree}
- * @see {@link https://web.archive.org/web/20220930173835/http://www14.in.tum.de/personen/albers/papers/ipl02.pdf Randomized Splay Trees}
- * @template K, V
- */
-export class SplayTree extends Mapping {
-    root;
-    cmp;
-    randSplay;
-    count;
-    /**
-     * Create a new randomized Splay Tree
-     * @param compareFn
-     * @param p When an element is accessed, with probability `p` splay the tree. With probability `1 - p`, leave the tree as it is.
-     */
-    constructor(compareFn, p = 0.5) {
-        super();
-        this.cmp = compareFn ?? compare;
-        this.count = 0;
-        this.randSplay = p;
-    }
-    top() {
-        return this.root?.key;
-    }
-    get size() {
-        return this.count;
-    }
-    empty() {
-        return !this.root;
-    }
-    get height() {
-        if (!this.root)
-            return 0;
-        return this.root.height;
-    }
-    /**
-     *  Returns the value for `key` or `undefined` if the key is not found.
-     * @param key The key to find.
-     * @returns {?V} The value for the key or `undefined`.
-     */
-    get(key) {
-        return this.findNode(key)?.value;
-    }
-    findNode(key) {
-        if (!this.root)
-            return;
-        // Note: deterministic splaying (always moves key to front):
-        // this.splay(key)
-        // if (this.cmp(key, this.root.key) === 0) return this.root.value
-        // Randomized Splay Trees https://doi.org/10.1016%2Fs0020-0190%2801%2900230-7
-        // The randomized idea is only moving accessed keys with a certain probability `p`.
-        // Values of `p` closer to 1 tend to perform well.
-        if (Math.random() <= this.randSplay) {
-            this.splay(key);
-            if (this.cmp(key, this.root.key) === 0)
-                return this.root;
-            else
-                return undefined;
-        }
-        // Lookup the node down the tree
-        let current = this.root;
-        while (current) {
-            const rank = this.cmp(key, current.key);
-            if (rank === 0)
-                return current;
-            if (rank < 0)
-                current = current.left;
-            else
-                current = current.right;
-        }
-    }
-    /**
-     * Inserts the `key` and `value` in the tree, or updates the value if the `key` exists.
-     * @param {K} key A key which can be any comparable value
-     * @param {V} value A value associated with the key
-     * @returns
-     */
-    set(key, value) {
-        this.insert(key, value, true);
-    }
-    insert(key, value, overwrite) {
-        if (!this.root) {
-            this.root = new Node(key, value);
-            this.count += 1;
-            return;
-        }
-        // Splay on the key to move the last node on the search path for
-        // the key to the root of the tree.
-        this.splay(key);
-        const rank = this.cmp(key, this.root.key);
-        if (rank === 0) {
-            // Update the value
-            if (overwrite)
-                this.root.value = value;
-            return;
-        }
-        const node = new Node(key, value);
-        if (rank > 0) {
-            node.left = this.root;
-            node.right = this.root.right;
-            this.root.right = undefined;
-        }
-        else {
-            node.right = this.root;
-            node.left = this.root.left;
-            this.root.left = undefined;
-        }
-        this.root = node;
-        this.count += 1;
-    }
-    /**
-     * Removes a specified key if it exists in the tree. The removed value is returned or `undefined` if not found.
-     * @param {K} key The key to remove.
-     * @returns {?V} The removed value associated with `key`.
-     */
-    remove(key) {
-        if (!this.root) {
-            return;
-        }
-        this.splay(key);
-        if (this.cmp(key, this.root.key) !== 0) {
-            return;
-        }
-        const removed = this.root;
-        if (!this.root.left) {
-            this.root = this.root.right;
-        }
-        else {
-            const right = this.root.right;
-            this.root = this.root.left;
-            //
-            // Splay to make sure that the new root has an empty right child.
-            //
-            this.splay(key);
-            //
-            // Insert the original right child as the right child of the new
-            // root.
-            //
-            this.root.right = right;
-        }
-        this.count -= 1;
-        return removed.value;
-    }
-    //
-    //  function find(key)
-    //  @param {number} key Key to find in the tree.
-    //  @return {SplayTree.Node} Node having the specified key.
-    //
-    //
-    /**
-     * Returns the minimum key in the tree or subtree.
-     * @returns The minimum key.
-     */
-    min(root = this.root) {
-        if (!root)
-            return;
-        while (root.left) {
-            root = root.left;
-        }
-        return root.key;
-    }
-    /**
-     * Returns the maximum key in the tree or subtree.
-     * @returns The maximum key.
-     */
-    max(root = this.root) {
-        if (!root)
-            return;
-        while (root.right) {
-            root = root.right;
-        }
-        return root.key;
-    }
-    /**
-     * Returns the largest key that is less than a given key.
-     * @param key The given key
-     * @returns {?K} The largest key found or `undefined`.
-     */
-    lowerBound(key) {
-        if (!this.root)
-            return;
-        // Splay on the key to move the node with the given key or the last
-        // node on the search path to the top of the tree.
-        this.splay(key);
-        // Now the result is either the root node or the greatest node in
-        // the left subtree.
-        if (this.cmp(this.root.key, key) < 0) {
-            return this.root.key;
-        }
-        else if (this.root.left) {
-            return this.max(this.root.left);
-        }
-    }
-    /**
-     * This is the simplified top-down splaying method proposed by Sleator and Tarjan in {@link https://doi.org/10.1145%2F3828.3835 Self-Adjusting Binary Search Trees}.
-     * @param key
-     * @see {@link https://doi.org/10.1145%2F3828.3835 Self-Adjusting Binary Search Trees}
-     */
-    splay(key) {
-        if (!this.root)
-            return;
-        let stub, left, right;
-        stub = left = right = new Node(null, null);
-        let root = this.root;
-        while (true) {
-            const rank = this.cmp(key, root.key);
-            if (rank < 0) {
-                if (!root.left) {
-                    break;
-                }
-                if (this.cmp(key, root.left.key) < 0) {
-                    // Rotate right.
-                    const tmp = root.left;
-                    root.left = tmp.right;
-                    tmp.right = root;
-                    root = tmp;
-                    if (!root.left) {
-                        break;
-                    }
-                }
-                // Link right.
-                right.left = root;
-                right = root;
-                root = root.left;
-            }
-            else if (rank > 0) {
-                if (!root.right) {
-                    break;
-                }
-                if (this.cmp(key, root.right.key) > 0) {
-                    // Rotate left.
-                    const tmp = root.right;
-                    root.right = tmp.left;
-                    tmp.left = root;
-                    root = tmp;
-                    if (!root.right) {
-                        break;
-                    }
-                }
-                // Link left.
-                left.right = root;
-                left = root;
-                root = root.right;
-            }
-            else {
-                break;
-            }
-        }
-        // Assemble.
-        left.right = root.left;
-        right.left = root.right;
-        root.left = stub.right;
-        root.right = stub.left;
-        this.root = root;
-    }
-    add(key) {
-        this.insert(key, null, false);
-    }
-    /**
-     * Returns `true` if the given key is in the tree.
-     * @param {K} key The key to find.
-     * @returns `true` if found.
-     */
-    contains(key) {
-        return this.findNode(key) !== undefined;
-    }
-    /** Alias of remove but returns `true` if the key was found instead of the deleted value. */
-    delete(key) {
-        const size = this.count;
-        this.remove(key);
-        return this.count < size;
-    }
-    clear() {
-        if (!this.root)
-            return;
-        this.root.left = undefined;
-        this.root.right = undefined;
-        this.root = undefined;
-        this.count = 0;
-    }
-    /**
-     * Returns an ordered iterable of all the keys in the tree.
-     * @returns {Iterable<K>} An iterable of keys in-order.
-     */
-    *keys() {
-        for (const node of traverse(this.root)) {
-            yield node.key;
-        }
-    }
-    /**
-     * Returns an ordered iterable of all the keys and values in the tree.
-     * @returns {Iterable<[K,V]>} A iterable of `[key, value]` pairs sorted by key.
-     */
-    *entries() {
-        for (const node of traverse(this.root)) {
-            yield [node.key, node.value];
-        }
-    }
-    /**
-     * Returns an ordered iterable of all the values in the tree.
-     * @returns {Iterable<V>} An iterable of values sorted by key.
-     */
-    *values() {
-        for (const node of traverse(this.root)) {
-            yield node.value;
-        }
-    }
-}

package/dist/collections/Trie.d.ts

@@ -1,42 +0,0 @@
-import { Collection } from './abc.js';
-/**
- * A Trie is a tree for efficient storing and retrieval of strings such as words in a dictionary. They are useful for checking all the strings that have a common prefix.
- * Insertions, lookups and removals in `O(s)` where `s` is the search term.
- * @see {@link https://en.wikipedia.org/wiki/Trie Trie}
- */
-export declare class Trie extends Collection {
-    private root;
-    private count;
-    constructor(words?: string[]);
-    /**
-     * Adds the given string to the tree.
-     * @param word A string
-     */
-    add(word: string): this;
-    /**
-     * Removes the given string from the tree.
-     * @param word The string to remove
-     * @returns {boolean} Returns `true` if the string was found and removed.
-     */
-    remove(word: string): boolean;
-    private findNode;
-    /**
-     * Generates all results that start with the given string.
-     * @param word A prefix string
-     * @param {number} [limit] The number of results to return. Defaults to every result.
-     */
-    matches: (word: string, limit?: number) => Generator<string>;
-    /**
-     * Returns `true` if the given string is found in the tree.
-     * @param {string} word
-     */
-    contains(word: string): boolean;
-    /**
-     * Removes all strings from the tree.
-     */
-    clear(): void;
-    /**
-     * Returns the total number of strings in the tree.
-     */
-    get size(): number;
-}

package/dist/collections/Trie.js

@@ -1,104 +0,0 @@
-import { itake } from '../itertools/index.js';
-import { Collection } from './abc.js';
-function* traverse(root, prefix) {
-    const stack = [[root, prefix]];
-    while (stack.length) {
-        const [node, path] = stack.pop();
-        if (node.isWord)
-            yield path;
-        for (const key of Object.keys(node).reverse()) {
-            stack.push([node[key], path + key]);
-        }
-    }
-}
-/**
- * A Trie is a tree for efficient storing and retrieval of strings such as words in a dictionary. They are useful for checking all the strings that have a common prefix.
- * Insertions, lookups and removals in `O(s)` where `s` is the search term.
- * @see {@link https://en.wikipedia.org/wiki/Trie Trie}
- */
-export class Trie extends Collection {
-    root = Object.create(null);
-    count = 0;
-    constructor(words) {
-        super();
-        if (words) {
-            for (const word of words) {
-                this.add(word);
-            }
-        }
-    }
-    /**
-     * Adds the given string to the tree.
-     * @param word A string
-     */
-    add(word) {
-        let current = this.root;
-        for (let i = 0; i < word.length; i++) {
-            const c = word[i];
-            if (!current[c])
-                current[c] = Object.create(null);
-            current = current[c];
-        }
-        if (!current.isWord)
-            this.count++;
-        // Set as end of the word
-        Object.defineProperty(current, 'isWord', {
-            value: true,
-            enumerable: false,
-            writable: true
-        });
-        return this;
-    }
-    /**
-     * Removes the given string from the tree.
-     * @param word The string to remove
-     * @returns {boolean} Returns `true` if the string was found and removed.
-     */
-    remove(word) {
-        const node = this.findNode(word);
-        if (!node?.isWord)
-            return false;
-        node.isWord = false;
-        this.count--;
-        return true;
-    }
-    findNode(word) {
-        let node = this.root;
-        for (let i = 0; i < word.length && node; i++) {
-            const letter = word[i];
-            node = node[letter];
-        }
-        return node;
-    }
-    /**
-     * Generates all results that start with the given string.
-     * @param word A prefix string
-     * @param {number} [limit] The number of results to return. Defaults to every result.
-     */
-    matches = function* (word, limit) {
-        const node = this.findNode(word);
-        if (node)
-            yield* itake(limit ?? Infinity, traverse(node, word));
-    };
-    /**
-     * Returns `true` if the given string is found in the tree.
-     * @param {string} word
-     */
-    contains(word) {
-        const node = this.findNode(word);
-        return !!node?.isWord;
-    }
-    /**
-     * Removes all strings from the tree.
-     */
-    clear() {
-        this.root = Object.create(null);
-        this.count = 0;
-    }
-    /**
-     * Returns the total number of strings in the tree.
-     */
-    get size() {
-        return this.count;
-    }
-}

package/dist/collections/abc.d.ts

@@ -1,152 +0,0 @@
-/**
- * A container type that provides contains().
- *
- *
- * @interface Container
- */
-export interface Container {
-    contains: (x: any) => boolean;
-}
-/**
- * Implements an equality check between two values.
- * @interface Ordered
- */
-export interface Equals {
-    eq: (other: any) => boolean;
-}
-/**
- * Implements an iterable that allows comparing two elements to determine ordering.
- * @interface Ordered
- */
-export interface Comparable {
-    compare: (other: any) => number;
-}
-/**
- * Implements an iterable that allows sorting elements.
- * @interface Ordered
- */
-export interface Ordered<T> {
-    lt: (other: any) => boolean;
-}
-/**
- * Implements an iterable that allows backward iteration.
- * @interface Reversible
- */
-export interface Reversible<T = any> {
-    reversed: () => Iterable<T>;
-}
-/**
- * A `Collection` is an iterable {@link Container} type.
- * This is an abstract base class for user-defined collection types.
- *
- *
- * @abstract
- * @class Collection
- * @implements {Container}
- */
-export declare abstract class Collection implements Container {
-    /**
-     * Adds a new item to the collection.
-     * @param item - The item to add to the collection.
-     */
-    abstract add(item: any): any;
-    /**
-     * Checks if item is present in the collection.
-     * @param item - The item to search for in the collection.
-     * @returns `true` when the element is found, else `false`
-     */
-    abstract contains(item: any): boolean;
-    /**
-     * Remove all items from the collection
-     */
-    abstract clear(): any;
-    /**
-     * Returns the total number of elements in the collection.
-     */
-    abstract get size(): number;
-    get length(): number;
-    /**
-     * Check if there are no items.
-     * @returns {boolean} `true` if is empty.
-     */
-    empty(): boolean;
-}
-/**
- * A sequence is an iterable {@link Collection} type with efficient index-based access.
- * @abstract
- * @class Sequence
- * @extends {Collection}
- * @template V
- */
-export declare abstract class Sequence<V = any, K = any> extends Collection {
-    /**
-     * Return the item at the given key or index
-     * @param {K} key
-     * @memberof Sequence
-     */
-    abstract get(key: K): any;
-    /**
-     * Set a new value at the given key or index
-     *
-     * @param {K} key
-     * @param {V} value
-     * @memberof Sequence
-     */
-    abstract set(key: K, value: V): any;
-    /**
-     * Adds a new item to the end of the sequence. Alias of {@link Collection.add}.
-     *
-     * @param {V} x
-     * @memberof Sequence
-     */
-    abstract append(x: V | Iterable<V>): any;
-    /**
-     * Remove a given value from the collection if exists.
-     * @returns the value that was removed or `undefined`.
-     */
-    abstract remove(x: V): any;
-    /**
-     * Returns an iterator of all the `keys` in order.
-     */
-    abstract keys(): Iterable<K>;
-    /**
-     * Returns an iterator of all the `values` in order.
-     */
-    abstract values(): Iterable<V>;
-    /**
-     * Returns an iterator of all the `[key, value]` pairs in order.
-     */
-    abstract entries(): Iterable<[K, V]>;
-}
-/**
- * A mapping is a {@link Collection} indexed by keys that may have associated values.
- * @abstract
- * @class Mapping
- * @extends {Collection}
- * @template K, V
- */
-export declare abstract class Mapping<K, V> extends Collection {
-    /**
-     * Returns the value for the given key, or return `defaults` if not found.
-     * @param {K} key
-     * @param {*} [defaults]
-     */
-    abstract get(key: K, defaults?: any): V | undefined;
-    /**
-     * Sets the value for the given key.
-     * @param {K} key
-     */
-    abstract set(key: K, value: V): any;
-    /**
-     * Returns an iterator of all the `keys` in the map.
-     */
-    abstract keys(): Iterable<K>;
-    /**
-     * Returns an iterator of all the `values` in the map.
-     */
-    abstract values(): Iterable<V>;
-    /**
-     * Returns an iterator of all the `[key, value]` pairs in the map.
-     */
-    abstract entries(): Iterable<[K, V]>;
-}

package/dist/collections/abc.js

@@ -1,39 +0,0 @@
-/**
- * A `Collection` is an iterable {@link Container} type.
- * This is an abstract base class for user-defined collection types.
- *
- *
- * @abstract
- * @class Collection
- * @implements {Container}
- */
-export class Collection {
-    get length() {
-        return this.size;
-    }
-    /**
-     * Check if there are no items.
-     * @returns {boolean} `true` if is empty.
-     */
-    empty() {
-        return !this.size;
-    }
-}
-/**
- * A sequence is an iterable {@link Collection} type with efficient index-based access.
- * @abstract
- * @class Sequence
- * @extends {Collection}
- * @template V
- */
-export class Sequence extends Collection {
-}
-/**
- * A mapping is a {@link Collection} indexed by keys that may have associated values.
- * @abstract
- * @class Mapping
- * @extends {Collection}
- * @template K, V
- */
-export class Mapping extends Collection {
-}

package/dist/collections/frozenset.d.ts

@@ -1,19 +0,0 @@
-/**
- * Returns a new immutable Set object with elements from `iterable`. Its contents cannot be altered after it's created.
- *
- *
- * @class FrozenSet
- * @extends {Set<T>}
- * @template T
- */
-export declare class FrozenSet<T = any> extends Set<T> {
-    constructor(iterable: Iterable<T>);
-    /** @private */
-    add(): this;
-    /** @private */
-    delete(): boolean;
-    /** @private */
-    clear(): this;
-    /** @private */
-    freeze(): Readonly<this>;
-}