Struct vec_collections::TotalVecMap

pub struct TotalVecMap<V, A: Array>(_, _);

A VecMap with default value.

Having a default value means that the mapping is a total function from K to V, hence the name.

Implementations

impl<K, V: Eq, A: Array<Item = (K, V)>> TotalVecMap<V, A>

pub fn new(map: VecMap<A>, default: V) -> Self

Creates a total vec map, given a vec map and a default value.

Mappings in the map that map to the default value will be removed in order to have a unique representation.

impl<K, V, A: Array<Item = (K, V)>> TotalVecMap<V, A>

pub fn constant(value: V) -> Self

Creates a constant mapping from any K to the given V.

pub fn non_default_mappings(&self) -> &VecMap<A>

Returns all non-default mappings as a VecMap<A>.

impl<K: Ord + Clone, V: Eq, A: Array<Item = (K, V)>> TotalVecMap<V, A>

pub fn combine_ref<F: Fn(&V, &V) -> V>(&self, that: &Self, f: F) -> Self

combine a total map with another total map, using a function that takes value references

impl<K: Ord + Clone, V: Ord + Clone, A: Array<Item = (K, V)>> TotalVecMap<V, A>

pub fn supremum(&self, that: &Self) -> Self

pub fn infimum(&self, that: &Self) -> Self

impl<K: Clone, V: Eq, A: Array<Item = (K, V)>> TotalVecMap<V, A>

pub fn map_values<W: Eq, F: Fn(&V) -> W, B: Array<Item = (K, W)>>(
    &self,
    f: F
) -> TotalVecMap<W, B>

Trait Implementations

impl<K: Ord + Clone, V: Add<Output = V> + Eq + Clone, A: Array<Item = (K, V)>> Add<TotalVecMap<V, A>> for TotalVecMap<V, A>

type Output = TotalVecMap<V, A>

The resulting type after applying the + operator.

fn add(self, that: Self) -> Self::Output

Performs the + operation.

impl<K, V: Bounded, A: Array<Item = (K, V)>> Bounded for TotalVecMap<V, A>

fn min_value() -> Self

returns the smallest finite number this type can represent

fn max_value() -> Self

returns the largest finite number this type can represent

impl<K: Clone, V: Clone, A: Array<Item = (K, V)>> Clone for TotalVecMap<V, A>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug, V: Debug, A: Array<Item = (K, V)>> Debug for TotalVecMap<V, A>

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

Formats the value using the given formatter.

impl<K, V: Default, A: Array<Item = (K, V)>> Default for TotalVecMap<V, A>

fn default() -> Self

Returns the "default value" for a type.

impl<K: Ord + Clone, V: Div<Output = V> + Eq + Clone, A: Array<Item = (K, V)>> Div<TotalVecMap<V, A>> for TotalVecMap<V, A>

type Output = TotalVecMap<V, A>

The resulting type after applying the / operator.

fn div(self, that: Self) -> Self::Output

Performs the / operation.

impl<K: Eq, V: Eq, A: Array<Item = (K, V)>> Eq for TotalVecMap<V, A>

impl<K, V, A: Array<Item = (K, V)>> From<V> for TotalVecMap<V, A>

Creates a constant mapping from any K to the given V.

fn from(value: V) -> Self

Performs the conversion.

impl<K: Hash, V: Hash, A: Array<Item = (K, V)>> Hash for TotalVecMap<V, A>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<K: Ord + 'static, Q: ?Sized, V, A: Array<Item = (K, V)>, '_> Index<&'_ Q> for TotalVecMap<V, A> where
    K: Borrow<Q>,
    Q: Ord, 

type Output = V

The returned type after indexing.

fn index(&self, key: &Q) -> &V

Lookup. Time complexity is O(log N), where N is the number of non-default elements

impl<K: Ord + Clone, V: Mul<Output = V> + Eq + Clone, A: Array<Item = (K, V)>> Mul<TotalVecMap<V, A>> for TotalVecMap<V, A>

type Output = TotalVecMap<V, A>

The resulting type after applying the * operator.

fn mul(self, that: Self) -> Self::Output

Performs the * operation.

impl<K: Ord + Clone, V: Neg<Output = V> + Eq + Clone, A: Array<Item = (K, V)>> Neg for TotalVecMap<V, A>

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<K: Ord + Clone, V: One + Eq + Clone, A: Array<Item = (K, V)>> One for TotalVecMap<V, A>

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

Returns true if self is equal to the multiplicative identity.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

impl<K: Ord, V: Ord, A: Array<Item = (K, V)>> Ord for TotalVecMap<V, A>

fn cmp(&self, other: &Self) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<K: PartialEq, V: PartialEq, A: Array<Item = (K, V)>> PartialEq<TotalVecMap<V, A>> for TotalVecMap<V, A>

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<K: PartialOrd, V: PartialOrd, A: Array<Item = (K, V)>> PartialOrd<TotalVecMap<V, A>> for TotalVecMap<V, A>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<K: Ord + Clone, V: Sub<Output = V> + Eq + Clone, A: Array<Item = (K, V)>> Sub<TotalVecMap<V, A>> for TotalVecMap<V, A>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, that: Self) -> Self::Output

Performs the - operation.

impl<K: Ord + Clone, V: Zero + Eq + Clone, A: Array<Item = (K, V)>> Zero for TotalVecMap<V, A>

fn zero() -> Self

Returns the additive identity element of Self, 0. # Purity

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.