StrongStrongMap.mjs

/*
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
/**
 * @file
 * This is generated code.  Do not edit.
 *
 * Generator: https://github.com/ajvincent/composite-collection/
 * Template: Strong/Map
 * @license MPL-2.0
 * @author Alexander J. Vincent <ajvincent@gmail.com>
 * @copyright © 2021-2022 Alexander J. Vincent
 */
import KeyHasher from "./keys/Hasher.mjs";
class StrongStrongMap {
    /**
     * @typedef __StrongStrongMap_valueAndKeySet__
     * @property {*}   value  The actual value we store.
     * @property {*[]} keySet The set of keys we hashed.
     */
    /**
     * The root map holding keys and values.
     *
     * @type {Map<string, __StrongStrongMap_valueAndKeySet__>}
     * @constant
     */
    #root = new Map;
    /**
     * @type {KeyHasher}
     * @constant
     */
    #hasher = new KeyHasher();
    constructor(iterable) {
        if (iterable) {
            for (const [key1, key2, value] of iterable) {
                this.set(key1, key2, value);
            }
        }
    }
    /**
     * The number of elements in this collection.
     *
     * @returns {number} The element count.
     * @public
     * @constant
     */
    get size() {
        return this.#root.size;
    }
    /**
     * Clear the collection.
     *
     * @public
     */
    clear() {
        this.#root.clear();
    }
    /**
     * Delete an element from the collection by the given key sequence.
     *
     * @param {*} key1 The first key.
     * @param {*} key2 The second key.
     * @returns {boolean} True if we found the value and deleted it.
     * @public
     */
    delete(key1, key2) {
        const __hash__ = this.#hasher.getHashIfExists(key1, key2);
        return __hash__ ? this.#root.delete(__hash__) : false;
    }
    /**
     * Yield the key-value tuples of the collection.
     *
     * @yields {*[]} The keys and values.
     * @public
     */
    *entries() {
        for (const __valueAndKeySet__ of this.#root.values()) {
            yield [
                ...__valueAndKeySet__.keySet,
                __valueAndKeySet__.value
            ];
        }
    }
    /**
     * An user-provided callback to .forEach().
     *
     * @callback __StrongStrongMap_ForEachCallback__
     * @param {*}               value          The value.
     * @param {*}               key1           The first key.
     * @param {*}               key2           The second key.
     * @param {StrongStrongMap} __collection__ This collection.
     */
    /**
     * Iterate over the keys and values.
     *
     * @param {__StrongStrongMap_ForEachCallback__} __callback__ A function to invoke for each iteration.
     * @param {object}                              __thisArg__  Value to use as this when executing callback.
     * @public
     */
    forEach(__callback__, __thisArg__) {
        this.#root.forEach((__valueAndKeySet__) => {
            const __args__ = [
                __valueAndKeySet__.value,
                ...__valueAndKeySet__.keySet,
                this
            ];
            __callback__.apply(__thisArg__, __args__);
        });
    }
    /**
     * Get a value for a key set.
     *
     * @param {*} key1 The first key.
     * @param {*} key2 The second key.
     * @returns {*?} The value.  Undefined if it isn't in the collection.
     * @public
     */
    get(key1, key2) {
        const __hash__ = this.#hasher.getHashIfExists(key1, key2);
        if (!__hash__)
            return undefined;
        const __valueAndKeySet__ = this.#root.get(__hash__);
        return __valueAndKeySet__?.value;
    }
    /**
     * Provide a default value for .getDefault().
     *
     * @callback __StrongStrongMap_GetDefaultCallback__
     * @returns {*} The value.
     */
    /**
     * Guarantee a value for a key set.
     *
     * @param {*}                                      key1        The first key.
     * @param {*}                                      key2        The second key.
     * @param {__StrongStrongMap_GetDefaultCallback__} __default__ A function to provide a default value if necessary.
     * @returns {*} The value.
     * @public
     */
    getDefault(key1, key2, __default__) {
        const __hash__ = this.#hasher.getHash(key1, key2);
        {
            const __valueAndKeySet__ = this.#root.get(__hash__);
            if (__valueAndKeySet__)
                return __valueAndKeySet__.value;
        }
        const __keySet__ = [key1, key2];
        Object.freeze(__keySet__);
        const value = __default__();
        this.#root.set(__hash__, { value, keySet: __keySet__ });
        return value;
    }
    /**
     * Report if the collection has a value for a key set.
     *
     * @param {*} key1 The first key.
     * @param {*} key2 The second key.
     * @returns {boolean} True if the key set refers to a value in the collection.
     * @public
     */
    has(key1, key2) {
        const __hash__ = this.#hasher.getHashIfExists(key1, key2);
        return __hash__ ? this.#root.has(__hash__) : false;
    }
    /**
     * Yield the key sets of the collection.
     *
     * @yields {*[]} The key sets.
     * @public
     */
    *keys() {
        for (const __valueAndKeySet__ of this.#root.values()) {
            const [key1, key2] = __valueAndKeySet__.keySet;
            yield [key1, key2];
        }
    }
    /**
     * Set a value for a key set.
     *
     * @param {*} key1  The first key.
     * @param {*} key2  The second key.
     * @param {*} value The value.
     * @returns {StrongStrongMap} This collection.
     * @public
     */
    set(key1, key2, value) {
        const __hash__ = this.#hasher.getHash(key1, key2);
        const __keySet__ = [key1, key2];
        Object.freeze(__keySet__);
        this.#root.set(__hash__, { value, keySet: __keySet__ });
        return this;
    }
    /**
     * Yield the values of the collection.
     *
     * @yields {*} The value.
     * @public
     */
    *values() {
        for (const __valueAndKeySet__ of this.#root.values())
            yield __valueAndKeySet__.value;
    }
    [Symbol.iterator]() {
        return this.entries();
    }
    [Symbol.toStringTag] = "StrongStrongMap";
}
Object.freeze(StrongStrongMap);
Object.freeze(StrongStrongMap.prototype);
export default StrongStrongMap;
//# sourceMappingURL=StrongStrongMap.mjs.map