Skip to main content

package @rimbu/core

The @rimbu/core package is a convenience package that exports most items from the following packages:

Interfaces

NameDescription
ArrowGraph<N>An type-invariant immutable arrow (directed) graph. See the Graph documentation and the ArrowGraph API documentation
ArrowGraphHashed<N>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
ArrowGraphSorted<N>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
ArrowValuedGraph<N,V>An type-invariant immutable valued arrow (directed) graph. See the Graph documentation and the ArrowValuedGraph API documentation
ArrowValuedGraphHashed<N,V>An type-invariant immutable valued arrow (directed) graph. The nodes are internally maintained using HashMaps See the Graph documentation and the ArrowValuedGraphHashed API documentation
ArrowValuedGraphSorted<N,V>An type-invariant immutable valued arrow (directed) graph. The nodes are internally maintained using SortedMaps See the Graph documentation and the ArrowValuedGraphSorted API documentation
AsyncFastIterable<T>undocumented
AsyncFastIterator<T>undocumented
AsyncStream<T>A possibly infinite asynchronous sequence of elements of type T. See the Stream documentation and the AsyncStream API documentation
AsyncStreamable<T>undocumented
BiMap<K,V>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
BiMultiMap<K,V>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
EdgeGraph<N>An type-invariant immutable edge (undirected) graph. See the Graph documentation and the EdgeGraph API documentation
EdgeGraphHashed<N>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
EdgeGraphSorted<N>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
EdgeValuedGraph<N,V>An type-invariant immutable valued edge (undirected) graph. See the Graph documentation and the EdgeValuedGraph API documentation
EdgeValuedGraphHashed<N,V>An type-invariant immutable valued edge (undirected) graph. The nodes are internally maintained using HashMaps See the Graph documentation and the EdgeValuedGraphHashed API documentation
EdgeValuedGraphSorted<N,V>An type-invariant immutable valued edge (undirected) graph. The nodes are internally maintained using SortedMaps See the Graph documentation and the EdgeValuedGraphSorted API documentation
FastIterable<T>An interface that extends the standard Iterable interface to return a FastIterator instead of a normal Iterator.
FastIterator<T>An iterator that extends the default Iterator interface with methods that give more performance.
Graph<N>An type-invariant immutable graph. See the Graph documentation and the Graph API documentation
HashBiMultiMap<K,V>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
Hasher<UK>Interface used to hash objects for hashed collections.
HashMap<K,V>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
HashMultiMapHashValue<K,V>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
HashMultiMapSortedValue<K,V>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
HashMultiSet<T>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
HashSet<T>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
HashTableHashColumn<R,C,V>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
HashTableSortedColumn<R,C,V>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
List<T>A random accessible immutable sequence of values of type T. See the List documentation and the List API documentation
MultiMap<K,V>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
MultiSet<T>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
OrderedHashMap<K,V>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
OrderedHashSet<T>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
OrderedMap<K,V>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
OrderedSet<T>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
OrderedSortedMap<K,V>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
OrderedSortedSet<T>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
ProximityMap<K,V>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
RMap<K,V>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
RSet<T>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
SortedBiMultiMap<K,V>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
SortedMap<K,V>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
SortedMultiMapHashValue<K,V>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
SortedMultiMapSortedValue<K,V>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
SortedMultiSet<T>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
SortedSet<T>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
SortedTableHashColumn<R,C,V>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
SortedTableSortedColumn<R,C,V>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
Stream<T>A possibly infinite sequence of elements of type T. See the Stream documentation and the Stream API documentation
Streamable<T>An object that can create a Stream of elements of type T.
Table<R,C,V>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
ValuedGraph<N,V>An type-invariant immutable valued graph. See the Graph documentation and the ValuedGraph API documentation
VariantGraph<N>An type-variant immutable graph. See the Graph documentation and the VariantGraph API documentation
VariantMap<K,V>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
VariantMultiMap<K,V>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
VariantMultiSet<T>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
VariantSet<T>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
VariantTable<R,C,V>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
VariantValuedGraph<N,V>An type-variant immutable valued graph. See the Graph documentation and the VariantValuedGraph API documentation

Namespaces

