@rimbu/multiset/dist/esm/main/interface/hashed/interface.d.mts

An immutable Set where each element can occur multiple times

import { HashMap } from '@rimbu/hashed/map';
import type { Stream, Streamable } from '@rimbu/stream';
import { type MultiSetBase } from '@rimbu/multiset/custom';
import type { HashMultiSetCreators } from '@rimbu/multiset/custom';
/**
 * A type-invariant immutable MultiSet of value type T.
 * In the MultiSet, each value can occur multiple times.
 * See the [MultiSet documentation](https://rimbu.org/docs/collections/multiset) and the [HashMultiSet API documentation](https://rimbu.org/api/rimbu/multiset/HashMultiSet/interface)
 * @typeparam T - the value type
 * @note
 * - The `HashMultiSet` uses the contexts' `HashMap` `mapContext` to hash
 * the values.
 * @example
 * ```ts
 * const m1 = HashMultiSet.empty<string>()
 * const m2 = HashMultiSet.of('a', 'b', 'a', 'c')
 * ```
 */
export interface HashMultiSet<T> extends MultiSetBase<T, HashMultiSet.Types> {
}
export declare namespace HashMultiSet {
    /**
     * A type-invariant immutable MultiSet of value type T.
     * In the MultiSet, each value can occur multiple times.
     * See the [MultiSet documentation](https://rimbu.org/docs/collections/multiset) and the [HashMultiSet API documentation](https://rimbu.org/api/rimbu/multiset/HashMultiSet/interface)
     * @typeparam T - the value type
     * @note
     * - The `HashMultiSet` uses the contexts' `HashMap` `mapContext` to hash
     * the values.
     * @example
     * ```ts
     * const m1 = HashMultiSet.empty<string>()
     * const m2 = HashMultiSet.of('a', 'b', 'a', 'c')
     * ```
     */
    interface NonEmpty<T> extends MultiSetBase.NonEmpty<T, HashMultiSet.Types>, Omit<HashMultiSet<T>, keyof MultiSetBase.NonEmpty<any, any>>, Streamable.NonEmpty<T> {
        stream(): Stream.NonEmpty<T>;
    }
    /**
     * A context instance for an `HashMultiSet` that acts as a factory for every instance of this
     * type of collection.
     * @typeparam UT - the upper value type bound for which the context can be used
     */
    interface Context<UT> extends MultiSetBase.Context<UT, HashMultiSet.Types> {
        readonly typeTag: 'HashMultiSet';
    }
    /**
     * A mutable `HashMultiSet` builder used to efficiently create new immutable instances.
     * See the [MultiSet documentation](https://rimbu.org/docs/collections/multiset) and the [HashMultiSet.Builder API documentation](https://rimbu.org/api/rimbu/multiset/HashMultiSet/Builder/interface)
     * @typeparam T - the value type
     */
    interface Builder<T> extends MultiSetBase.Builder<T, HashMultiSet.Types> {
    }
    /**
     * Utility interface that provides higher-kinded types for this collection.
     */
    interface Types extends MultiSetBase.Types {
        readonly normal: HashMultiSet<this['_T']>;
        readonly nonEmpty: HashMultiSet.NonEmpty<this['_T']>;
        readonly context: HashMultiSet.Context<this['_T']>;
        readonly builder: HashMultiSet.Builder<this['_T']>;
        readonly countMap: HashMap<this['_T'], number>;
        readonly countMapNonEmpty: HashMap.NonEmpty<this['_T'], number>;
        readonly countMapContext: HashMap.Context<this['_T']>;
    }
}
/**
 * The default `HashMultiSet` creators and context.
 *
 * Use this exported value to create and work with immutable `HashMultiSet` instances.
 * See the [MultiSet documentation](https://rimbu.org/docs/collections/multiset) and the
 * [HashMultiSet API documentation](https://rimbu.org/api/rimbu/multiset/HashMultiSet/interface).
 */
export declare const HashMultiSet: HashMultiSetCreators;