/core/mod.ts | rimbu@1.0.3

import * as rimbu from "https://deno.land/x/rimbu@1.0.3/core/mod.ts";

Namespaces

N ArrowGraph
N ArrowGraphHashed
N ArrowGraphSorted
N ArrowValuedGraph
N ArrowValuedGraphHashed
N ArrowValuedGraphSorted
N AsyncOptLazy
N AsyncReducer
N AsyncStream
N AsyncStreamable
N AsyncStreamSource
N AsyncTransformer
N BiMap
N BiMultiMap
N CollectFun
N Comp
N Deep
N Deep.Match
N Deep.Patch
N Deep.Path
N Deep.Path.Internal
N Deep.Path.Result
N Deep.Selector
N EdgeGraph
N EdgeGraphHashed
N EdgeGraphSorted
N EdgeValuedGraph
N EdgeValuedGraphHashed
N EdgeValuedGraphSorted
N Eq
N ErrBase
N Graph
N HashBiMultiMap
N Hasher
N HashMap
N HashMultiMapHashValue
N HashMultiMapSortedValue
N HashMultiSet
N HashSet
N HashTableHashColumn
N HashTableSortedColumn
N IndexRange
N List
N MultiMap
N MultiSet
N OrderedHashMap
N OrderedHashSet
N OrderedMap
N OrderedSet
N OrderedSortedMap
N OrderedSortedSet
N ProximityMap
N Range
N Reducer
N RMap
N RSet
N SortedBiMultiMap
N SortedMap
N SortedMultiMapHashValue
N SortedMultiMapSortedValue
N SortedMultiSet
N SortedSet
N SortedTableHashColumn
N SortedTableSortedColumn
N Stream
N Streamable
N StreamSource
N Table
N Transformer
N Traverse
N Tuple
N ValuedGraph
N VariantGraph
N VariantMap
N VariantMultiMap
N VariantMultiSet
N VariantSet
N VariantTable
N VariantValuedGraph

Classes

c AsyncReducer.Base	A base class that can be used to easily create `AsyncReducer` instances.
c BlockBuilderBase abstract
c CollisionBuilderBase abstract
c ErrBase.CustomError abstract	A custom error instance.
c ErrBase.ForcedError
c Reducer.Base	A base class that can be used to easily create `Reducer` instances.

Variables

v ArrowGraph
v ArrowGraphHashed
v ArrowGraphSorted
v ArrowValuedGraph
v ArrowValuedGraphHashed
v ArrowValuedGraphSorted
v AsyncReducer.and	Returns an `AsyncReducer` that takes boolean values and outputs true if all input values are true, and false otherwise.
v AsyncReducer.average	A `Reducer` that calculates the average of all given numberic input values.
v AsyncReducer.count	Returns an `AsyncReducer` that remembers the amount of input items provided.
v AsyncReducer.first	Returns an `AsyncReducer` that remembers the first input value.
v AsyncReducer.firstWhere	Returns an `AsyncReducer` that remembers the first input value for which the given `pred` function returns true.
v AsyncReducer.isEmpty	Returns an `AsyncReducer` that outputs true if no input values are received, false otherwise.
v AsyncReducer.last	Returns an `AsyncReducer` that remembers the last input value.
v AsyncReducer.lastWhere	Returns an `AsyncReducer` that remembers the last input value for which the given `pred` function returns true.
v AsyncReducer.max	Returns a `Reducer` that remembers the maximum value of the numberic inputs.
v AsyncReducer.maxBy	Returns a `Reducer` that remembers the maximum value of the inputs using the given `compFun` to compare input values
v AsyncReducer.min	Returns a `Reducer` that remembers the minimum value of the numberic inputs.
v AsyncReducer.minBy	Returns a `Reducer` that remembers the minimum value of the inputs using the given `compFun` to compare input values
v AsyncReducer.nonEmpty	Returns an `AsyncReducer` that outputs true if one or more input values are received, false otherwise.
v AsyncReducer.or	Returns an `AsyncReducer` that takes boolean values and outputs true if one or more input values are true, and false otherwise.
v AsyncReducer.product	A `Reducer` that calculates the product of all given numeric input values.
v AsyncReducer.sum	A `Reducer` that sums all given numeric input values.
v AsyncStream
v AsyncTransformer.window	Returns an async transformer that produces windows/collections of `windowSize` size, each window starting `skipAmount` of elements after the previous, and optionally collected by a custom reducer.
v BiMap
v BiMultiMap
v CollectFun.Skip	Indicates, when returned from a collect function, to skip the value.
v Deep.Path.stringSplitRegex	Regular expression used to split a path string into tokens.
v EdgeGraph
v EdgeGraphHashed
v EdgeGraphSorted
v EdgeValuedGraph
v EdgeValuedGraphHashed
v EdgeValuedGraphSorted
v Eq.objectIs	An Eq instance that uses `Object.is` to determine if two objects are equal.
v HashBiMultiMap
v HashMap
v HashMultiMapHashValue
v HashMultiMapSortedValue
v HashMultiSet
v HashSet
v HashTableHashColumn
v HashTableSortedColumn
v List
v MultiMap
v MultiSet
v OrderedHashMap
v OrderedHashSet
v OrderedMap
v OrderedSet
v OrderedSortedMap
v OrderedSortedSet
v ProximityMap
v Reducer.and	Returns a `Reducer` that takes boolean values and outputs true if all input values are true, and false otherwise.
v Reducer.average	A `Reducer` that calculates the average of all given numberic input values.
v Reducer.count	Returns a `Reducer` that remembers the amount of input items provided.
v Reducer.first	Returns a `Reducer` that remembers the first input value.
v Reducer.firstWhere	Returns a `Reducer` that remembers the first input value for which the given `pred` function returns true.
v Reducer.isEmpty	Returns a `Reducer` that outputs true if no input values are received, false otherwise.
v Reducer.last	Returns a `Reducer` that remembers the last input value.
v Reducer.lastWhere	Returns a `Reducer` that remembers the last input value for which the given `pred` function returns true.
v Reducer.max	Returns a `Reducer` that remembers the maximum value of the numberic inputs.
v Reducer.maxBy	Returns a `Reducer` that remembers the maximum value of the inputs using the given `compFun` to compare input values
v Reducer.min	Returns a `Reducer` that remembers the minimum value of the numberic inputs.
v Reducer.minBy	Returns a `Reducer` that remembers the minimum value of the inputs using the given `compFun` to compare input values
v Reducer.nonEmpty	Returns a `Reducer` that outputs true if one or more input values are received, false otherwise.
v Reducer.or	Returns a `Reducer` that takes boolean values and outputs true if one or more input values are true, and false otherwise.
v Reducer.product	A `Reducer` that calculates the product of all given numeric input values.
v Reducer.sum	A `Reducer` that sums all given numeric input values.
v SortedBiMultiMap
v SortedMap
v SortedMultiMapHashValue
v SortedMultiMapSortedValue
v SortedMultiSet
v SortedSet
v SortedTableHashColumn
v SortedTableSortedColumn
v Stream
v Table
v Transformer.window	Returns a transformer that produces windows/collections of `windowSize` size, each window starting `skipAmount` of elements after the previous, and optionally collected by a custom reducer.

Functions

