HashMap

HashMap<Key, Value, MaxLen, Hasher> is used to efficiently store and look up key-value pairs.

HashMap is a bounded type which can store anywhere from zero to MaxLen total elements. Note that due to hash collisions, the actual maximum number of elements stored by any particular hashmap is likely lower than MaxLen. This is true even with cryptographic hash functions since every hash value will be performed modulo MaxLen.

Example:

// Create a mapping from Fields to u32s with a maximum length of 12
// using a poseidon2 hasher
use std::hash::poseidon2::Poseidon2Hasher;
let mut map: HashMap<Field, u32, 12, BuildHasherDefault<Poseidon2Hasher>> = HashMap::default();

map.insert(1, 2);
map.insert(3, 4);

let two = map.get(1).unwrap();

Methods

default

default

impl<K, V, let N: u32, B, H> Default for HashMap<K, V, N, B>
where
    B: BuildHasher<H> + Default,
    H: Hasher + Default {
    /// Constructs an empty HashMap.
    /// 
    /// Example:
    /// 
    /// ```noir
    /// let hashmap: HashMap<u8, u32, 10, BuildHasherDefault<Poseidon2Hasher>> = HashMap::default();
    /// assert(hashmap.is_empty());
    /// ``` 
    fn default() -> Self {

^{_{Source code: noir_stdlib/src/collections/map.nr#L694-L708}}

Creates a fresh, empty HashMap.

When using this function, always make sure to specify the maximum size of the hash map.

This is the same default from the Default implementation given further below. It is repeated here for convenience since it is the recommended way to create a hashmap.

Example:

default_example

let hashmap: HashMap<u8, u32, 10, BuildHasherDefault<Poseidon2Hasher>> = HashMap::default();
    assert(hashmap.is_empty());

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L201-L204}}

Because HashMap has so many generic arguments that are likely to be the same throughout your program, it may be helpful to create a type alias:

type_alias

type MyMap = HashMap<u8, u32, 10, BuildHasherDefault<Poseidon2Hasher>>;

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L195-L197}}

with_hasher

with_hasher

