Unordered Map¶

1

import "std/data/unordered-map";

UnorderedMap<K, V> struct¶

Implements: IIterable<Pair<K, V>>

An unordered map in Spice is a commonly used data structure, which can be used to represent a list of key value pairs.

Time complexity:
Insert: O(1) (average case), O(n) (worst case)
Delete: O(1) (average case), O(n) (worst case)
Lookup: O(1) (average case), O(n) (worst case)

Constructors¶

ctor¶

1

public p UnorderedMap.ctor(unsigned long bucketCount = 100l)

Construct an empty unordered map with the given number of buckets

Parameters

Methods¶

upsert¶

1

public p UnorderedMap.upsert(const K& key, const V& value)

Insert a key-value pair into the map If the key already exists, the value is updated.

Parameters

get¶

1

public f<V&> UnorderedMap.get(const K& key)

Retrieve the value associated with the given key. If the key is not found, panic.

Parameters

Returns: V& — The value associated with the key

getSafe¶

1

public f<Result<V>> UnorderedMap.getSafe(const K& key)

Retrieve the value associated with the given key as Result. If the key is not found, the result contains an error.

Parameters

Returns: Result<V> — Result, containing the value associated with the key or an error if the key is not found

remove¶

1

public p UnorderedMap.remove(const K& key)

Check if the map contains the given key.

Parameters

Returns: True if the key is found, false otherwise

contains¶

1

public f<bool> UnorderedMap.contains(const K& key)

Check if the map contains the given key.

Parameters

Returns: bool — True if the key is found, false otherwise

getSize¶

1

public f<unsigned long> UnorderedMap.getSize()

Get the size of the unordered map.

Returns: unsigned long — The number of key-value pairs in the map

isEmpty¶

1

public f<bool> UnorderedMap.isEmpty()

Check if the unordered map is empty.

Returns: bool — True if empty, false otherwise

clear¶

1

public p UnorderedMap.clear()

Clear the unordered map, removing all key-value pairs.

getIterator¶

1

public f<UnorderedMapIterator<K, V>> UnorderedMap.getIterator()

Retrieve a forward iterator for the unordered map

Returns: UnorderedMapIterator<K, V>

UnorderedMapIterator<K, V> struct¶

Implements: IIterator<Pair<const K&, V&>>

Iterator to iterate over an unordered map data structure

Constructors¶

ctor¶

1

public p UnorderedMapIterator.ctor<K, V>(UnorderedMap<K, V>& unorderedMap)

Construct an unordered map iterator over the given unordered map

Parameters

Methods¶

get¶

1

public inline f<Pair<const K&, V&>&> UnorderedMapIterator.get()

Returns the current key-value pair of the unordered map

Returns: Pair<const K&, V&>& — Current key/value pair

getIdx¶

1

public inline f<Pair<unsigned long, Pair<const K&, V&>&>> UnorderedMapIterator.getIdx()

Returns the current index and the current item of the unordered map

Returns: Pair<unsigned long, Pair<const K&, V&>&> — Pair of current index and current key/value pair

isValid¶

1

public inline f<bool> UnorderedMapIterator.isValid()

Check if the iterator is valid

Returns: bool — true or false

next¶

1

public inline p UnorderedMapIterator.next()

Moves the cursor to the next key/value pair

Operators¶

operator[]¶

1

public f<V&> operator[]<K, V>(UnorderedMap<K, V>& map, const K& key)

Retrieve the value associated with the given key. If the key is not found, panic.

Parameters

Returns: V& — The value associated with the key

operator++¶

1

public inline p operator++<K, V>(UnorderedMapIterator<K, V>& it)

Advances the cursor by one

Parameters