f AsyncOptLazy.toMaybePromise	Returns the value or promised value contained in an `AsyncOptLazy` instance of type T.
f AsyncOptLazy.toPromise	Returns the value contained in an `AsyncOptLazy` instance of type T as a promise.
f AsyncReducer.combineArr	Returns an `AsyncReducer` that combines multiple input `reducers` by providing input values to all of them and collecting the outputs in an array.
f AsyncReducer.combineObj	Returns an `AsyncReducer` that combines multiple input `reducers` by providing input values to all of them and collecting the outputs in the shape of the given object.
f AsyncReducer.contains	Returns an `AsyncReducer` that outputs false as long as the given `elem` has not been encountered in the input values, true otherwise.
f AsyncReducer.create	Returns an `AsyncReducer` with the given options:
f AsyncReducer.createMono	Returns an `AsyncReducer` of which the input, state, and output types are the same.
f AsyncReducer.createOutput	Returns an `AsyncReducer` of which the state and output types are the same.
f AsyncReducer.every	Returns an `AsyncReducer` that ouputs true as long as all input values satisfy the given `pred`, false otherwise.
f AsyncReducer.from
f AsyncReducer.join	Returns a `Reducer` that joins the given input values into a string using the given options.
f AsyncReducer.some	Returns a `Reducer` that ouputs false as long as no input value satisfies given `pred`, true otherwise.
f AsyncReducer.toArray	Returns an `AsyncReducer` that collects received input values in an array, and returns a copy of that array as an output value when requested.
f AsyncReducer.toJSMap	Returns a `AsyncReducer` that collects received input tuples into a mutable JS Map, and returns a copy of that map when output is requested.
f AsyncReducer.toJSObject	Returns an `AsyncReducer` that collects 2-tuples containing keys and values into a plain JS object, and returns a copy of that object when output is requested.
f AsyncReducer.toJSSet	Returns an `AsyncReducer` that collects received input values into a mutable JS Set, and returns a copy of that map when output is requested.
f AsyncTransformer.distinctPrevious	Returns an async transformer that returns only those elements from the input that are different to previous element according to the optionally given `eq` function.
f Comp.anyDeepComp	Returns a Comp instance that compares any value using default comparison functions. For Iterables and objects, their elements are compared recursively.
f Comp.anyFlatComp	Returns a Comp instance that compares any value using default comparison functions, but never recursively compares Iterables or objects. In those cases, it will use the stringComp instance.
f Comp.anyShallowComp	Returns a Comp instance that compares any value using default comparison functions. For Iterables and objects, their elements are compared only one level deep for performance and to avoid infinite recursion.
f Comp.anyStringJSONComp	Returns a Comp instance converts values to string with JSON.stringify, and orders the resulting string naturally.
f Comp.anyToStringComp	Returns a any Comp instance that orders any according to their toString values.
f Comp.bigIntComp	Returns a default bigint Comp instance that orders bigint numbers naturally.
f Comp.booleanComp	Returns a default boolean Comp instance that orders booleans according to false < true.
f Comp.createValueOfComp	Returns a Comp instance that orders objects with a `valueOf` method according to the given `valueComp` instance for the valueOf values.
f Comp.dateComp	Returns a Date Comp instance that orders Dates according to their `.valueOf` value.
f Comp.defaultComp	Returns the default Comp instance, which is the Comp.anyDeepComp() instance.
f Comp.invert	Returns a Comp instance the reverses the order of the given `comp` instance.
f Comp.iterableComp	Returns a Comp instance for Iterable objects that orders the Iterables by comparing the elements with the given `itemComp` Comp instance.
f Comp.numberComp	Returns a default number Comp instance that orders numbers naturally.
f Comp.objectComp	Returns a Comp instance for objects that orders the object keys according to the given `keyComp`, and then compares the corresponding values using the given `valueComp`. Objects are then compared as follows: starting with the smallest key of either object: if only one of the objects has the key, the object with the key is considered to be larger than the other if both objects have the key, the values are compared with `valueComp`. If the values are not equal, this result is returned.
f Comp.stringCaseInsensitiveComp	Returns a `Comp` instance that compares strings in a case-insensitive way.
f Comp.stringCharCodeComp	Returns a string Comp instance that orders strings according to their indexed char codes.
f Comp.stringComp	Returns a `Comp` instance that compares strings based on the string's `localeCompare` method.
f Comp.toEq	Returns an `Eq` equality instance thet will return true when the given `comp` comparable instance returns 0.
f Comp.withNull	Returns a Comp instance that extends the given `comp` instance with the capability to handle `null` values, where null is considered to be smaller than any other value, and equal to another null.
f Comp.withUndefined	Returns a Comp instance that extends the given `comp` instance with the capability to handle `undefined` values, where undefined is considered to be smaller than any other value, and equal to another undefined.
f Deep.getAt	Returns the value resulting from selecting the given `path` in the given `source` object. It supports optional chaining for nullable values or values that may be undefined, and also for accessing objects inside an array. There is currently no support for forcing non-null (the `!` operator).
f Deep.getAtWith	Returns a function that gets the value at the given string `path` inside an object.
f Deep.match	Returns true if the given `value` object matches the given `matcher`, false otherwise.
f Deep.matchAt	Returns true if the given `value` object matches the given `matcher` at the given `path`, false otherwise.
f Deep.matchAtWith	Returns a function that matches a given `value` with the given `matcher` at the given string `path`.
f Deep.matchWith	Returns a function that matches a given `value` with the given `matcher`.
f Deep.patch	Returns an immutably updated version of the given `value` where the given `patchItems` have been applied to the result. The Rimbu patch notation is as follows: if the target is a simple value or array, the patch can be the same type or a function returning the same type if the target is a tuple (array of fixed length), the patch be the same type or an object containing numeric keys with patches indicating the tuple index to patch if the target is an object, the patch can be the same type, or an array containing partial keys with their patches for the object
f Deep.patchAt	Patches the value at the given path in the source to the given value. Because the path to update must exist in the `source` object, optional chaining and array indexing is not allowed.
f Deep.patchAtWith	Returns a function that patches a given `value` with the given `patchItems` at the given `path`.
f Deep.patchWith	Returns a function that patches a given `source` with the given `patchItems`.
f Deep.Path.stringSplit	Return the given `path` string split into an array of subpaths.
f Deep.protect	Returns the same value wrapped in the `Protected` type.
f Deep.select	Returns the result of applying the given `selector` shape to the given `source` value.
f Deep.selectAt	Returns the result of applying the given `selector` shape to the given `source` value.
f Deep.selectAtWith	Returns a function that selects a certain shape from a given `value` with the given `selector` at the given string `path`.
f Deep.selectWith	Returns a function that selects a certain shape from a given `value` with the given `selector`.
f Deep.withType	Returns a curried API with a known target type. This can be useful for using the methods in contexts where the target type can be inferred from the usage.
f Eq.anyDeepEq	Returns an Eq instance that checks equality of any values. For composed values (objects and iterables) it will recursively compare the contained values.
f Eq.anyFlatEq	Returns an Eq instance that checks equality of any values. For composed values (objects and iterables) it will compare with Object.is.
f Eq.anyJsonEq	Returns an Eq instance that considers values equal their JSON.stringify values are equal.
f Eq.anyShallowEq	Returns an Eq instance that checks equality of any values. For composed values (objects and iterables) it will enter 1 level, and if again compound values are found, they are compared with Object.is.
f Eq.anyToStringEq
f Eq.convertAnyToString
f Eq.createStringCollatorEq	Returns an Eq instance that considers strings equal taking the given or default locale into account.
f Eq.dateEq	Returns an Eq instance that compares Date objects according to their `valueOf` value.
f Eq.defaultEq	Returns the default Eq instance, which is the Eq.anyDeepEq() instance.
f Eq.iterableEq	Returns an Eq instance that compares Iterables by comparing their elements with the given `itemEq` Eq instance.
f Eq.objectEq	Returns an Eq instance that checks equality of objects containing property values of type V by iteratively applying given `valueEq` to each of the object's property values.
f Eq.stringCaseInsentitiveEq	Returns an Eq instance that considers strings equal regardless of their case.
f Eq.stringCharCodeEq	Returns an Eq instance that considers strings equal when all their charcodes are equal.
f Eq.tupleSymmetric	Returns an `Eq` instance for tuples that considers two tuples [A, B] and [C, D] equal if [A, B] equals [C, D], or if [A, B] equals [D, C]
f Eq.valueOfEq	Returns an Eq instance for objects that have a `valueOf` method. It returns true if the `.valueOf` values of both given objects are equal.
f Err	Throws an `Err.ForcedError` error when called.
f ErrBase.msg	Returns a function that, when called, throws an `Err.ForcedError` with the given `message` string.
f Hasher.anyDeepHasher	Returns a Hasher instance that hashes any value, and traverses into an object or array to hash its elements.
f Hasher.anyFlatHasher	Returns a Hasher instance that hashes any value, but never traverses into an object or array to hash its elements. In those cases it will use toString.
f Hasher.anyJsonStringHasher	Returns a Hasher instance that hashes any value by hashing the string resulting from applying JSON.stringify to the value.
f Hasher.anyShallowHasher	Returns a Hasher instance that hashes any value, but only traverses into an object or array to hash its elements one level deep. After one level, it will use toString.
f Hasher.anyToStringHasher	Returns a Hasher instance that hashes the string representation of any value
f Hasher.arrayHasher	Returns a Hasher that hashes arrays of elements by sampling the array and using the given `itemHasher` to hash the sampled elements.
f Hasher.bigintHasher	Returns a Hasher instance that hashes bigints.
f Hasher.booleanHasher	Returns a Hasher instance that hashes booleans.
f Hasher.createValueOfHasher	Returns a Hasher instance that hashes the `.valueOf` value of the given object using the given `valueHasher` for instances of given `cls` class.
f Hasher.dateHasher	Returns a Hasher instance that hashes Dates.
f Hasher.defaultHasher
f Hasher.numberHasher	Returns a Hasher instance that hashes numbers, including 'special' values like NaN and infinities.
f Hasher.objectDeepHasher	Returns a Hasher instance that hashes objects of key type K and value type V. If a value if an object or array, it will recursively hash its values.
f Hasher.objectHasher	Returns a Hasher instance that hashes objects of key type K and value type V.
f Hasher.objectShallowHasher	Returns a Hasher instance that hashes objects of key type K and value type V. If a value if an object or array, it will convert those values to a string.
f Hasher.streamSourceHasher	Returns a Hasher instance that hashes any StreamSource limited to a certain amount of elements to prevent haning on infinite streams.
f Hasher.stringCaseInsensitiveHasher
f Hasher.stringHasher	Returns a Hasher instance for string values.
f Hasher.tupleSymmetric	Returns a Hasher that will return equal hash values for values in a tuple regardless of their order, and uses the given `hasher` function to hash the tuple elements.
f IndexRange.getIndexRangeIndices	Returns, given the `range` `IndexRange`, a normalized tuple containing the start index, and optionally an end index.
f IndexRange.getIndicesFor	Returns, given the `range` `IndexRange`, and a target maximum `length`, the actual index range. This can be one of three options: 'empty': there are no elements within the range 'all': all elements are within the range [start: number, end: number]: an inclusive range of element indices within the given range
f OptLazy	Returns the value contained in an `OptLazy` instance of type T.
f OptLazyOr	Returns the value contained in an `OptLazyOr` instance of type T, or the given `otherValue` if the lazy function returns it.
f Range.getNormalizedRange	Simplifies a given `range` `Range` input for easier processing, by returning optional start and end ranges including whether they are inclusive or exclusive
f Reducer.combineArr	Returns a `Reducer` that combines multiple input `reducers` by providing input values to all of them and collecting the outputs in an array.
f Reducer.combineObj	Returns a `Reducer` that combines multiple input `reducers` by providing input values to all of them and collecting the outputs in the shape of the given object.
f Reducer.contains	Returns a `Reducer` that outputs false as long as the given `elem` has not been encountered in the input values, true otherwise.
f Reducer.create	Returns a `Reducer` with the given options:
f Reducer.createMono	Returns a `Reducer` of which the input, state, and output types are the same.
f Reducer.createOutput	Returns a `Reducer` of which the state and output types are the same.
f Reducer.every	Returns a `Reducer` that ouputs true as long as all input values satisfy the given `pred`, false otherwise.
f Reducer.join	Returns a `Reducer` that joins the given input values into a string using the given options.
f Reducer.some	Returns a `Reducer` that ouputs false as long as no input value satisfies given `pred`, true otherwise.
f Reducer.toArray	Returns a `Reducer` that collects received input values in an array, and returns a copy of that array as an output value when requested.
f Reducer.toJSMap	Returns a `Reducer` that collects received input tuples into a mutable JS Map, and returns a copy of that map when output is requested.
f Reducer.toJSObject	Returns a `Reducer` that collects 2-tuples containing keys and values into a plain JS object, and returns a copy of that object when output is requested.
f Reducer.toJSSet	Returns a `Reducer` that collects received input values into a mutable JS Set, and returns a copy of that map when output is requested.
f Transformer.distinctPrevious	Returns a transformer that returns only those elements from the input that are different to previous element according to the optionally given `eq` function.
f Traverse.traverseBreadthFirstCustom	Returns a stream of connections that can be reached in the given `graph` starting at the given `startNode`, and using breadth-first traversal. It can avoid loops if needed in a custom way by supplying the `addVisitedNode` function.
f Traverse.traverseBreadthFirstHashed	Returns a stream of connections that can be reached in the given `graph` starting at the given `startNode`, and using breadth-first traversal. It avoids loops by internally placing the visited nodes in a HashSet builder.
f Traverse.traverseBreadthFirstSorted	Returns a stream of connections that can be reached in the given `graph` starting at the given `startNode`, and using breadth-first traversal. It avoids loops by internally placing the visited nodes in a SortedSet builder.
f Traverse.traverseDepthFirstCustom	Returns a stream of connections that can be reached in the given `graph` starting at the given `startNode`, and using depth-first traversal. It can avoid loops if needed in a custom way by supplying the `addVisitedNode` function.
f Traverse.traverseDepthFirstHashed	Returns a stream of connections that can be reached in the given `graph` starting at the given `startNode`, and using depth-first traversal. It avoids loops by internally placing the visited nodes in a HashSet builder.
f Traverse.traverseDepthFirstSorted	Returns a stream of connections that can be reached in the given `graph` starting at the given `startNode`, and using depth-first traversal. It avoids loops by internally placing the visited nodes in a SortedSet builder.
f TraverseState	Returns a new `TraverseState` instance, using optionally given `startIndex` as a start index value.
f Tuple.append	Returns the given `tuple` with the given `values` appended.
f Tuple.concat	Returns a Tuple containing the elements of given `tuple1` followed by the elements of given `tuple2`.
f Tuple.first	Returns the first element of a Tuple.
f Tuple.getIndex	Returns the item at the given `index` in the givn `tuple`.
f Tuple.init	Returns a Tuple containing all but the last element of the given `tuple`.
f Tuple.last	Returns the last element of a Tuple.
f Tuple.of	Convenience method to type Tuple types
f Tuple.second	Returns the second element of a Tuple.
f Tuple.tail	Returns a Tuple containing all but the first element of the given `tuple`.
f Tuple.updateAt	Returns a copy of the given `tuple` where the element at given `index` is updated with the given `updater`.
f Update	Returns the result of given `update` parameter, where it can either directly give a new value, or it is a function receiving the given `value`, and returns a new value.

