Struct VarRemapping

pub struct VarRemapping {
    pub remapping: OrderedHashMap<VariableId, VarUsage>,
}

Remapping of lowered variable ids. Useful for convergence of branches.

Fields

remapping: OrderedHashMap<VariableId, VarUsage>

Map from new_var to old_var (since new_var cannot appear twice, but old_var can).

Methods from Deref<Target = OrderedHashMap<VariableId, VarUsage>>

pub fn iter(&self) -> Iter<'_, Key, Value>

Returns an iterator over the key-value pairs of the map, in their order.

pub fn iter_mut(&mut self) -> IterMut<'_, Key, Value>

Returns a mutable iterator over the key-value pairs of the map, in their order.

pub fn keys(&self) -> Keys<'_, Key, Value>

Returns an iterator over the keys of the map, in their order.

pub fn values(&self) -> Values<'_, Key, Value>

Returns an iterator over the values of the map, in their order.

pub fn len(&self) -> usize

Returns the number of key-value pairs in the map.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

pub fn clear(&mut self)

Removes all the entries for the map.

pub fn shift_remove_index(&mut self, index: usize) -> Option<(Key, Value)>

Removes the entry at the given index.

Returns the key-value pair at the given index (if present).

pub fn get<Q>(&self, key: &Q) -> Option<&Value>

where Q: Hash + Equivalent<Key> + ?Sized,

Returns a reference to the value stored for key, if it is present, else None.

Computes in O(1) time (average).

pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut Value>

where Q: Hash + Equivalent<Key> + ?Sized,

Returns a mutable reference to the value stored for key, if it is present, else None.

Computes in O(1) time (average).

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

Gets the given key’s corresponding entry in the map for insertion and/or in-place manipulation.

Computes in O(1) time (amortized average).

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

Insert a key-value pair in the map.

If an equivalent key already exists in the map: the key remains and retains in its place in the order, its corresponding value is updated with value and the older value is returned inside Some(_).

If no equivalent key existed in the map: the new key-value pair is inserted, last in order, and None is returned.

Computes in O(1) time (amortized average).

See also entry if you you want to insert or modify or if you need to get the index of the corresponding key-value pair.

pub fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = (Key, Value)>,

Extends the map with the content of the given iterator.

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

where Q: Hash + Equivalent<Key> + ?Sized,

Returns true if an equivalent to key exists in the map.

pub fn shift_remove<Q>(&mut self, key: &Q) -> Option<Value>

where Q: Hash + Equivalent<Key> + ?Sized,

Removes the entry for the given key, preserving the order of entries.

Returns the value associated with the key (if present).

pub fn swap_remove<Q>(&mut self, key: &Q) -> Option<Value>

where Q: Hash + Equivalent<Key> + ?Sized,

Removes the entry for the given key by swapping it with the last element. Thus the order of elements is not preserved, but the resulting order is still deterministic.

Returns the value associated with the key (if present).

pub fn retain(&mut self, keep: impl FnMut(&Key, &mut Value) -> bool)

Scan through each key-value pair in the map and keep those where the closure keep returns true.

The elements are visited in order, and remaining elements keep their order.

Computes in O(n) time (average).

pub fn eq_unordered(&self, other: &OrderedHashMap<Key, Value, BH>) -> bool

where Value: Eq,

Returns true if the maps are equal, ignoring the order of the entries.

Trait Implementations

impl Clone for VarRemapping

fn clone(&self) -> VarRemapping

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VarRemapping

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

Formats the value using the given formatter.

impl DebugWithDb<LoweredFormatter<'_>> for VarRemapping

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

fn debug<'me, 'db>(&'me self, db: &'me Db) -> DebugWith<'me, Db>

where Self: Sized + 'me,

fn into_debug<'me, 'db>(self, db: &'me Db) -> DebugWith<'me, Db>

where Self: Sized + 'me,

impl Default for VarRemapping

fn default() -> VarRemapping

Returns the “default value” for a type.

impl Deref for VarRemapping

type Target = OrderedHashMap<Id<Variable>, VarUsage>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for VarRemapping

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl PartialEq for VarRemapping

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for VarRemapping

impl StructuralPartialEq for VarRemapping