Struct portgraph::UnmanagedDenseMap

pub struct UnmanagedDenseMap<K, V> { /* private fields */ }

A dense map from keys to values with default fallbacks.

Implementations

impl<K, V> UnmanagedDenseMap<K, V>where K: Into<usize> + Copy, V: Clone,

pub fn new() -> Selfwhere V: Default,

Creates a new secondary map.

This does not allocate any memory until a value is modified.

pub fn with_default(default: V) -> Self

Creates a new secondary map, specifying the default element.

This does not allocate any memory until a value is modified.

pub fn with_capacity(capacity: usize) -> Selfwhere V: Default,

Creates a new secondary map with specified capacity.

pub fn with_capacity_and_default(capacity: usize, default: V) -> Self

Creates a new secondary map with specified capacity and default element.

pub fn ensure_capacity(&mut self, capacity: usize)

Increases the capacity of the secondary map to capacity.

Does nothing when the capacity of the secondary map is already sufficient.

pub fn shrink_to(&mut self, capacity: usize)

Reduces the capacity of the secondary map to capacity. Stored values higher than capacity are dropped.

Does nothing when the capacity of the secondary map is already lower.

pub fn capacity(&self) -> usize

Returns the maximum index the secondary map can contain without allocating.

pub fn rekey(&mut self, old: K, new: Option<K>)where V: Default,

Remove key old and optionally move to key new.

This method is useful for rekey callbacks such as in PortGraph::set_num_ports and PortGraph::compact_nodes.

pub fn get(&self, key: K) -> &V

Immutably borrows the value at a key.

Returns a borrow of the default value when no value has been set for the key.

pub fn get_mut(&mut self, key: K) -> &mut V

Mutably borrows the value at a key.

When the value is not present, the secondary map is resized to accommodate it. To avoid frequent resizing, use SecondaryMap::ensure_capacity to keep the capacity of the secondary map in line with the size of the key space.

pub fn try_get_mut(&mut self, key: K) -> Option<&mut V>

Mutably borrows the value at a key.

Returns None when the key is beyond the capacity of the secondary map.

pub fn get_disjoint_mut<const N: usize>( &mut self, keys: [K; N] ) -> Option<[&mut V; N]>where K: Eq,

Mutably borrows the values of a disjoint list of keys.

Returns None when two keys coincide.

pub fn swap(&mut self, key0: K, key1: K)

Swaps the values of two keys.

Allocates more memory when necessary to fit the keys.

Trait Implementations

impl<K: Clone, V: Clone> Clone for UnmanagedDenseMap<K, V>

fn clone(&self) -> UnmanagedDenseMap<K, V>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K: Debug, V: Debug> Debug for UnmanagedDenseMap<K, V>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<K, V> Default for UnmanagedDenseMap<K, V>where K: Into<usize> + Copy, V: Clone + Default,

fn default() -> Self

Returns the “default value” for a type.

impl<K, V> Index<K> for UnmanagedDenseMap<K, V>where K: Into<usize> + Copy, V: Clone,

type Output = V

The returned type after indexing.

fn index(&self, key: K) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<K, V> IndexMut<K> for UnmanagedDenseMap<K, V>where K: Into<usize> + Copy, V: Clone,

fn index_mut(&mut self, key: K) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<K: PartialEq, V: PartialEq> PartialEq<UnmanagedDenseMap<K, V>> for UnmanagedDenseMap<K, V>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K, V> SecondaryMap<K, V> for UnmanagedDenseMap<K, V>where K: Into<usize> + TryFrom<usize> + Copy, V: Clone + Default,

fn new() -> Self

Creates a new secondary map.

This does not allocate any memory until a value is modified.

fn set(&mut self, key: K, val: V)

Sets the value at a key.

When the value is not present, the secondary map is resized to accommodate it. To avoid frequent resizing, use SecondaryMap::ensure_capacity to keep the capacity of the secondary map in line with the size of the key space.

fn take(&mut self, key: K) -> V

Takes the value at a key, leaving default() behind.

This operation does not free memory. Use UnmanagedDenseMap::shrink_to to trim container if needed.

type Iter<'a> where Self: 'a, K: 'a, V: 'a = UnmanagedIter<'a, K, V>

An iterator over the non-default entries of the secondary map.

fn with_capacity(capacity: usize) -> Self

Creates a new secondary map with specified capacity.

fn default_value(&self) -> V

Returns the default value for the secondary map. Any key that has not been set will return this value.

fn ensure_capacity(&mut self, capacity: usize)

Increases the capacity of the secondary map to capacity.

fn capacity(&self) -> usize

Returns the maximum index the secondary map can contain without allocating.

fn get(&self, key: K) -> &V

Immutably borrows the value at a key.

fn rekey(&mut self, old: K, new: Option<K>)

Remove key old and optionally move to key new.

fn swap(&mut self, key0: K, key1: K)

Swaps the values of two keys.

fn iter<'a>(&'a self) -> Self::Iter<'a>where K: 'a, V: 'a,

Returns an iterator over the non-default entries of the secondary map.

fn remove(&mut self, key: K)

Removes the value at a key, leaving default() behind.