Struct RangeMap 

pub struct RangeMap<K, V, C: Storage<Item<AnyRange<K>, V>>> { /* private fields */ }

Range map.

Implementations

impl<K, V, C: Storage<Item<AnyRange<K>, V>>> RangeMap<K, V, C>

pub fn new() -> RangeMap<K, V, C>

Create a new empty map.

impl<K, V, C: Storage<Item<AnyRange<K>, V>>> RangeMap<K, V, C>

pub fn len(&self) -> K::Len

where K: Measure + PartialEnum + Bounded,

pub fn bounded_len(&self) -> Option<K::Len>

where K: Measure + PartialEnum,

pub fn is_empty(&self) -> bool

where K: Measure + PartialEnum,

pub fn range_count(&self) -> usize

pub fn intersects<R: AsRange<Item = K>>(&self, key: R) -> bool

where K: PartialEnum + Measure, V: PartialEq,

Complexity

O(log n), where n is the number of ranges in the map (Self::range_count). A single top-down search through the B-tree locates the (at most one) range intersecting key.

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

where K: PartialEnum + RangePartialOrd + Measure,

Complexity

O(log n), where n is the number of ranges in the map (Self::range_count). Same single-search cost as Self::get.

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

where K: PartialEnum + RangePartialOrd + Measure,

Complexity

O(log n), where n is the number of ranges in the map (Self::range_count). A single top-down binary search through the B-tree locates the range containing key.

pub fn iter(&self) -> Iter<'_, K, V, C>

pub fn gaps(&self) -> Gaps<'_, K, V, C>

Returns an iterator over the gaps (unbounded keys) of the map.

impl<K, V, C: Storage<Item<AnyRange<K>, V>>> RangeMap<K, V, C>

pub fn update<R: AsRange<Item = K>, F>(&mut self, key: R, f: F)

where K: Clone + PartialEnum + Measure, F: Fn(Option<&V>) -> Option<V>, V: PartialEq + Clone,

Complexity

O((k + 1) log n), where n is the number of ranges in the map (Self::range_count) and k is the number of existing ranges that overlap, or are connected to, key. Each of the k affected ranges is merged, split or removed with one O(log n) B-tree operation, on top of the initial O(log n) lookup. This is O(log n) when key only touches a handful of existing ranges (the common case), and O(n log n) in the worst case (key overlaps or connects to every stored range). This primitive underlies RangeMultiMap::insert and RangeMultiMap::remove.

pub fn insert_disconnected<R: IntoRange<Item = K>>( &mut self, key: R, value: V, ) -> Result<(), (AnyRange<K>, V)>

where K: PartialEnum + Measure,

pub fn insert<R: IntoRange<Item = K>>(&mut self, key: R, value: V)

where K: Clone + PartialEnum + Measure, V: PartialEq + Clone,

Insert a new key-value binding.

Complexity

O((k + 1) log n), where n is the number of ranges in the map (Self::range_count) and k is the number of existing ranges that overlap, or are connected to, key. Each of the k affected ranges is merged, split or replaced with one O(log n) B-tree operation, on top of the initial O(log n) lookup. Usually O(log n); worst case (e.g. inserting a range spanning the whole map) is O(n log n).

pub fn remove<R: AsRange<Item = K>>(&mut self, key: R)

where K: Clone + PartialEnum + Measure, V: Clone,

Remove a key.

Complexity

O((k + 1) log n), where n is the number of ranges in the map (Self::range_count) and k is the number of existing ranges that intersect key. Each intersecting range costs one O(log n) B-tree operation (split, shrink or removal), on top of the initial O(log n) lookup. Usually O(log n); worst case (key intersects every stored range) is O(n log n).

Trait Implementations

impl<K: Clone, V: Clone, C: Storage<Item<AnyRange<K>, V>>> Clone for RangeMap<K, V, C>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug, V: Debug, C: Storage<Item<AnyRange<K>, V>>> Debug for RangeMap<K, V, C>

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

Formats the value using the given formatter.

impl<K, V, C: Storage<Item<AnyRange<K>, V>>> Default for RangeMap<K, V, C>

fn default() -> Self

Returns the “default value” for a type.

impl<K, V, C: Storage<Item<AnyRange<K>, V>>> Eq for RangeMap<K, V, C>

where K: Measure + PartialEnum + Ord, V: Eq,

impl<K, V, C: Storage<Item<AnyRange<K>, V>>> Hash for RangeMap<K, V, C>

where K: Hash + PartialEnum, V: Hash,

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, K, V, C: Storage<Item<AnyRange<K>, V>>> IntoIterator for &'a RangeMap<K, V, C>

type Item = (&'a AnyRange<K>, &'a V)

The type of the elements being iterated over.

type IntoIter = Iter<'a, K, V, C>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V, C: Storage<Item<AnyRange<K>, V>>> IntoIterator for RangeMap<K, V, C>

type Item = (AnyRange<K>, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, V, C>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K, V, C: Storage<Item<AnyRange<K>, V>>> Ord for RangeMap<K, V, C>

where K: Measure + PartialEnum + Ord, V: Ord,

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl<K, V, C, D> PartialEq<RangeMap<K, V, D>> for RangeMap<K, V, C>

where K: Measure + PartialOrd + PartialEnum, V: PartialEq, C: Storage<Item<AnyRange<K>, V>>, D: Storage<Item<AnyRange<K>, V>>,

fn eq(&self, other: &RangeMap<K, V, D>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<K, V, C, D> PartialOrd<RangeMap<K, V, D>> for RangeMap<K, V, C>

where K: Measure + PartialOrd + PartialEnum, V: PartialOrd, C: Storage<Item<AnyRange<K>, V>>, D: Storage<Item<AnyRange<K>, V>>,

fn partial_cmp(&self, other: &RangeMap<K, V, D>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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