123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
import type { RMap } from '../../../collection-types/map/index.ts';import { List } from '../../../list/mod.ts';import {  OrderedMapBase,  OrderedMapContextImpl,  type OrderedMapCreators,} from '../../../ordered/map-custom/index.ts';import type { Stream, Streamable } from '../../../stream/mod.ts';
/** * A type-invariant immutable Ordered Map of key type K, and value type V. * In the Map, each key has exactly one value, and the Map cannot contain * duplicate keys. * See the [Map documentation](https://rimbu.org/docs/collections/map) and the [OrderedMap API documentation](https://rimbu.org/api/rimbu/ordered/map/OrderedMap/interface) * @note * - The OrderedMap keeps maintains the insertion order of elements, thus * iterators and streams will also reflect this order. * - The OrderedMap wraps around a Map instance, thus has mostly the same time complexity * as the contained Map. * - The OrderedMap keeps the key insertion order in a List, thus its space complexity * is higher than a regular Map. * @typeparam K - the key type * @typeparam V - the value type * @example * ```ts * const m1 = OrderedHashMap.empty<number, string>() * const m2 = OrderedHashMap.of([1, 'a'], [2, 'b']) * ``` */export interface OrderedMap<K, V>  extends OrderedMapBase<K, V, OrderedMap.Types> {}
export namespace OrderedMap {  /**   * A non-empty type-invariant immutable Ordered Map of key type K, and value type V.   * In the Map, each key has exactly one value, and the Map cannot contain   * duplicate keys.   * See the [Map documentation](https://rimbu.org/docs/collections/map) and the [OrderedMap API documentation](https://rimbu.org/api/rimbu/ordered/map/OrderedMap/interface)   * @note   * - The OrderedMap keeps maintains the insertion order of elements, thus   * iterators and streams will also reflect this order.   * - The OrderedMap wraps around a Map instance, thus has mostly the same time complexity   * as the contained Map.   * - The OrderedMap keeps the key insertion order in a List, thus its space complexity   * is higher than a regular Map.   * @typeparam K - the key type   * @typeparam V - the value type   * @example   * ```ts   * const m1 = OrderedHashMap.empty<number, string>()   * const m2 = OrderedHashMap.of([1, 'a'], [2, 'b'])   * ```   */  export interface NonEmpty<K, V>    extends OrderedMapBase.NonEmpty<K, V, OrderedMap.Types>,      Omit<OrderedMap<K, V>, keyof OrderedMapBase.NonEmpty<any, any, any>>,      Streamable.NonEmpty<readonly [K, V]> {    stream(): Stream.NonEmpty<readonly [K, V]>;  }
  /**   * A mutable `OrderedMap` builder used to efficiently create new immutable instances.   * See the [Map documentation](https://rimbu.org/docs/collections/map) and the [OrderedMap.Builder API documentation](https://rimbu.org/api/rimbu/ordered/map/OrderedMap/Builder/interface)   * @typeparam K - the key type   * @typeparam V - the value type   */  export interface Builder<K, V>    extends OrderedMapBase.Builder<K, V, OrderedMap.Types> {}
  /**   * A context instance for an `OrderedMap` that acts as a factory for every instance of this   * type of collection.   * @typeparam UK - the upper key type bound for which the context can be used   */  export interface Context<UK> extends OrderedMapBase.Context<UK> {}
  /**   * Utility interface that provides higher-kinded types for this collection.   */  export interface Types extends OrderedMapBase.Types {    readonly normal: OrderedMap<this['_K'], this['_V']>;    readonly nonEmpty: OrderedMap.NonEmpty<this['_K'], this['_V']>;    readonly context: OrderedMap.Context<this['_K']>;    readonly builder: OrderedMap.Builder<this['_K'], this['_V']>;    readonly sourceContext: RMap.Context<this['_K']>;    readonly sourceMap: RMap<this['_K'], this['_V']>;    readonly sourceMapNonEmpty: RMap.NonEmpty<this['_K'], this['_V']>;  }}
export const OrderedMap: OrderedMapCreators = {  createContext<UK>(options: {    listContext?: List.Context;    mapContext: RMap.Context<UK>;  }): OrderedMap.Context<UK> {    return Object.freeze(      new OrderedMapContextImpl<UK>(        options.listContext ?? List.defaultContext(),        options.mapContext      )    ) as any;  },};