Struct IntMap

Source

pub struct IntMap<V> { /* private fields */ }

Implementations§

Source §

impl<V> IntMap<V>

Source

pub fn new() -> IntMap<V>

Creates a new IntMap.

§Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::new();
assert_eq!(map, IntMap::default());

Source

pub fn with_capacity(capacity: usize) -> IntMap<V>

Creates a new IntMap with at least the given capacity, rounded to the next power of two.

§Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::with_capacity(20);

Source

pub fn set_load_factor(&mut self, load_factor: f32)

Sets load rate of IntMap rounded to the first decimal point.

Values above 1.0 is allowed.

§Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::with_capacity(20);
map.set_load_factor(0.909); // Sets load factor to 90.9%

Source

pub fn get_load_factor(&self) -> f32

Returns current load_factor

Source

pub fn reserve(&mut self, additional: usize)

Ensures that the IntMap has space for at least additional more elements

Source

pub fn insert(&mut self, key: u64, value: V) -> Option<V>

Insert key/value into the IntMap.

This function returns the previous value if any otherwise None.

§Examples

use intmap::IntMap;

let mut map = IntMap::new();
assert_eq!(map.insert(21, "Eat my shorts"), None);
assert_eq!(map.insert(21, "Ay, caramba"), Some("Eat my shorts"));
assert_eq!(map.get(21), Some(&"Ay, caramba"));

Source

pub fn insert_checked(&mut self, key: u64, value: V) -> bool

Insert key/value into the IntMap if the key is not yet inserted.

This function returns true if key/value were inserted and false otherwise.

§Examples

use intmap::IntMap;

let mut map = IntMap::new();
assert!(map.insert_checked(21, "Eat my shorts"));
assert!(!map.insert_checked(21, "Ay, caramba"));
assert_eq!(map.get(21), Some(&"Eat my shorts"));

Source

pub fn get(&self, key: u64) -> Option<&V>

Get value from the IntMap.

§Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::new();
map.insert(21, 42);
let val = map.get(21);
assert!(val.is_some());
assert_eq!(*val.unwrap(), 42);
assert!(map.contains_key(21));

Source

pub fn get_mut(&mut self, key: u64) -> Option<&mut V>

Get mutable value from the IntMap.

§Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::new();
map.insert(21, 42);

assert_eq!(*map.get(21).unwrap(), 42);
assert!(map.contains_key(21));

{
    let mut val = map.get_mut(21).unwrap();
    *val+=1;
}
    assert_eq!(*map.get(21).unwrap(), 43);

Source

pub fn remove(&mut self, key: u64) -> Option<V>

Remove value from the IntMap.

§Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::new();
map.insert(21, 42);
let val = map.remove(21);
assert!(val.is_some());
assert_eq!(val.unwrap(), 42);
assert!(!map.contains_key(21));

Source

pub fn contains_key(&self, key: u64) -> bool

Returns true if key is in map.

§Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::new();
map.insert(21, 42);
assert!(map.contains_key(21));

Source

pub fn clear(&mut self)

Removes all elements from map.

§Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::new();
map.insert(21, 42);
map.clear();
assert_eq!(map.len(), 0);

Source

pub fn retain<F>(&mut self, f: F)
where F: FnMut(u64, &V) -> bool,

Retains only the elements specified by the predicate.

In other words, remove all elements such that f(key, &value) returns false.

§Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::new();
map.insert(1, 11);
map.insert(2, 12);
map.insert(4, 13);

// retain only the odd values
map.retain(|k, v| *v % 2 == 1);

assert_eq!(map.len(), 2);
assert!(map.contains_key(1));
assert!(map.contains_key(4));

Source

pub fn is_empty(&self) -> bool

Returns true if map is empty

§Examples

use intmap::IntMap;

let mut map: IntMap<u64> = IntMap::new();
map.insert(21, 42);
assert!(!map.is_empty());
map.remove(21);
assert!(map.is_empty());

Source

pub fn len(&self) -> usize

Number of elements in map.

Source

pub fn load(&self) -> u64

Force count number of slots filled.

Source

pub fn load_rate(&self) -> f64

Source

pub fn capacity(&self) -> usize

Total number of slots available.

Source

pub fn assert_count(&self) -> bool

Source

pub fn collisions(&self) -> IntMap<u64>

Source

pub fn entry(&mut self, key: u64) -> Entry<'_, V>

Gets the Entry that corresponds to the given key.

§Examples

use intmap::{IntMap, Entry};

let mut counters = IntMap::new();

for number in [10, 30, 10, 40, 50, 50, 60, 50] {
    let counter = match counters.entry(number) {
        Entry::Occupied(entry) => entry.into_mut(),
        Entry::Vacant(entry) => entry.insert(0),
    };
    *counter += 1;
}

assert_eq!(counters.get(10), Some(&2));
assert_eq!(counters.get(20), None);
assert_eq!(counters.get(30), Some(&1));
assert_eq!(counters.get(40), Some(&1));
assert_eq!(counters.get(50), Some(&3));
assert_eq!(counters.get(60), Some(&1));