/** * @since 2.0.0 */ import type { Chunk } from "./Chunk.js"; import type { Equal } from "./Equal.js"; import type { Inspectable } from "./Inspectable.js"; import type { Option } from "./Option.js"; import type { Order } from "./Order.js"; import type { Pipeable } from "./Pipeable.js"; import type * as Types from "./Types.js"; declare const TypeId: unique symbol; /** * @since 2.0.0 * @category symbol */ export type TypeId = typeof TypeId; /** * @since 2.0.0 * @category constants */ export declare const Direction: { readonly Forward: RedBlackTree.Direction; readonly Backward: RedBlackTree.Direction; }; /** * A Red-Black Tree. * * @since 2.0.0 * @category models */ export interface RedBlackTree extends Iterable<[Key, Value]>, Equal, Pipeable, Inspectable { readonly [TypeId]: { readonly _Key: Types.Invariant; readonly _Value: Types.Covariant; }; } /** * @since 2.0.0 */ export declare namespace RedBlackTree { /** * @since 2.0.0 */ type Direction = number & { readonly Direction: unique symbol; }; } /** * @since 2.0.0 * @category refinements */ export declare const isRedBlackTree: { /** * @since 2.0.0 * @category refinements */ (u: Iterable): u is RedBlackTree; /** * @since 2.0.0 * @category refinements */ (u: unknown): u is RedBlackTree; }; /** * Creates an empty `RedBlackTree`. * * @since 2.0.0 * @category constructors */ export declare const empty: (ord: Order) => RedBlackTree; /** * Creates a new `RedBlackTree` from an iterable collection of key/value pairs. * * @since 2.0.0 * @category constructors */ export declare const fromIterable: { /** * Creates a new `RedBlackTree` from an iterable collection of key/value pairs. * * @since 2.0.0 * @category constructors */ (ord: Order): (entries: Iterable) => RedBlackTree; /** * Creates a new `RedBlackTree` from an iterable collection of key/value pairs. * * @since 2.0.0 * @category constructors */ (entries: Iterable, ord: Order): RedBlackTree; }; /** * Constructs a new `RedBlackTree` from the specified entries. * * @since 2.0.0 * @category constructors */ export declare const make: (ord: Order) => >(...entries: Entries) => RedBlackTree; /** * Returns an iterator that points to the element at the specified index of the * tree. * * **Note**: The iterator will run through elements in order. * * @since 2.0.0 * @category traversing */ export declare const at: { /** * Returns an iterator that points to the element at the specified index of the * tree. * * **Note**: The iterator will run through elements in order. * * @since 2.0.0 * @category traversing */ (index: number): (self: RedBlackTree) => Iterable<[K, V]>; /** * Returns an iterator that points to the element at the specified index of the * tree. * * **Note**: The iterator will run through elements in order. * * @since 2.0.0 * @category traversing */ (self: RedBlackTree, index: number): Iterable<[K, V]>; }; /** * Returns an iterator that points to the element at the specified index of the * tree. * * **Note**: The iterator will run through elements in reverse order. * * @since 2.0.0 * @category traversing */ export declare const atReversed: { /** * Returns an iterator that points to the element at the specified index of the * tree. * * **Note**: The iterator will run through elements in reverse order. * * @since 2.0.0 * @category traversing */ (index: number): (self: RedBlackTree) => Iterable<[K, V]>; /** * Returns an iterator that points to the element at the specified index of the * tree. * * **Note**: The iterator will run through elements in reverse order. * * @since 2.0.0 * @category traversing */ (self: RedBlackTree, index: number): Iterable<[K, V]>; }; /** * Finds all values in the tree associated with the specified key. * * @since 2.0.0 * @category elements */ export declare const findAll: { /** * Finds all values in the tree associated with the specified key. * * @since 2.0.0 * @category elements */ (key: K): (self: RedBlackTree) => Chunk; /** * Finds all values in the tree associated with the specified key. * * @since 2.0.0 * @category elements */ (self: RedBlackTree, key: K): Chunk; }; /** * Finds the first value in the tree associated with the specified key, if it exists. * * @category elements * @since 2.0.0 */ export declare const findFirst: { /** * Finds the first value in the tree associated with the specified key, if it exists. * * @category elements * @since 2.0.0 */ (key: K): (self: RedBlackTree) => Option; /** * Finds the first value in the tree associated with the specified key, if it exists. * * @category elements * @since 2.0.0 */ (self: RedBlackTree, key: K): Option; }; /** * Returns the first entry in the tree, if it exists. * * @since 2.0.0 * @category getters */ export declare const first: (self: RedBlackTree) => Option<[K, V]>; /** * Returns the element at the specified index within the tree or `None` if the * specified index does not exist. * * @since 2.0.0 * @category elements */ export declare const getAt: { /** * Returns the element at the specified index within the tree or `None` if the * specified index does not exist. * * @since 2.0.0 * @category elements */ (index: number): (self: RedBlackTree) => Option<[K, V]>; /** * Returns the element at the specified index within the tree or `None` if the * specified index does not exist. * * @since 2.0.0 * @category elements */ (self: RedBlackTree, index: number): Option<[K, V]>; }; /** * Gets the `Order` that the `RedBlackTree` is using. * * @since 2.0.0 * @category getters */ export declare const getOrder: (self: RedBlackTree) => Order; /** * Returns an iterator that traverse entries in order with keys greater than the * specified key. * * @since 2.0.0 * @category traversing */ export declare const greaterThan: { /** * Returns an iterator that traverse entries in order with keys greater than the * specified key. * * @since 2.0.0 * @category traversing */ (key: K): (self: RedBlackTree) => Iterable<[K, V]>; /** * Returns an iterator that traverse entries in order with keys greater than the * specified key. * * @since 2.0.0 * @category traversing */ (self: RedBlackTree, key: K): Iterable<[K, V]>; }; /** * Returns an iterator that traverse entries in reverse order with keys greater * than the specified key. * * @since 2.0.0 * @category traversing */ export declare const greaterThanReversed: { /** * Returns an iterator that traverse entries in reverse order with keys greater * than the specified key. * * @since 2.0.0 * @category traversing */ (key: K): (self: RedBlackTree) => Iterable<[K, V]>; /** * Returns an iterator that traverse entries in reverse order with keys greater * than the specified key. * * @since 2.0.0 * @category traversing */ (self: RedBlackTree, key: K): Iterable<[K, V]>; }; /** * Returns an iterator that traverse entries in order with keys greater than or * equal to the specified key. * * @since 2.0.0 * @category traversing */ export declare const greaterThanEqual: { /** * Returns an iterator that traverse entries in order with keys greater than or * equal to the specified key. * * @since 2.0.0 * @category traversing */ (key: K): (self: RedBlackTree) => Iterable<[K, V]>; /** * Returns an iterator that traverse entries in order with keys greater than or * equal to the specified key. * * @since 2.0.0 * @category traversing */ (self: RedBlackTree, key: K): Iterable<[K, V]>; }; /** * Returns an iterator that traverse entries in reverse order with keys greater * than or equal to the specified key. * * @since 2.0.0 * @category traversing */ export declare const greaterThanEqualReversed: { /** * Returns an iterator that traverse entries in reverse order with keys greater * than or equal to the specified key. * * @since 2.0.0 * @category traversing */ (key: K): (self: RedBlackTree) => Iterable<[K, V]>; /** * Returns an iterator that traverse entries in reverse order with keys greater * than or equal to the specified key. * * @since 2.0.0 * @category traversing */ (self: RedBlackTree, key: K): Iterable<[K, V]>; }; /** * Finds the item with key, if it exists. * * @since 2.0.0 * @category elements */ export declare const has: { /** * Finds the item with key, if it exists. * * @since 2.0.0 * @category elements */ (key: K): (self: RedBlackTree) => boolean; /** * Finds the item with key, if it exists. * * @since 2.0.0 * @category elements */ (self: RedBlackTree, key: K): boolean; }; /** * Insert a new item into the tree. * * @since 2.0.0 */ export declare const insert: { /** * Insert a new item into the tree. * * @since 2.0.0 */ (key: K, value: V): (self: RedBlackTree) => RedBlackTree; /** * Insert a new item into the tree. * * @since 2.0.0 */ (self: RedBlackTree, key: K, value: V): RedBlackTree; }; /** * Get all the keys present in the tree in order. * * @since 2.0.0 * @category getters */ export declare const keys: (self: RedBlackTree) => IterableIterator; /** * Get all the keys present in the tree in reverse order. * * @since 2.0.0 * @category getters */ export declare const keysReversed: (self: RedBlackTree) => IterableIterator; /** * Returns the last entry in the tree, if it exists. * * @since 2.0.0 * @category getters */ export declare const last: (self: RedBlackTree) => Option<[K, V]>; /** * Returns an iterator that traverse entries in order with keys less than the * specified key. * * @since 2.0.0 * @category traversing */ export declare const lessThan: { /** * Returns an iterator that traverse entries in order with keys less than the * specified key. * * @since 2.0.0 * @category traversing */ (key: K): (self: RedBlackTree) => Iterable<[K, V]>; /** * Returns an iterator that traverse entries in order with keys less than the * specified key. * * @since 2.0.0 * @category traversing */ (self: RedBlackTree, key: K): Iterable<[K, V]>; }; /** * Returns an iterator that traverse entries in reverse order with keys less * than the specified key. * * @since 2.0.0 * @category traversing */ export declare const lessThanReversed: { /** * Returns an iterator that traverse entries in reverse order with keys less * than the specified key. * * @since 2.0.0 * @category traversing */ (key: K): (self: RedBlackTree) => Iterable<[K, V]>; /** * Returns an iterator that traverse entries in reverse order with keys less * than the specified key. * * @since 2.0.0 * @category traversing */ (self: RedBlackTree, key: K): Iterable<[K, V]>; }; /** * Returns an iterator that traverse entries in order with keys less than or * equal to the specified key. * * @since 2.0.0 * @category traversing */ export declare const lessThanEqual: { /** * Returns an iterator that traverse entries in order with keys less than or * equal to the specified key. * * @since 2.0.0 * @category traversing */ (key: K): (self: RedBlackTree) => Iterable<[K, V]>; /** * Returns an iterator that traverse entries in order with keys less than or * equal to the specified key. * * @since 2.0.0 * @category traversing */ (self: RedBlackTree, key: K): Iterable<[K, V]>; }; /** * Returns an iterator that traverse entries in reverse order with keys less * than or equal to the specified key. * * @since 2.0.0 * @category traversing */ export declare const lessThanEqualReversed: { /** * Returns an iterator that traverse entries in reverse order with keys less * than or equal to the specified key. * * @since 2.0.0 * @category traversing */ (key: K): (self: RedBlackTree) => Iterable<[K, V]>; /** * Returns an iterator that traverse entries in reverse order with keys less * than or equal to the specified key. * * @since 2.0.0 * @category traversing */ (self: RedBlackTree, key: K): Iterable<[K, V]>; }; /** * Execute the specified function for each node of the tree, in order. * * @since 2.0.0 * @category traversing */ export declare const forEach: { /** * Execute the specified function for each node of the tree, in order. * * @since 2.0.0 * @category traversing */ (f: (key: K, value: V) => void): (self: RedBlackTree) => void; /** * Execute the specified function for each node of the tree, in order. * * @since 2.0.0 * @category traversing */ (self: RedBlackTree, f: (key: K, value: V) => void): void; }; /** * Visit each node of the tree in order with key greater then or equal to max. * * @since 2.0.0 * @category traversing */ export declare const forEachGreaterThanEqual: { /** * Visit each node of the tree in order with key greater then or equal to max. * * @since 2.0.0 * @category traversing */ (min: K, f: (key: K, value: V) => void): (self: RedBlackTree) => void; /** * Visit each node of the tree in order with key greater then or equal to max. * * @since 2.0.0 * @category traversing */ (self: RedBlackTree, min: K, f: (key: K, value: V) => void): void; }; /** * Visit each node of the tree in order with key lower then max. * * @since 2.0.0 * @category traversing */ export declare const forEachLessThan: { /** * Visit each node of the tree in order with key lower then max. * * @since 2.0.0 * @category traversing */ (max: K, f: (key: K, value: V) => void): (self: RedBlackTree) => void; /** * Visit each node of the tree in order with key lower then max. * * @since 2.0.0 * @category traversing */ (self: RedBlackTree, max: K, f: (key: K, value: V) => void): void; }; /** * Visit each node of the tree in order with key lower than max and greater * than or equal to min. * * @since 2.0.0 * @category traversing */ export declare const forEachBetween: { /** * Visit each node of the tree in order with key lower than max and greater * than or equal to min. * * @since 2.0.0 * @category traversing */ (options: { readonly min: K; readonly max: K; readonly body: (key: K, value: V) => void; }): (self: RedBlackTree) => void; /** * Visit each node of the tree in order with key lower than max and greater * than or equal to min. * * @since 2.0.0 * @category traversing */ (self: RedBlackTree, options: { readonly min: K; readonly max: K; readonly body: (key: K, value: V) => void; }): void; }; /** * Reduce a state over the entries of the tree. * * @since 2.0.0 * @category folding */ export declare const reduce: { /** * Reduce a state over the entries of the tree. * * @since 2.0.0 * @category folding */ (zero: Z, f: (accumulator: Z, value: V, key: K) => Z): (self: RedBlackTree) => Z; /** * Reduce a state over the entries of the tree. * * @since 2.0.0 * @category folding */ (self: RedBlackTree, zero: Z, f: (accumulator: Z, value: V, key: K) => Z): Z; }; /** * Removes the entry with the specified key, if it exists. * * @since 2.0.0 */ export declare const removeFirst: { /** * Removes the entry with the specified key, if it exists. * * @since 2.0.0 */ (key: K): (self: RedBlackTree) => RedBlackTree; /** * Removes the entry with the specified key, if it exists. * * @since 2.0.0 */ (self: RedBlackTree, key: K): RedBlackTree; }; /** * Traverse the tree in reverse order. * * @since 2.0.0 * @category traversing */ export declare const reversed: (self: RedBlackTree) => Iterable<[K, V]>; /** * Returns the size of the tree. * * @since 2.0.0 * @category getters */ export declare const size: (self: RedBlackTree) => number; /** * Get all values present in the tree in order. * * @since 2.0.0 * @category getters */ export declare const values: (self: RedBlackTree) => IterableIterator; /** * Get all values present in the tree in reverse order. * * @since 2.0.0 * @category getters */ export declare const valuesReversed: (self: RedBlackTree) => IterableIterator; export {}; //# sourceMappingURL=RedBlackTree.d.ts.map