NameDescription
ArrowGraphAn type-invariant immutable arrow (directed) graph. See the Graph documentation and the ArrowGraph API documentation
ArrowGraphHashedAn type-invariant immutable valued arrow (directed) graph. The connections are internally maintained using hashed collections See the Graph documentation and the ArrowGraphHashed API documentation
ArrowGraphSortedAn type-invariant immutable valued arrow (directed) graph. The connections are internally maintained using sorted collections See the Graph documentation and the ArrowGraphSorted API documentation
ArrowValuedGraphAn type-invariant immutable valued arrow (directed) graph. See the Graph documentation and the ArrowValuedGraph API documentation
ArrowValuedGraphHashedAn type-invariant immutable valued arrow (directed) graph. The nodes are internally maintained using HashMaps See the Graph documentation and the ArrowValuedGraphHashed API documentation
ArrowValuedGraphSortedAn type-invariant immutable valued arrow (directed) graph. The nodes are internally maintained using SortedMaps See the Graph documentation and the ArrowValuedGraphSorted API documentation
AsyncStreamA possibly infinite asynchronous sequence of elements of type T. See the Stream documentation and the AsyncStream API documentation
AsyncStreamableundocumented
AsyncStreamSourceundocumented
AsyncTransformerAn AsyncReducer that produces instances of AsyncStreamSource.
BiMapA 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
BiMultiMapA 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
Deepundocumented
EdgeGraphAn type-invariant immutable edge (undirected) graph. See the Graph documentation and the EdgeGraph API documentation
EdgeGraphHashedAn type-invariant immutable valued edge (undirected) graph. The connections are internally maintained using hashed collections See the Graph documentation and the EdgeGraphHashed API documentation
EdgeGraphSortedAn type-invariant immutable valued edge (undirected) graph. The connections are internally maintained using sorted collections See the Graph documentation and the EdgeGraphSorted API documentation
EdgeValuedGraphAn type-invariant immutable valued edge (undirected) graph. See the Graph documentation and the EdgeValuedGraph API documentation
EdgeValuedGraphHashedAn type-invariant immutable valued edge (undirected) graph. The nodes are internally maintained using HashMaps See the Graph documentation and the EdgeValuedGraphHashed API documentation
EdgeValuedGraphSortedAn type-invariant immutable valued edge (undirected) graph. The nodes are internally maintained using SortedMaps See the Graph documentation and the EdgeValuedGraphSorted API documentation
GraphAn type-invariant immutable graph. See the Graph documentation and the Graph API documentation
HashBiMultiMapA 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
HasherInterface used to hash objects for hashed collections.
HashMapA 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
HashMultiMapHashValueA 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
HashMultiMapSortedValueA 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
HashMultiSetA 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
HashSetA 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
HashTableHashColumnA 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
HashTableSortedColumnA 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
ListA random accessible immutable sequence of values of type T. See the List documentation and the List API documentation
MultiMapA 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
MultiSetA 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
OrderedHashMapA 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
OrderedHashSetA 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
OrderedMapA 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
OrderedSetA 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
OrderedSortedMapA 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
OrderedSortedSetA 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
ProximityMapA 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
RMapA 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
RSetA 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
SortedBiMultiMapA 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
SortedMapA 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
SortedMultiMapHashValueA 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
SortedMultiMapSortedValueA 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
SortedMultiSetA 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
SortedSetA 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
SortedTableHashColumnA 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
SortedTableSortedColumnA 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
StreamA possibly infinite sequence of elements of type T. See the Stream documentation and the Stream API documentation
StreamableAn object that can create a Stream of elements of type T.
StreamSourceAny object that is Iterable, a Stream, or can produce a Stream.
TableA 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
Transformer_2A Reducer that produces instances of StreamSource.
Traverseundocumented
TupleA readonly array of fixed length and types.
ValuedGraphAn type-invariant immutable valued graph. See the Graph documentation and the ValuedGraph API documentation
VariantGraphAn type-variant immutable graph. See the Graph documentation and the VariantGraph API documentation
VariantMapA 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
VariantMultiMapA 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
VariantMultiSetA 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
VariantSetA 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
VariantTableA 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
VariantValuedGraphAn type-variant immutable valued graph. See the Graph documentation and the VariantValuedGraph API documentation

Constants

NameDescription
ArrowGraphundocumented
ArrowGraphHashedundocumented
ArrowGraphSortedundocumented
ArrowValuedGraphundocumented
ArrowValuedGraphHashedundocumented
ArrowValuedGraphSortedundocumented
AsyncStreamundocumented
BiMapundocumented
BiMultiMapundocumented
EdgeGraphundocumented
EdgeGraphHashedundocumented
EdgeGraphSortedundocumented
EdgeValuedGraphundocumented
EdgeValuedGraphHashedundocumented
EdgeValuedGraphSortedundocumented
HashBiMultiMapundocumented
HashMapundocumented
HashMultiMapHashValueundocumented
HashMultiMapSortedValueundocumented
HashMultiSetundocumented
HashSetundocumented
HashTableHashColumnundocumented
HashTableSortedColumnundocumented
Listundocumented
MultiMapundocumented
MultiSetundocumented
OrderedHashMapundocumented
OrderedHashSetundocumented
OrderedMapundocumented
OrderedSetundocumented
OrderedSortedMapundocumented
OrderedSortedSetundocumented
ProximityMapundocumented
SortedBiMultiMapundocumented
SortedMapundocumented
SortedMultiMapHashValueundocumented
SortedMultiMapSortedValueundocumented
SortedMultiSetundocumented
SortedSetundocumented
SortedTableHashColumnundocumented
SortedTableSortedColumnundocumented
Streamundocumented
Tableundocumented