Interfaces

I ArrowGraph	An type-invariant immutable arrow (directed) graph. See the Graph documentation and the ArrowGraph API documentation
I ArrowGraph.Builder	A mutable `ArrowGraph` builder used to efficiently create new immutable instances. See the Graph documentation and the ArrowGraph.Builder API documentation
I ArrowGraph.Context	The ArrowGraph's Context instance that serves as a factory for all related immutable instances and builders.
I ArrowGraph.NonEmpty	A non-empty type-invariant immutable arrow (directed) graph. See the Graph documentation and the ArrowGraph API documentation
I ArrowGraph.Types	Utility interface that provides higher-kinded types for this collection.
I ArrowGraphHashed	An type-invariant immutable valued arrow (directed) graph. The connections are internally maintained using hashed collections See the Graph documentation and the ArrowGraphHashed API documentation
I ArrowGraphHashed.Builder	A mutable `ArrowGraphHashed` builder used to efficiently create new immutable instances. See the Graph documentation and the ArrowGraphHashed.Builder API documentation
I ArrowGraphHashed.Context	The ArrowGraphHashed's Context instance that serves as a factory for all related immutable instances and builders.
I ArrowGraphHashed.NonEmpty	A non-empty type-invariant immutable valued arrow (directed) graph. The connections are internally maintained using hashed collections See the Graph documentation and the ArrowGraphHashed API documentation
I ArrowGraphHashed.Types	Utility interface that provides higher-kinded types for this collection.
I ArrowGraphSorted	An type-invariant immutable valued arrow (directed) graph. The connections are internally maintained using sorted collections See the Graph documentation and the ArrowGraphSorted API documentation
I ArrowGraphSorted.Builder	A mutable `ArrowGraphSorted` builder used to efficiently create new immutable instances. See the Graph documentation and the ArrowGraphSorted.Builder API documentation
I ArrowGraphSorted.Context	The ArrowGraphSorted's Context instance that serves as a factory for all related immutable instances and builders.
I ArrowGraphSorted.NonEmpty	A non-empty type-invariant immutable valued arrow (directed) graph. The connections are internally maintained using sorted collections See the Graph documentation and the ArrowGraphSorted API documentation
I ArrowGraphSorted.Types	Utility interface that provides higher-kinded types for this collection.
I ArrowValuedGraph	An type-invariant immutable valued arrow (directed) graph. See the Graph documentation and the ArrowValuedGraph API documentation
I ArrowValuedGraph.Builder	A mutable `ArrowValuedGraph` builder used to efficiently create new immutable instances. See the Graph documentation and the ArrowValuedGraph.Builder API documentation
I ArrowValuedGraph.Context	The ArrowValuedGraph's Context instance that serves as a factory for all related immutable instances and builders.
I ArrowValuedGraph.NonEmpty	A non-empty type-invariant immutable valued arrow (directed) graph. See the Graph documentation and the ArrowValuedGraph API documentation
I ArrowValuedGraph.Types	Utility interface that provides higher-kinded types for this collection.
I ArrowValuedGraphHashed	An type-invariant immutable valued arrow (directed) graph. The nodes are internally maintained using HashMaps See the Graph documentation and the ArrowValuedGraphHashed API documentation
I ArrowValuedGraphHashed.Builder	A mutable `ArrowValuedGraphHashed` builder used to efficiently create new immutable instances. See the Graph documentation and the ArrowValuedGraphHashed.BuilderAPI documentation
I ArrowValuedGraphHashed.Context	The ArrowValuedGraphHashed's Context instance that serves as a factory for all related immutable instances and builders.
I ArrowValuedGraphHashed.NonEmpty	A non-empty type-invariant immutable valued arrow (directed) graph. The nodes are internally maintained using HashMaps See the Graph documentation and the ArrowValuedGraphHashed API documentation
I ArrowValuedGraphHashed.Types	Utility interface that provides higher-kinded types for this collection.
I ArrowValuedGraphSorted	An type-invariant immutable valued arrow (directed) graph. The nodes are internally maintained using SortedMaps See the Graph documentation and the ArrowValuedGraphSorted API documentation
I ArrowValuedGraphSorted.Builder	A mutable `ArrowValuedGraphSorted` builder used to efficiently create new immutable instances. See the Graph documentation and the ArrowValuedGraphSorted.Builder API documentation
I ArrowValuedGraphSorted.Context	The ArrowValuedGraphSorted's Context instance that serves as a factory for all related immutable instances and builders.
I ArrowValuedGraphSorted.NonEmpty	A non-empty type-invariant immutable valued arrow (directed) graph. The nodes are internally maintained using SortedMaps See the Graph documentation and the ArrowValuedGraphSorted API documentation
I ArrowValuedGraphSorted.Types	Utility interface that provides higher-kinded types for this collection.
I AsyncFastIterable
I AsyncFastIterator
I AsyncReducer.Impl
I AsyncStream	A possibly infinite asynchronous sequence of elements of type T. See the Stream documentation and the AsyncStream API documentation
I AsyncStream.NonEmpty	A non-empty and possibly infinite asynchronous sequence of elements of type T. See the Stream documentation and the AsyncStream API documentation
I AsyncStreamable
I AsyncStreamable.NonEmpty
I BiMap	A type-invariant immutable bi-directional Map where keys and values have a one-to-one mapping. See the BiMap documentation and the BiMap API documentation
I BiMap.Builder	A mutable `BiMap` builder used to efficiently create new immutable instances. See the BiMap documentation and the BiMap.Builder API documentation
I BiMap.Context	The BiMap's Context instance that serves as a factory for all related immutable instances and builders.
I BiMap.NonEmpty	A non-empty type-invariant immutable bi-directional Map where keys and values have a one-to-one mapping. See the BiMap documentation and the BiMap API documentation * @typeparam K - the key type
I BiMap.Types	Utility interface that provides higher-kinded types for this collection.
I BiMultiMap	A type-invariant immutable bi-directional MultiMap where keys and values have a many-to-many mapping. See the BiMultiMap documentation and the BiMultiMap API documentation
I BiMultiMap.Builder	A mutable `BiMultiMap` builder used to efficiently create new immutable instances. See the BiMultiMap documentation and the BiMultiMap.Builder API documentation
I BiMultiMap.Context	The BiMultiMap's Context instance that serves as a factory for all related immutable instances and builders.
I BiMultiMap.NonEmpty	A non-empty type-invariant immutable bi-directional MultiMap where keys and values have a many-to-many mapping. See the BiMultiMap documentation and the BiMultiMap API documentation
I BiMultiMap.Types	Utility interface that provides higher-kinded types for this collection.
I Comp	An object providing methods to compare two values of type `K`.
I Deep.WithType	Typed and curried Deep API, used in situations where the target type is known but the value will be applied later.
I EdgeGraph	An type-invariant immutable edge (undirected) graph. See the Graph documentation and the EdgeGraph API documentation
I EdgeGraph.Builder	A mutable `EdgeGraph` builder used to efficiently create new immutable instances. See the Graph documentation and the EdgeGraph.Builder API documentation
I EdgeGraph.Context	The EdgeGraph's Context instance that serves as a factory for all related immutable instances and builders.
I EdgeGraph.NonEmpty	A non-empty type-invariant immutable edge (undirected) graph.
I EdgeGraph.Types	Utility interface that provides higher-kinded types for this collection.
I EdgeGraphHashed	An type-invariant immutable valued edge (undirected) graph. The connections are internally maintained using hashed collections See the Graph documentation and the EdgeGraphHashed API documentation
I EdgeGraphHashed.Builder	A mutable `EdgeGraphHashed` builder used to efficiently create new immutable instances. See the Graph documentation and the EdgeGraphHashed.Builder API documentation
I EdgeGraphHashed.Context	The EdgeGraphHashed's Context instance that serves as a factory for all related immutable instances and builders.
I EdgeGraphHashed.NonEmpty	A non-empty type-invariant immutable valued edge (undirected) graph. The connections are internally maintained using hashed collections See the Graph documentation and the EdgeGraphHashed API documentation
I EdgeGraphHashed.Types	Utility interface that provides higher-kinded types for this collection.
I EdgeGraphSorted	An type-invariant immutable valued edge (undirected) graph. The connections are internally maintained using sorted collections See the Graph documentation and the EdgeGraphSorted API documentation
I EdgeGraphSorted.Builder	A mutable `EdgeGraphSorted` builder used to efficiently create new immutable instances. See the Graph documentation and the EdgeGraphSorted.Builder API documentation
I EdgeGraphSorted.Context	The EdgeGraphSorted's Context instance that serves as a factory for all related immutable instances and builders.
I EdgeGraphSorted.NonEmpty	A non-empty type-invariant immutable valued edge (undirected) graph. The connections are internally maintained using sorted collections See the Graph documentation and the EdgeGraphSorted API documentation
I EdgeGraphSorted.Types	Utility interface that provides higher-kinded types for this collection.
I EdgeValuedGraph	An type-invariant immutable valued edge (undirected) graph. See the Graph documentation and the EdgeValuedGraph API documentation
I EdgeValuedGraph.Builder	A mutable `EdgeValuedGraph` builder used to efficiently create new immutable instances. See the Graph documentation and the EdgeValuedGraph.Builder API documentation
I EdgeValuedGraph.Context	The EdgeValuedGraph's Context instance that serves as a factory for all related immutable instances and builders.
I EdgeValuedGraph.NonEmpty	A non-empty type-invariant immutable valued edge (undirected) graph. See the Graph documentation and the EdgeValuedGraph API documentation
I EdgeValuedGraph.Types	Utility interface that provides higher-kinded types for this collection.
I EdgeValuedGraphHashed	An type-invariant immutable valued edge (undirected) graph. The nodes are internally maintained using HashMaps See the Graph documentation and the EdgeValuedGraphHashed API documentation
I EdgeValuedGraphHashed.Builder	A mutable `EdgeValuedGraphHashed` builder used to efficiently create new immutable instances. See the Graph documentation and the EdgeValuedGraphHashed.Builder API documentation
I EdgeValuedGraphHashed.Context	The EdgeValuedGraphHashed's Context instance that serves as a factory for all related immutable instances and builders.
I EdgeValuedGraphHashed.NonEmpty	A non-empty type-invariant immutable valued edge (undirected) graph. The nodes are internally maintained using HashMaps See the Graph documentation and the EdgeValuedGraphHashed API documentation
I EdgeValuedGraphHashed.Types	Utility interface that provides higher-kinded types for this collection.
I EdgeValuedGraphSorted	An type-invariant immutable valued edge (undirected) graph. The nodes are internally maintained using SortedMaps See the Graph documentation and the EdgeValuedGraphSorted API documentation
I EdgeValuedGraphSorted.Builder	A mutable `EdgeValuedGraphSorted` builder used to efficiently create new immutable instances. See the Graph documentation and the EdgeValuedGraphSorted.Builder API documentation
I EdgeValuedGraphSorted.Context	The EdgeValuedGraphSorted's Context instance that serves as a factory for all related immutable instances and builders.
I EdgeValuedGraphSorted.NonEmpty	A non-empty type-invariant immutable valued edge (undirected) graph. The nodes are internally maintained using SortedMaps See the Graph documentation and the EdgeValuedGraphSorted API documentation
I EdgeValuedGraphSorted.Types	Utility interface that provides higher-kinded types for this collection.
I FastIterable	An interface that extends the standard `Iterable` interface to return a `FastIterator` instead of a normal `Iterator`.
I FastIterator	An iterator that extends the default `Iterator` interface with methods that give more performance.
I GenSource
I Graph	An type-invariant immutable graph. See the Graph documentation and the Graph API documentation
I Graph.Builder	A mutable `Graph` builder used to efficiently create new immutable instances. See the Graph documentation and the Graph.Builder API documentation
I Graph.Context	The EdgeValuedGraGraphphSorted's Context instance that serves as a factory for all related immutable instances and builders.
I Graph.NonEmpty	A non-empty type-invariant immutable graph. See the Graph documentation and the Graph API documentation
I Graph.Types	Utility interface that provides higher-kinded types for this collection.
I HashBiMultiMap	A type-invariant immutable bi-directional MultiMap where keys and values have a many-to-many mapping. Its keys and values are hashed. See the BiMultiMap documentation and the HashBiMultiMap API documentation
I HashBiMultiMap.Builder	A mutable `HashBiMultiMap` builder used to efficiently create new immutable instances. See the BiMultiMap documentation and the HashBiMultiMap.Builder API documentation
I HashBiMultiMap.Context	The HashBiMultiMap's Context instance that serves as a factory for all related immutable instances and builders.
I HashBiMultiMap.NonEmpty	A non-empty type-invariant immutable bi-directional MultiMap where keys and values have a many-to-many mapping. Its keys and values are hashed. See the BiMultiMap documentation and the HashBiMultiMap API documentation
I HashBiMultiMap.Types	Utility interface that provides higher-kinded types for this collection.
I Hasher	Interface used to hash objects for hashed collections.
I HashMap	A type-invariant immutable 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 and the HashMap API documentation
I HashMap.Builder	A mutable `HashMap` builder used to efficiently create new immutable instances. See the Map documentation and the HashMap.Builder API documentation
I HashMap.Context	A context instance for a `HashMap` that acts as a factory for every instance of this type of collection.
I HashMap.NonEmpty	A non-empty type-invariant immutable 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 and the HashMap API documentation
I HashMap.Types	Utility interface that provides higher-kinded types for this collection.
I HashMultiMapHashValue	A type-invariant immutable MultiMap of key type K, and value type V. In the MultiMap, each key has at least one value. See the MultiMap documentation and the HashMultiMapHashValue API documentation
I HashMultiMapHashValue.Builder	A mutable `HashMultiMapHashValue` builder used to efficiently create new immutable instances. See the MultiMap documentation and the HashMultiMapHashValue.Builder API documentation
I HashMultiMapHashValue.Context	A context instance for an `HashMultiMapHashValue` that acts as a factory for every instance of this type of collection.
I HashMultiMapHashValue.NonEmpty	A non-empty type-invariant immutable MultiMap of key type K, and value type V. In the MultiMap, each key has at least one value. See the MultiMap documentation and the HashMultiMapHashValue API documentation
I HashMultiMapHashValue.Types	Utility interface that provides higher-kinded types for this collection.
I HashMultiMapSortedValue	A type-invariant immutable MultiMap of key type K, and value type V. In the MultiMap, each key has at least one value. See the MultiMap documentation and the HashMultiMapSortedValue API documentation
I HashMultiMapSortedValue.Builder	A mutable `HashMultiMapSortedValue` builder used to efficiently create new immutable instances. See the MultiMap documentation and the HashMultiMapSortedValue.Builder API documentation
I HashMultiMapSortedValue.Context	A context instance for an `HashMultiMapSortedValue` that acts as a factory for every instance of this type of collection.
I HashMultiMapSortedValue.NonEmpty	A non-empty type-invariant immutable MultiMap of key type K, and value type V. In the MultiMap, each key has at least one value. See the MultiMap documentation and the HashMultiMapSortedValue API documentation
I HashMultiMapSortedValue.Types	Utility interface that provides higher-kinded types for this collection.
I HashMultiSet	A type-invariant immutable MultiSet of value type T. In the MultiSet, each value can occur multiple times. See the MultiSet documentation and the HashMultiSet API documentation
I HashMultiSet.Builder	A mutable `HashMultiSet` builder used to efficiently create new immutable instances. See the MultiSet documentation and the HashMultiSet.Builder API documentation
I HashMultiSet.Context	A context instance for an `HashMultiSet` that acts as a factory for every instance of this type of collection.
I HashMultiSet.NonEmpty	A type-invariant immutable MultiSet of value type T. In the MultiSet, each value can occur multiple times. See the MultiSet documentation and the HashMultiSet API documentation
I HashMultiSet.Types	Utility interface that provides higher-kinded types for this collection.
I HashSet	A type-invariant immutable Set of value type T. In the Set, there are no duplicate values. See the Set documentation and the HashSet API documentation
I HashSet.Builder	A mutable `HashSet` builder used to efficiently create new immutable instances. See the Set documentation and the HashSet.Builder API documentation
I HashSet.Context	A context instance for a `HashSet` that acts as a factory for every instance of this type of collection.
I HashSet.NonEmpty	A non-empty type-invariant immutable Set of value type T. In the Set, there are no duplicate values. See the Set documentation and the HashSet API documentation
I HashSet.Types	Utility interface that provides higher-kinded types for this collection.
I HashTableHashColumn	A type-invariant immutable Table of row key type R, column key type C, and value type V. In the Table, a combination of a row and column key has exactly one value. See the Table documentation and the HashTableHashColumn API documentation
I HashTableHashColumn.Builder
I HashTableHashColumn.Context
I HashTableHashColumn.NonEmpty	A non-empty type-invariant immutable Table of row key type R, column key type C, and value type V. In the Table, a combination of a row and column key has exactly one value. See the Table documentation and the HashTableHashColumn API documentation
I HashTableHashColumn.Types	Utility interface that provides higher-kinded types for this collection.
I HashTableSortedColumn	A type-invariant immutable Table of row key type R, column key type C, and value type V. In the Table, a combination of a row and column key has exactly one value. See the Table documentation and the HashTableSortedColumn API documentation
I HashTableSortedColumn.Builder
I HashTableSortedColumn.Context
I HashTableSortedColumn.NonEmpty	A non-empty type-invariant immutable Table of row key type R, column key type C, and value type V. In the Table, a combination of a row and column key has exactly one value. See the Table documentation and the HashTableSortedColumn API documentation
I HashTableSortedColumn.Types	Utility interface that provides higher-kinded types for this collection.
I List	A random accessible immutable sequence of values of type T. See the List documentation and the List API documentation
I List.Builder	A mutable builder to create immutable `List` instances in a more efficient way. See the List documentation and the List.Builder API documentation
I List.Context	A context instance for `List` that acts as a factory for every instance of this type of collection.
I List.NonEmpty	A non-empty random accessible immutable sequence of values of type T. See the List documentation and the List API documentation
I List.Types	A utility interface to extract related List types.
I MultiMap	A type-invariant immutable MultiMap of key type K, and value type V. In the Map, each key has at least one value. See the MultiMap documentation and the MultiMap API documentation
I MultiMap.Builder	A mutable `MultiMap` builder used to efficiently create new immutable instances. See the MultiMap documentation and the MultiMap.Builder API documentation
I MultiMap.Context	A context instance for `MultiMap` implementations that acts as a factory for every instance of this type of collection.
I MultiMap.NonEmpty	A non-empty type-invariant immutable MultiMap of key type K, and value type V. In the Map, each key has at least one value. See the MultiMap documentation and the MultiMap API documentation
I MultiMap.Types	Utility interface that provides higher-kinded types for this collection.
I MultiSet	A type-invariant immutable MultiSet of value type T. In the MultiSet, each value can occur multiple times. See the MultiSet documentation and the MultiSet API documentation
I MultiSet.Builder	A mutable `MultiSet` builder used to efficiently create new immutable instances. See the MultiSet documentation and the MultiSet.Builder API documentation
I MultiSet.Context	A context instance for `MultiSet` implementations that acts as a factory for every instance of this type of collection.
I MultiSet.NonEmpty	A non-empty type-invariant immutable MultiSet of value type T. In the MultiSet, each value can occur multiple times. See the MultiSet documentation and the MultiSet API documentation
I MultiSet.Types	Utility interface that provides higher-kinded types for this collection.
I OrderedHashMap	A type-invariant immutable Ordered HashMap 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 and the OrderedHashMap API documentation
I OrderedHashMap.Builder	A mutable `OrderedHashMap` builder used to efficiently create new immutable instances. See the Map documentation and the OrderedHashMap.Builder API documentation
I OrderedHashMap.Context	A context instance for an `OrderedHashMap` that acts as a factory for every instance of this type of collection.
I OrderedHashMap.NonEmpty	A non-empty type-invariant immutable Ordered HashMap 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 and the OrderedHashMap API documentation
I OrderedHashMap.Types	Utility interface that provides higher-kinded types for this collection.
I OrderedHashSet	A type-invariant immutable Ordered HashSet of value type T. In the Set, there are no duplicate values. See the Set documentation and the OrderedHashSet API documentation
I OrderedHashSet.Builder	A mutable `OrderedHashSet` builder used to efficiently create new immutable instances. See the Set documentation and the OrderedHashSet.Builder API documentation
I OrderedHashSet.Context	A context instance for an `OrderedHashSet` that acts as a factory for every instance of this type of collection.
I OrderedHashSet.NonEmpty	A non-empty type-invariant immutable Ordered HashSet of value type T. In the Set, there are no duplicate values. See the Set documentation and the OrderedHashSet API documentation
I OrderedHashSet.Types	Utility interface that provides higher-kinded types for this collection.
I OrderedMap	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 and the OrderedMap API documentation
I OrderedMap.Builder	A mutable `OrderedMap` builder used to efficiently create new immutable instances. See the Map documentation and the OrderedMap.Builder API documentation
I OrderedMap.Context	A context instance for an `OrderedMap` that acts as a factory for every instance of this type of collection.
I OrderedMap.NonEmpty	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 and the OrderedMap API documentation
I OrderedMap.Types	Utility interface that provides higher-kinded types for this collection.
I OrderedSet	A type-invariant immutable Ordered Set of value type T. In the Set, there are no duplicate values. See the Set documentation and the OrderedSet API documentation
I OrderedSet.Builder	A mutable `OrderedSet` builder used to efficiently create new immutable instances. See the Set documentation and the OrderedSet.Builder API documentation
I OrderedSet.Context
I OrderedSet.NonEmpty	A non-empty type-invariant immutable Ordered SortedSet of value type T. In the Set, there are no duplicate values. See the Set documentation and the OrderedSet API documentation
I OrderedSet.Types	Utility interface that provides higher-kinded types for this collection.
I OrderedSortedMap	A type-invariant immutable Ordered SortedMap 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 and the OrderedSortedMap API documentation
I OrderedSortedMap.Builder	A mutable `OrderedSortedMap` builder used to efficiently create new immutable instances. See the Map documentation and the OrderedSortedMap.Builder API documentation
I OrderedSortedMap.Context	A context instance for an `OrderedSortedMap` that acts as a factory for every instance of this type of collection.
I OrderedSortedMap.NonEmpty	A non-empty type-invariant immutable Ordered SortedMap 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 and the OrderedSortedMap API documentation
I OrderedSortedMap.Types	Utility interface that provides higher-kinded types for this collection.
I OrderedSortedSet	A type-invariant immutable Ordered SortedSet of value type T. In the Set, there are no duplicate values. See the Set documentation and the OrderedSortedSet API documentation
I OrderedSortedSet.Builder	A mutable `OrderedSortedSet` builder used to efficiently create new immutable instances. See the Set documentation and the OrderedSortedSet.Builder API documentation
I OrderedSortedSet.Context	A context instance for an `OrderedSortedSet` that acts as a factory for every instance of this type of collection.
I OrderedSortedSet.NonEmpty	A non-empty type-invariant immutable Ordered SortedSet of value type T. In the Set, there are no duplicate values. See the Set documentation and the OrderedSortedSet API documentation
I OrderedSortedSet.Types	Utility interface that provides higher-kinded types for this collection.
I ProximityMap	A type-invariant immutable 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 and the ProximityMap API documentation
I ProximityMap.Builder	A mutable `ProximityMap` builder used to efficiently create new immutable instances. See the Map documentation and the ProximityMap.Builder API documentation
I ProximityMap.Context	A context instance for a `ProximityMap` that acts as a factory for every instance of this type of collection.
I ProximityMap.NonEmpty	A non-empty type-invariant immutable 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 and the ProximityMap API documentation
I ProximityMap.Types	Utility interface that provides higher-level types for this collection.
I Reducer.Impl	The Implementation interface for a `Reducer`, which also exposes the internal state type.
I RMap	A type-invariant immutable 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 and the RMap API documentation
I RMap.Builder	A mutable `RMap` builder used to efficiently create new immutable instances. See the Map documentation and the RMap.Builder API documentation
I RMap.Context	A context instance for `RMap` implementations that acts as a factory for every instance of this type of collection.
I RMap.NonEmpty	A non-empty type-invariant immutable 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 and the RMap API documentation
I RMap.Types	Utility interface that provides higher-kinded types for this collection.
I RSet	A type-invariant immutable Set of value type T. In the Set, there are no duplicate values. See the Set documentation and the RSet API documentation
I RSet.Builder	A mutable Set builder used to efficiently create new immutable instances. See the Set documentation and the RSet.Builder API documentation
I RSet.Context	A context instance for Map implementations that acts as a factory for every instance of this type of collection.
I RSet.NonEmpty	A non-empty type-invariant immutable Set of value type T. In the Set, there are no duplicate values. See the Set documentation and the RSet API documentation
I RSet.Types	Utility interface that provides higher-kinded types for this collection.
I SortedBiMultiMap	A type-invariant immutable bi-directional MultiMap where keys and values have a many-to-many mapping. Its keys and values are sorted. See the BiMultiMap documentation and the HashBiMultiMap API documentation
I SortedBiMultiMap.Builder	A mutable `SortedBiMultiMap` builder used to efficiently create new immutable instances. See the BiMultiMap documentation and the HashBiMultiMap.Builder API documentation
I SortedBiMultiMap.Context	The SortedBiMultiMap's Context instance that serves as a factory for all related immutable instances and builders.
I SortedBiMultiMap.NonEmpty	A non-empty type-invariant immutable bi-directional MultiMap where keys and values have a many-to-many mapping. Its keys and values are sorted. See the BiMultiMap documentation and the HashBiMultiMap API documentation
I SortedBiMultiMap.Types	Utility interface that provides higher-kinded types for this collection.
I SortedMap	A type-invariant immutable 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 and the SortedMap API documentation
I SortedMap.Builder	A mutable `SortedMap` builder used to efficiently create new immutable instances. See the Map documentation and the SortedMap.Builder API documentation
I SortedMap.Context	A context instance for a HashMap that acts as a factory for every instance of this type of collection.
I SortedMap.NonEmpty	A non-empty type-invariant immutable 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 and the SortedMap API documentation
I SortedMap.Types	Utility interface that provides higher-kinded types for this collection.
I SortedMultiMapHashValue	A type-invariant immutable MultiMap of key type K, and value type V. In the MultiMap, each key has at least one value. See the MultiMap documentation and the SortedMultiMapHashValue API documentation
I SortedMultiMapHashValue.Builder	A mutable `SortedMultiMapHashValue` builder used to efficiently create new immutable instances. See the MultiMap documentation and the SortedMultiMapHashValue.Builder API documentation
I SortedMultiMapHashValue.Context	A context instance for an `SortedMultiMapHashValue` that acts as a factory for every instance of this type of collection.
I SortedMultiMapHashValue.NonEmpty	A non-empty type-invariant immutable MultiMap of key type K, and value type V. In the MultiMap, each key has at least one value. See the MultiMap documentation and the SortedMultiMapHashValue API documentation
I SortedMultiMapHashValue.Types	Utility interface that provides higher-kinded types for this collection.
I SortedMultiMapSortedValue	A type-invariant immutable MultiMap of key type K, and value type V. In the MultiMap, each key has at least one value. See the MultiMap documentation and the SortedMultiMapSortedValue API documentation
I SortedMultiMapSortedValue.Builder	A mutable `SortedMultiMapSortedValue` builder used to efficiently create new immutable instances. See the MultiMap documentation and the SortedMultiMapSortedValue.Builder API documentation
I SortedMultiMapSortedValue.Context	A context instance for an `SortedMultiMapSortedValue` that acts as a factory for every instance of this type of collection.
I SortedMultiMapSortedValue.NonEmpty	A non-empty type-invariant immutable MultiMap of key type K, and value type V. In the MultiMap, each key has at least one value. See the MultiMap documentation and the SortedMultiMapSortedValue API documentation
I SortedMultiMapSortedValue.Types	Utility interface that provides higher-kinded types for this collection.
I SortedMultiSet	A type-invariant immutable MultiSet of value type T. In the MultiSet, each value can occur multiple times. See the MultiSet documentation and the SortedMultiSet API documentation
I SortedMultiSet.Builder	A mutable `SortedMultiSet` builder used to efficiently create new immutable instances. See the MultiSet documentation and the SortedMultiSet.Builder API documentation
I SortedMultiSet.Context	A context instance for an `SortedMultiSet` that acts as a factory for every instance of this type of collection.
I SortedMultiSet.NonEmpty	A type-invariant immutable MultiSet of value type T. In the MultiSet, each value can occur multiple times. See the MultiSet documentation and the SortedMultiSet API documentation
I SortedMultiSet.Types	Utility interface that provides higher-kinded types for this collection.
I SortedSet	A type-invariant immutable Set of value type T. In the Set, there are no duplicate values. See the Set documentation and the SortedSet API documentation
I SortedSet.Builder	A mutable `SortedSet` builder used to efficiently create new immutable instances. See the Set documentation and the SortedSet.Builder API documentation
I SortedSet.Context	A context instance for a `SortedSet` that acts as a factory for every instance of this type of collection.
I SortedSet.NonEmpty	A non-empty type-invariant immutable Set of value type T. In the Set, there are no duplicate values. See the Set documentation and the SortedSet API documentation
I SortedSet.Types	Utility interface that provides higher-kinded types for this collection.
I SortedTableHashColumn	A type-invariant immutable Table of row key type R, column key type C, and value type V. In the Table, a combination of a row and column key has exactly one value. See the Table documentation and the SortedTableHashColumn API documentation
I SortedTableHashColumn.Builder
I SortedTableHashColumn.Context
I SortedTableHashColumn.NonEmpty	A non-empty type-invariant immutable Table of row key type R, column key type C, and value type V. In the Table, a combination of a row and column key has exactly one value.
I SortedTableHashColumn.Types	Utility interface that provides higher-kinded types for this collection.
I SortedTableSortedColumn	A type-invariant immutable Table of row key type R, column key type C, and value type V. In the Table, a combination of a row and column key has exactly one value. See the Table documentation and the SortedTableSortedColumn API documentation
I SortedTableSortedColumn.Builder
I SortedTableSortedColumn.Context
I SortedTableSortedColumn.NonEmpty	A non-empty type-invariant immutable Table of row key type R, column key type C, and value type V. In the Table, a combination of a row and column key has exactly one value. See the Table documentation and the SortedTableSortedColumn API documentation
I SortedTableSortedColumn.Types	Utility interface that provides higher-kinded types for this collection.
I Stream	A possibly infinite sequence of elements of type T. See the Stream documentation and the Stream API documentation
I Stream.NonEmpty	A non-empty and possibly infinite sequence of elements of type T. See the Stream documentation and the Stream API documentation
I Streamable	An object that can create a Stream of elements of type `T`.
I Streamable.NonEmpty	An object that can create a non-empty Stream of elements of type `T`.
I Table	A type-invariant immutable Table of row key type R, column key type C, and value type V. In the Table, a combination of a row and column key has exactly one value. See the Table documentation and the Table API documentation
I Table.Builder	A mutable Table builder used to efficiently create new immutable instances. See the Table documentation and the Table.Builder API documentation
I Table.Context	A context instance for Table implementations that acts as a factory for every instance of this type of collection.
I Table.NonEmpty	A non-empty type-invariant immutable Table of row key type R, column key type C, and value type V. In the Table, a combination of a row and column key has exactly one value. See the Table documentation and the Table API documentation
I Table.Types	Utility interface that provides higher-kinded types for this collection.
I ToJSON	Utility type to convert some object to a JSON serializable format.
I TraverseState	An object used to track the state of a traversal, e.g. a `forEach`.
I ValuedGraph	An type-invariant immutable valued graph. See the Graph documentation and the ValuedGraph API documentation
I ValuedGraph.Builder	A mutable `ValuedGraph` builder used to efficiently create new immutable instances. See the Graph documentation and the ValuedGraph.Builder API documentation
I ValuedGraph.Context	The ValuedGraph's Context instance that serves as a factory for all related immutable instances and builders.
I ValuedGraph.NonEmpty	A non-empty type-invariant immutable valued graph. See the Graph documentation and the ValuedGraph API documentation
I ValuedGraph.Types	Utility interface that provides higher-kinded types for this collection.
I VariantGraph	An type-variant immutable graph. See the Graph documentation and the VariantGraph API documentation
I VariantGraph.NonEmpty	A non-empty type-variant immutable graph. See the Graph documentation and the VariantGraph API documentation
I VariantGraph.Types	Utility interface that provides higher-kinded types for this collection.
I VariantMap	A type-variant immutable 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 and the VariantMap API documentation
I VariantMap.NonEmpty	A non-empty type-variant 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 and the VariantMap API documentation
I VariantMap.Types	Utility interface that provides higher-kinded types for this collection.
I VariantMultiMap	A type-variant immutable MultiMap of key type K, and value type V. In the Map, each key has at least one value. See the MultiMap documentation and the VariantMultiMap API documentation
I VariantMultiMap.NonEmpty	A non-empty type-variant immutable MultiMap of key type K, and value type V. In the Map, each key has at least one value. See the MultiMap documentation and the VariantMultiMap API documentation
I VariantMultiMap.Types	Utility interface that provides higher-kinded types for this collection.
I VariantMultiSet	A type-variant immutable MultiSet of value type T. In the MultiSet, each value can occur multiple times. See the MultiSet documentation and the VariantMultiSet API documentation
I VariantMultiSet.NonEmpty	A non-empty type-variant immutable MultiSet of value type T. In the MultiSet, each value can occur multiple times. See the MultiSet documentation and the VariantMultiSet API documentation
I VariantMultiSet.Types	Utility interface that provides higher-kinded types for this collection.
I VariantSet	A type-variant immutable Set of value type T. In the Set, there are no duplicate values. See the Set documentation and the VariantSet API documentation
I VariantSet.NonEmpty	A non-empty type-variant immutable Set of value type T. In the Set, there are no duplicate values. See the Set documentation and the VariantSet API documentation
I VariantSet.Types	Utility interface that provides higher-kinded types for this collection.
I VariantTable	A type-variant immutable Table of row key type R, column key type C, and value type V. In the Table, a combination of a row and column key has exactly one value. See the Table documentation and the VariantTable API documentation
I VariantTable.NonEmpty	A non-empty type-variant immutable Table of row key type R, column key type C, and value type V. In the Table, a combination of a row and column key has exactly one value. See the Table documentation and the VariantTable API documentation
I VariantTable.Types	Utility interface that provides higher-kinded types for this collection.
I VariantValuedGraph	An type-variant immutable valued graph. See the Graph documentation and the VariantValuedGraph API documentation
I VariantValuedGraph.NonEmpty	A non-empty type-variant immutable valued graph. See the Graph documentation and the VariantValuedGraph API documentation
I VariantValuedGraph.Types	Utility interface that provides higher-kinded types for this collection.

