/** * @since 2.0.0 */ import * as Equal from "./Equal.js" import * as Dual from "./Function.js" import { pipe } from "./Function.js" import * as Hash from "./Hash.js" import { format, type Inspectable, NodeInspectSymbol, toJSON } from "./Inspectable.js" import * as Option from "./Option.js" import type { Order } from "./Order.js" import type { Pipeable } from "./Pipeable.js" import { pipeArguments } from "./Pipeable.js" import { hasProperty } from "./Predicate.js" import * as RBT from "./RedBlackTree.js" import type * as Types from "./Types.js" const TypeId: unique symbol = Symbol.for("effect/SortedMap") /** * @since 2.0.0 * @category symbol */ export type TypeId = typeof TypeId /** * @since 2.0.0 * @category models */ export interface SortedMap extends Iterable<[K, V]>, Equal.Equal, Pipeable, Inspectable { readonly [TypeId]: { readonly _K: Types.Invariant readonly _V: Types.Covariant } /** @internal */ readonly tree: RBT.RedBlackTree } const SortedMapProto: Omit, "tree"> = { [TypeId]: { _K: (_: any) => _, _V: (_: never) => _ }, [Hash.symbol](this: SortedMap): number { return pipe( Hash.hash(this.tree), Hash.combine(Hash.hash("effect/SortedMap")), Hash.cached(this) ) }, [Equal.symbol](this: SortedMap, that: unknown): boolean { return isSortedMap(that) && Equal.equals(this.tree, that.tree) }, [Symbol.iterator](this: SortedMap): Iterator<[K, V]> { return this.tree[Symbol.iterator]() }, toString() { return format(this.toJSON()) }, toJSON() { return { _id: "SortedMap", values: Array.from(this).map(toJSON) } }, [NodeInspectSymbol]() { return this.toJSON() }, pipe() { return pipeArguments(this, arguments) } } const makeImpl = (tree: RBT.RedBlackTree): SortedMap => { const self = Object.create(SortedMapProto) self.tree = tree return self } /** * @since 2.0.0 * @category refinements */ export const isSortedMap: { /** * @since 2.0.0 * @category refinements */ (u: Iterable): u is SortedMap /** * @since 2.0.0 * @category refinements */ (u: unknown): u is SortedMap } = (u: unknown): u is SortedMap => hasProperty(u, TypeId) /** * @since 2.0.0 * @category constructors */ export const empty = (ord: Order): SortedMap => makeImpl(RBT.empty(ord)) /** * Creates a new `SortedMap` from an iterable collection of key/value pairs. * * @since 2.0.0 * @category constructors */ export const fromIterable: { /** * Creates a new `SortedMap` from an iterable collection of key/value pairs. * * @since 2.0.0 * @category constructors */ (ord: Order): (iterable: Iterable) => SortedMap /** * Creates a new `SortedMap` from an iterable collection of key/value pairs. * * @since 2.0.0 * @category constructors */ (iterable: Iterable, ord: Order): SortedMap } = Dual.dual( 2, (iterable: Iterable, ord: Order): SortedMap => makeImpl(RBT.fromIterable(iterable, ord)) ) /** * @since 2.0.0 * @category constructors */ export const make = (ord: Order) => >(...entries: Entries): SortedMap< K, Entries[number] extends (readonly [any, infer V]) ? V : never > => fromIterable(ord)(entries) /** * @since 2.0.0 * @category predicates */ export const isEmpty = (self: SortedMap): boolean => size(self) === 0 /** * @since 2.0.0 * @category predicates */ export const isNonEmpty = (self: SortedMap): boolean => size(self) > 0 /** * @since 2.0.0 * @category elements */ export const get: { /** * @since 2.0.0 * @category elements */ (key: K): (self: SortedMap) => Option.Option /** * @since 2.0.0 * @category elements */ (self: SortedMap, key: K): Option.Option } = Dual.dual< (key: K) => (self: SortedMap) => Option.Option, (self: SortedMap, key: K) => Option.Option >(2, (self, key) => RBT.findFirst(self.tree, key)) /** * Gets the `Order` that the `SortedMap` is using. * * @since 2.0.0 * @category getters */ export const getOrder = (self: SortedMap): Order => RBT.getOrder(self.tree) /** * @since 2.0.0 * @category elements */ export const has: { /** * @since 2.0.0 * @category elements */ (key: K): (self: SortedMap) => boolean /** * @since 2.0.0 * @category elements */ (self: SortedMap, key: K): boolean } = Dual.dual< (key: K) => (self: SortedMap) => boolean, (self: SortedMap, key: K) => boolean >(2, (self, key) => Option.isSome(get(self, key))) /** * @since 2.0.0 * @category elements */ export const headOption = (self: SortedMap): Option.Option<[K, V]> => RBT.first(self.tree) /** * @since 2.0.0 * @category mapping */ export const map: { /** * @since 2.0.0 * @category mapping */ (f: (a: A, k: K) => B): (self: SortedMap) => SortedMap /** * @since 2.0.0 * @category mapping */ (self: SortedMap, f: (a: A, k: K) => B): SortedMap } = Dual.dual< (f: (a: A, k: K) => B) => (self: SortedMap) => SortedMap, (self: SortedMap, f: (a: A, k: K) => B) => SortedMap >(2, (self: SortedMap, f: (a: A, k: K) => B) => reduce( self, empty(RBT.getOrder(self.tree)), (acc, v, k) => set(acc, k, f(v, k)) )) /** * @since 2.0.0 * @category folding */ export const reduce: { /** * @since 2.0.0 * @category folding */ (zero: B, f: (acc: B, value: A, key: K) => B): (self: SortedMap) => B /** * @since 2.0.0 * @category folding */ (self: SortedMap, zero: B, f: (acc: B, value: A, key: K) => B): B } = Dual.dual< (zero: B, f: (acc: B, value: A, key: K) => B) => (self: SortedMap) => B, (self: SortedMap, zero: B, f: (acc: B, value: A, key: K) => B) => B >(3, (self, zero, f) => RBT.reduce(self.tree, zero, f)) /** * @since 2.0.0 * @category elements */ export const remove: { /** * @since 2.0.0 * @category elements */ (key: K): (self: SortedMap) => SortedMap /** * @since 2.0.0 * @category elements */ (self: SortedMap, key: K): SortedMap } = Dual.dual< (key: K) => (self: SortedMap) => SortedMap, (self: SortedMap, key: K) => SortedMap >(2, (self, key) => makeImpl(RBT.removeFirst(self.tree, key))) /** * @since 2.0.0 * @category elements */ export const set: { /** * @since 2.0.0 * @category elements */ (key: K, value: V): (self: SortedMap) => SortedMap /** * @since 2.0.0 * @category elements */ (self: SortedMap, key: K, value: V): SortedMap } = Dual.dual< (key: K, value: V) => (self: SortedMap) => SortedMap, (self: SortedMap, key: K, value: V) => SortedMap >(3, (self, key, value) => RBT.has(self.tree, key) ? makeImpl(RBT.insert(RBT.removeFirst(self.tree, key), key, value)) : makeImpl(RBT.insert(self.tree, key, value))) /** * @since 2.0.0 * @category getters */ export const size = (self: SortedMap): number => RBT.size(self.tree) /** * @since 2.0.0 * @category getters */ export const keys = (self: SortedMap): IterableIterator => RBT.keys(self.tree) /** * @since 2.0.0 * @category getters */ export const values = (self: SortedMap): IterableIterator => RBT.values(self.tree) /** * @since 2.0.0 * @category getters */ export const entries = (self: SortedMap): IterableIterator<[K, V]> => { const iterator: any = self.tree[Symbol.iterator]() iterator[Symbol.iterator] = () => entries(self) return iterator } /** * @since 3.1.0 * @category elements */ export const lastOption = (self: SortedMap): Option.Option<[K, V]> => RBT.last(self.tree) /** * @since 3.1.0 * @category filtering */ export const partition: { /** * @since 3.1.0 * @category filtering */ (predicate: (a: Types.NoInfer) => boolean): (self: SortedMap) => [excluded: SortedMap, satisfying: SortedMap] /** * @since 3.1.0 * @category filtering */ (self: SortedMap, predicate: (a: K) => boolean): [excluded: SortedMap, satisfying: SortedMap] } = Dual.dual( 2, ( self: SortedMap, predicate: (a: K) => boolean ): [excluded: SortedMap, satisfying: SortedMap] => { const ord = RBT.getOrder(self.tree) let right = empty(ord) let left = empty(ord) for (const value of self) { if (predicate(value[0])) { right = set(right, value[0], value[1]) } else { left = set(left, value[0], value[1]) } } return [left, right] } )