Skip to main content

Map

A Map is a collection of entries, where each entry has a key and a value. Each key has exactly one value, and each key is unique. Values do not need to be unique.

When to use

The Map is a useful when it is useful to assign values of objects to unique entities of a certain type. For example, consider currencies and their values. Using a Map we can assign a value to each currency, e.g. euro and dollar. We can update their values, and we can query the value of a specific currency. It does not really make much sense to query using a value to get a currency, so a BiMap would not be useful in this case.

info

Rimbu provides one unordered immutable map implementation, being HashMap, and two ordered immutable maps, being SortedMap and OrderedMap

HashMap

The HashMap uses a Hasher instance to convert values and objects into numbers that can be used to effeciently organize items within the collection. This results in the values being 'unordered', that is, iterating over the collection will not necessarily return the values in insertion order.

SortedMap

The SortedMap uses a Comp instance that can compare two elements and return a number indicating whether they are equal or which one is 'larger'. The Sortedap uses this method to keep the elements in sorted order, so that iteration will always return the elements in sorted order as well.

OrderedMap

The OrderedMap maintains an extra List or the inserted keys in insertion order. At the cost of extra memory usage for the List, the OrderedMap will return entries in the insertion order when iterating over its values.

Exports

The @rimbu/core package exports the following abstract Map TypeScript types:

NameDescription
VariantMap<K, V>a type-variant map with entries of key type K and value type V
RMap<K, V>a generic map with entries of key type K and value type V

The @rimbu/core package exports the following concrete Map TypeScript types:

NameDescription
HashMap<K, V>a map with entries of key type K and value type V, where keys are hashed with a Hasher
SortedMap<K, V>a map with entries of key type K and value type V, where keys are sorted with a Comp
OrderedMap<K, V>a map with entries of key type K and value type V, where key insertion order is maintained

Inheritance

Usage

Creation

Open file below in new window with full type-check

Query

Open file below in new window with full type-check

Builder

Open file below in new window with full type-check