Type Aliases

T ArrayNonEmpty	Accepts all arrays with at least one element.
T AsyncCollectFun	A potentially asynchronous function used in `collect` methods to collect values from a collection. This is basically a single-pass map and filter.
T AsyncOptLazy	A potentially lazy and/or asynchronous value of type T.
T AsyncReducer	An `AsyncReducer` is a stand-alone asynchronous calculation that takes input values of type I, and, when requested, produces an output value of type O.
T AsyncStreamSource
T AsyncStreamSource.NonEmpty
T AsyncTransformer	An AsyncReducer that produces instances of `AsyncStreamSource`.
T AsyncTransformer.NonEmpty	An AsyncReducer that produces instances `AsyncStreamSource.NonEmpty`.
T CollectFun	A function used in `collect` methods to collect values from a collection. This is basically a single-pass map and filter.
T CollectFun.Skip	Indicates, when returned from a collect function, to skip the value.
T Deep.Match	The type to determine the allowed input values for the `match` function.
T Deep.Match.Arr	The type that determines allowed matchers for arrays/tuples.
T Deep.Match.ArrayTraversalType	Keys used to indicate an array match traversal.
T Deep.Match.CompoundForArr	Defines an object containing exactly one `CompoundType` key, having an array of matchers.
T Deep.Match.CompoundForObj	Compount matcher for objects, can only be an array staring with a compound type keyword.
T Deep.Match.CompoundType	Compound keys used to indicate the type of compound.
T Deep.Match.Entry	Determines the various allowed match types for given type `T`.
T Deep.Match.FailureLog	Utility type for collecting match failure reasons
T Deep.Match.Func	Type used to determine the allowed function types. Always includes booleans.
T Deep.Match.Obj	The type that determines allowed matchers for objects.
T Deep.Match.ObjProps	The type to determine allowed matchers for object properties.
T Deep.Match.TraversalForArr	Defines an object containing exactly one `TraversalType` key, having a matcher for the array element type.
T Deep.Match.TupIndices	Type used to indicate an object containing matches for tuple indices.
T Deep.Match.WithResult	A type that either directly results in result type `S` or is a function taking the value, parent, and root values, and returns a value of type `S`.
T Deep.Patch	A type to determine the allowed input type for the `patch` function.
T Deep.Patch.Entry	The entry type for a (nested) patch. Can be either a patch object or a function accepting the nested patch function and returning a patch object.
T Deep.Patch.Func	A function patch type that is a function taking the current value, the parent and root values, and returns a return value.
T Deep.Patch.NotIterable	Utility type to exclude Iterable types.
T Deep.Patch.Obj	A type defining the allowed patch values for objects.
T Deep.Patch.ObjProps	A type defining the allowed patch values for object properties.
T Deep.Patch.Tup	A type defining the allowed patch values for tuples.
T Deep.Patch.WithResult	Either result type S, or a patch function with the value type, the parent type, and the root type.
T Deep.Path.Get	A string representing a path into an (nested) object of type T.
T Deep.Path.Internal.AppendIfNotEmpty	Utility type to only add non-empty string types to a string array.
T Deep.Path.Internal.Arr	Determines the allowed paths for an array.
T Deep.Path.Internal.Generic	Determines the allowed paths into a value of type `T`.
T Deep.Path.Internal.IsOptional	Determines whether the given type `T` is optional, that is, whether it can be null or undefined.
T Deep.Path.Internal.MaybeValue	Returns type `T` if `Maybe` is false, `T \| undefined` otherwise.
T Deep.Path.Internal.NonEmpty	Determines the allowed non-empty paths into a value of type `T`.
T Deep.Path.Internal.NonOptional	Determines the allowed paths into a non-optional value of type `T`.
T Deep.Path.Internal.Obj	Determines the allowed paths for an object.
T Deep.Path.Internal.Separator	Determines the allowed path part seperator based on the input types.
T Deep.Path.Internal.Tup	Determines the allowed paths for a tuple. Since tuples have fixed types, they do not need to be optional, in contrast to arrays.
T Deep.Path.Result	The result type when selecting from object type T a path with type P.
T Deep.Path.Result.For	Determines the result type for an array of tokens representing subpaths in type `T`.
T Deep.Path.Result.Part	Determines the result of getting the property/index `K` from type `T`, taking into account that the value may be optional.
T Deep.Path.Result.Tokenize	Converts a path string into separate tokens in a string array.
T Deep.Path.Set	A string representing a path into an (nested) object of type T.
T Deep.Path.StringSplit	The allowed values of a split path.
T Deep.Protected	A deep readonly typed version of given type T. Makes all properties or elements read only. It maps types using the following rules: arrays and tuples become readonly counterparts, and all element types are wrapped in `Protected` if applicable Maps of key type K and value type V become Maps of key type `Protected<K>` and value type `Protected<V>` Sets of element type E become Sets of element type `Protected<E>` Promises of value type E become Promises of value type `Protected<E>` Objects that have only simple properties (no functions or iterators) will have all the properties as Protected if applicable Any other type will not be mapped
T Deep.Selector	Type defining the allowed selectors on an object of type `T`. Selectors can be: a path string into type `T`. a function receiving a `Protected` version of type `T`, and returning an arbitrary value. a tuple of `Selectors` for type `T` an object where the property values are `Selectors` for type `T`.
T Deep.Selector.Result	Type defining the result type of applying the SL selector type to the T value type.
T Deep.Selector.Shape	Type defining the shape of allowed selectors, used to improve compiler checking.
T Eq	A function returning true if given `v1` and `v2` should be considered equal.
T IndexRange	A flexible range specification for numeric indices. If a start or end is defined, a tuple can be used where the second item is a boolean indicating whether that end is inclusive or exclusive. An IndexRange can have one of the following forms: { amount: number } { start: number } { start: number, amount: number } { start: number, end: number } { start: number, end: [number, boolean] } { start: [number, boolean] } { start: [number, boolean], amount: number } { start: [number, boolean], end: number } { start: [number, boolean], end: [number, boolean] } { end: number } { end: [number, boolean] }
T MaybePromise	A type that is either a value T or a promise yielding a value of type T.
T OptLazy	A potentially lazy value of type T.
T OptLazyOr	A potentially lazy value that, in case of a lazy function, received a default value that it can return.
T Range	A range definition for any type of (orderable) value. If a start or end is defined, a tuple can be used where the second item is a boolean indicating whether that end is inclusive (true) or exclusive (false). A Range of type T can have one of the following forms: { end: T } { end: [T, boolean] } { start: T } { start: T, end: T } { start: T, end: [T, boolean] } { start: [T, boolean] } { start: [T, boolean], end: T } { start: [T, boolean], end: [T, boolean] }
T Reducer	A `Reducer` is a stand-alone calculation that takes input values of type I, and, when requested, produces an output value of type O.
T RelatedTo	Accepts all types of T and U where T extends U or U extends T.
T StreamSource	Any object that is Iterable, a Stream, or can produce a Stream.
T StreamSource.NonEmpty	Any object that is a non-empty Stream, can produce a non-empty Stream, or is a non-empty array.
T StringNonEmpty	Accepts all strings with at least one character.
T SubOf	Accepts all types of T and S where S extends T, and results in the lower bound S.
T SuperOf	Accepts all types of T and U where T extends U, and result in the upper bound U.
T Transformer	A Reducer that produces instances of `StreamSource`.
T Transformer.NonEmpty	A Reducer that produces instances of `StreamSource.NonEmpty`.
T Traverse.LinkType	Utility type to determine if a graph has valued or unvalued links
T Tuple	A readonly array of fixed length and types.
T Tuple.IsTuple
T Tuple.KeysOf	Returns the indices/keys that are in a tuple.
T Tuple.NonEmptySource	A non-empty readonly array that can serve as a source for a Tuple.
T Tuple.Source	A readonly array that can serve as a source for a Tuple.
T Update	A value of type T, or a function taking a value of type T and returning a new value of type T.