pub fn with_hasher<H>(_build_hasher: B) -> Self
    where
        B: BuildHasher<H> {

^{_{Source code: noir_stdlib/src/collections/map.nr#L103-L107}}

Creates a hashmap with an existing BuildHasher. This can be used to ensure multiple hashmaps are created with the same hasher instance.

Example:

with_hasher_example

let my_hasher: BuildHasherDefault<Poseidon2Hasher> = Default::default();
    let hashmap: HashMap<u8, u32, 10, BuildHasherDefault<Poseidon2Hasher>> = HashMap::with_hasher(my_hasher);
    assert(hashmap.is_empty());

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L206-L210}}

get

get

pub fn get<H>(
        self,
        key: K
    ) -> Option<V>
    where
        K: Eq + Hash,
        B: BuildHasher<H>,
        H: Hasher {

^{_{Source code: noir_stdlib/src/collections/map.nr#L470-L479}}

Retrieves a value from the hashmap, returning Option::none() if it was not found.

Example:

get_example

fn get_example(map: HashMap<Field, Field, 5, BuildHasherDefault<Poseidon2Hasher>>) {
    let x = map.get(12);

    if x.is_some() {
        assert(x.unwrap() == 42);
    }
}

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L298-L306}}

insert

insert

pub fn insert<H>(
        &mut self,
        key: K,
        value: V
    )
    where
        K: Eq + Hash,
        B: BuildHasher<H>,
        H: Hasher {

^{_{Source code: noir_stdlib/src/collections/map.nr#L514-L524}}

Inserts a new key-value pair into the map. If the key was already in the map, its previous value will be overridden with the newly provided one.

Example:

insert_example

let mut map: HashMap<Field, Field, 5, BuildHasherDefault<Poseidon2Hasher>> = HashMap::default();
    map.insert(12, 42);
    assert(map.len() == 1);

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L212-L216}}

remove

remove

pub fn remove<H>(
        &mut self,
        key: K
    )
    where
        K: Eq + Hash,
        B: BuildHasher<H>,
        H: Hasher {

^{_{Source code: noir_stdlib/src/collections/map.nr#L573-L582}}

Removes the given key-value pair from the map. If the key was not already present in the map, this does nothing.

Example:

remove_example

map.remove(12);
    assert(map.is_empty());

    // If a key was not present in the map, remove does nothing
    map.remove(12);
    assert(map.is_empty());

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L220-L227}}

is_empty

is_empty

pub fn is_empty(self) -> bool {

^{_{Source code: noir_stdlib/src/collections/map.nr#L168-L170}}

True if the length of the hash map is empty.

Example:

is_empty_example

assert(map.is_empty());

    map.insert(1, 2);
    assert(!map.is_empty());

    map.remove(1);
    assert(map.is_empty());

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L229-L237}}

len

len

pub fn len(self) -> u32 {

^{_{Source code: noir_stdlib/src/collections/map.nr#L429-L431}}

Returns the current length of this hash map.

Example:

len_example

// This is equivalent to checking map.is_empty()
    assert(map.len() == 0);

    map.insert(1, 2);
    map.insert(3, 4);
    map.insert(5, 6);
    assert(map.len() == 3);

    // 3 was already present as a key in the hash map, so the length is unchanged
    map.insert(3, 7);
    assert(map.len() == 3);

    map.remove(1);
    assert(map.len() == 2);

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L239-L254}}

capacity

capacity

pub fn capacity(_self: Self) -> u32 {

^{_{Source code: noir_stdlib/src/collections/map.nr#L451-L453}}

Returns the maximum capacity of this hashmap. This is always equal to the capacity specified in the hashmap's type.

Unlike hashmaps in general purpose programming languages, hashmaps in Noir have a static capacity that does not increase as the map grows larger. Thus, this capacity is also the maximum possible element count that can be inserted into the hashmap. Due to hash collisions (modulo the hashmap length), it is likely the actual maximum element count will be lower than the full capacity.

Example:

capacity_example

let empty_map: HashMap<Field, Field, 42, BuildHasherDefault<Poseidon2Hasher>> = HashMap::default();
    assert(empty_map.len() == 0);
    assert(empty_map.capacity() == 42);

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L256-L260}}

clear

clear

pub fn clear(&mut self) {

^{_{Source code: noir_stdlib/src/collections/map.nr#L122-L124}}

Clears the hashmap, removing all key-value pairs from it.

Example:

clear_example

assert(!map.is_empty());
    map.clear();
    assert(map.is_empty());

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L262-L266}}

contains_key

contains_key

pub fn contains_key<H>(
        self,
        key: K
    ) -> bool
    where
        K: Hash + Eq,
        B: BuildHasher<H>,
        H: Hasher {

^{_{Source code: noir_stdlib/src/collections/map.nr#L142-L151}}

True if the hashmap contains the given key. Unlike get, this will not also return the value associated with the key.

Example:

contains_key_example

if map.contains_key(7) {
        let value = map.get(7);
        assert(value.is_some());
    } else {
        println("No value for key 7!");
    }

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L268-L275}}

entries

entries

pub fn entries(self) -> BoundedVec<(K, V), N> {

^{_{Source code: noir_stdlib/src/collections/map.nr#L192-L194}}

Returns a vector of each key-value pair present in the hashmap.

The length of the returned vector is always equal to the length of the hashmap.

Example:

entries_example

let entries = map.entries();

    // The length of a hashmap may not be compile-time known, so we
    // need to loop over its capacity instead
    for i in 0..map.capacity() {
        if i < entries.len() {
            let (key, value) = entries.get(i);
            println(f"{key} -> {value}");
        }
    }

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L309-L320}}

keys

keys

pub fn keys(self) -> BoundedVec<K, N> {

^{_{Source code: noir_stdlib/src/collections/map.nr#L228-L230}}

Returns a vector of each key present in the hashmap.

The length of the returned vector is always equal to the length of the hashmap.

Example:

keys_example

let keys = map.keys();

    for i in 0..keys.max_len() {
        if i < keys.len() {
            let key = keys.get_unchecked(i);
            let value = map.get(key).unwrap_unchecked();
            println(f"{key} -> {value}");
        }
    }

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L322-L332}}

values

values

pub fn values(self) -> BoundedVec<V, N> {

^{_{Source code: noir_stdlib/src/collections/map.nr#L262-L264}}

Returns a vector of each value present in the hashmap.

The length of the returned vector is always equal to the length of the hashmap.

Example:

values_example

let values = map.values();

    for i in 0..values.max_len() {
        if i < values.len() {
            let value = values.get_unchecked(i);
            println(f"Found value {value}");
        }
    }

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L334-L343}}

iter_mut

iter_mut

pub fn iter_mut<H>(
        &mut self,
        f: fn(K, V) -> (K, V)
    )
    where
        K: Eq + Hash,
        B: BuildHasher<H>,
        H: Hasher {

^{_{Source code: noir_stdlib/src/collections/map.nr#L298-L307}}

Iterates through each key-value pair of the HashMap, setting each key-value pair to the result returned from the given function.

Note that since keys can be mutated, the HashMap needs to be rebuilt as it is iterated through. If this is not desired, use iter_values_mut if only values need to be mutated, or entries if neither keys nor values need to be mutated.

The iteration order is left unspecified. As a result, if two keys are mutated to become equal, which of the two values that will be present for the key in the resulting map is also unspecified.

Example:

iter_mut_example

// Add 1 to each key in the map, and double the value associated with that key.
    map.iter_mut(|k, v| (k + 1, v * 2));

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L347-L350}}

iter_keys_mut

iter_keys_mut

pub fn iter_keys_mut<H>(
        &mut self,
        f: fn(K) -> K
    ) 
    where
        K: Eq + Hash,
        B: BuildHasher<H>,
        H: Hasher {

^{_{Source code: noir_stdlib/src/collections/map.nr#L338-L347}}

Iterates through the HashMap, mutating each key to the result returned from the given function.

Note that since keys can be mutated, the HashMap needs to be rebuilt as it is iterated through. If only iteration is desired and the keys are not intended to be mutated, prefer using entries instead.

The iteration order is left unspecified. As a result, if two keys are mutated to become equal, which of the two values that will be present for the key in the resulting map is also unspecified.

Example:

iter_keys_mut_example

// Double each key, leaving the value associated with that key untouched
    map.iter_keys_mut(|k| k * 2);

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L352-L355}}

iter_values_mut

iter_values_mut

pub fn iter_values_mut(&mut self, f: fn(V) -> V) {

^{_{Source code: noir_stdlib/src/collections/map.nr#L372-L374}}

Iterates through the HashMap, applying the given function to each value and mutating the value to equal the result. This function is more efficient than iter_mut and iter_keys_mut because the keys are untouched and the underlying hashmap thus does not need to be reordered.

Example:

iter_values_mut_example

// Halve each value
    map.iter_values_mut(|v| v / 2);

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L357-L360}}

retain

retain

pub fn retain(&mut self, f: fn(K, V) -> bool) {

^{_{Source code: noir_stdlib/src/collections/map.nr#L393-L395}}

Retains only the key-value pairs for which the given function returns true. Any key-value pairs for which the function returns false will be removed from the map.

Example:

retain_example

map.retain(|k, v| (k != 0) & (v != 0));

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L280-L282}}

Trait Implementations

default

default

impl<K, V, let N: u32, B, H> Default for HashMap<K, V, N, B>
where
    B: BuildHasher<H> + Default,
    H: Hasher + Default {
    /// Constructs an empty HashMap.
    /// 
    /// Example:
    /// 
    /// ```noir
    /// let hashmap: HashMap<u8, u32, 10, BuildHasherDefault<Poseidon2Hasher>> = HashMap::default();
    /// assert(hashmap.is_empty());
    /// ``` 
    fn default() -> Self {

^{_{Source code: noir_stdlib/src/collections/map.nr#L694-L708}}

Constructs an empty HashMap.

Example:

default_example

let hashmap: HashMap<u8, u32, 10, BuildHasherDefault<Poseidon2Hasher>> = HashMap::default();
    assert(hashmap.is_empty());

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L201-L204}}

eq

eq

impl<K, V, let N: u32, B, H> Eq for HashMap<K, V, N, B>
where
    K: Eq + Hash,
    V: Eq,
    B: BuildHasher<H>,
    H: Hasher {
    /// Checks if two HashMaps are equal.
    /// 
    /// Example:
    /// 
    /// ```noir
    /// let mut map1: HashMap<Field, u64, 4, BuildHasherDefault<Poseidon2Hasher>> = HashMap::default();
    /// let mut map2: HashMap<Field, u64, 4, BuildHasherDefault<Poseidon2Hasher>> = HashMap::default();
    /// 
    /// map1.insert(1, 2);
    /// map1.insert(3, 4);
    /// 
    /// map2.insert(3, 4);
    /// map2.insert(1, 2);
    /// 
    /// assert(map1 == map2);
    /// ```
    fn eq(self, other: HashMap<K, V, N, B>) -> bool {

^{_{Source code: noir_stdlib/src/collections/map.nr#L643-L667}}

Checks if two HashMaps are equal.

Example:

eq_example

let mut map1: HashMap<Field, u64, 4, BuildHasherDefault<Poseidon2Hasher>> = HashMap::default();
    let mut map2: HashMap<Field, u64, 4, BuildHasherDefault<Poseidon2Hasher>> = HashMap::default();

    map1.insert(1, 2);
    map1.insert(3, 4);

    map2.insert(3, 4);
    map2.insert(1, 2);

    assert(map1 == map2);

^{_{Source code: test_programs/execution_success/hashmap/src/main.nr#L284-L295}}