Struct timely::progress::frontier::MutableAntichain

pub struct MutableAntichain<T> { /* private fields */ }

An antichain based on a multiset whose elements frequencies can be updated.

The MutableAntichain maintains frequencies for many elements of type T, and exposes the set of elements with positive count not greater than any other elements with positive count. The antichain may both advance and retreat; the changes do not all need to be to elements greater or equal to some elements of the frontier.

The type T must implement PartialOrder as well as Ord. The implementation of the Ord trait is used to efficiently organize the updates for cancellation, and to efficiently determine the lower bounds, and only needs to not contradict the PartialOrder implementation (that is, if PartialOrder orders two elements, then so does the Ord implementation).

The MutableAntichain implementation is done with the intent that updates to it are done in batches, and it is acceptable to rebuild the frontier from scratch when a batch of updates change it. This means that it can be expensive to maintain a large number of counts and change few elements near the frontier.

Implementations

impl<T> MutableAntichain<T>

pub fn new() -> MutableAntichain<T>

Creates a new empty MutableAntichain.

Examples

 use timely::progress::frontier::MutableAntichain;

 let frontier = MutableAntichain::<usize>::new();
 assert!(frontier.is_empty());

pub fn clear(&mut self)

Removes all elements.

Examples

 use timely::progress::frontier::MutableAntichain;

 let mut frontier = MutableAntichain::<usize>::new();
 frontier.clear();
 assert!(frontier.is_empty());

pub fn frontier(&self) -> AntichainRef<'_, T>

Reveals the minimal elements with positive count.

Examples

 use timely::progress::frontier::MutableAntichain;

 let mut frontier = MutableAntichain::<usize>::new();
 assert!(frontier.frontier().len() == 0);

pub fn new_bottom(bottom: T) -> MutableAntichain<T>

where T: Ord + Clone,

Creates a new singleton MutableAntichain.

Examples

 use timely::progress::frontier::{AntichainRef, MutableAntichain};

 let mut frontier = MutableAntichain::new_bottom(0u64);
 assert!(frontier.frontier() == AntichainRef::new(&[0u64]));

pub fn is_empty(&self) -> bool

Returns true if there are no elements in the MutableAntichain.

Examples

 use timely::progress::frontier::MutableAntichain;

 let mut frontier = MutableAntichain::<usize>::new();
 assert!(frontier.is_empty());

pub fn less_than<O>(&self, time: &O) -> bool

where T: PartialOrder<O>,

Returns true if any item in the MutableAntichain is strictly less than the argument.

Examples

 use timely::progress::frontier::MutableAntichain;

 let mut frontier = MutableAntichain::new_bottom(1u64);
 assert!(!frontier.less_than(&0));
 assert!(!frontier.less_than(&1));
 assert!(frontier.less_than(&2));

pub fn less_equal<O>(&self, time: &O) -> bool

where T: PartialOrder<O>,

Returns true if any item in the MutableAntichain is less than or equal to the argument.

Examples

 use timely::progress::frontier::MutableAntichain;

 let mut frontier = MutableAntichain::new_bottom(1u64);
 assert!(!frontier.less_equal(&0));
 assert!(frontier.less_equal(&1));
 assert!(frontier.less_equal(&2));

pub fn update_iter<I>(&mut self, updates: I) -> Drain<'_, [(T, i64); 2]>

where T: Clone + PartialOrder + Ord, I: IntoIterator<Item = (T, i64)>,

Applies updates to the antichain and enumerates any changes.

Examples

 use timely::progress::frontier::{AntichainRef, MutableAntichain};

 let mut frontier = MutableAntichain::new_bottom(1u64);
 let changes =
 frontier
     .update_iter(vec![(1, -1), (2, 7)])
     .collect::<Vec<_>>();

 assert!(frontier.frontier() == AntichainRef::new(&[2]));
 assert!(changes == vec![(1, -1), (2, 1)]);

pub fn count_for<O>(&self, query_time: &O) -> i64

where T: PartialEq<O>,

Reports the count for a queried time.

pub fn updates(&mut self) -> impl Iterator<Item = &(T, i64)>

where T: Clone + PartialOrder + Ord,

Reports the updates that form the frontier. Returns an iterator of timestamps and their frequency.

Rebuilds the internal representation before revealing times and frequencies.

Trait Implementations

impl<T: Clone> Clone for MutableAntichain<T>

fn clone(&self) -> MutableAntichain<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for MutableAntichain<T>

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

Formats the value using the given formatter.

impl<T> Default for MutableAntichain<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for MutableAntichain<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialOrder + Ord + Clone> From<Antichain<T>> for MutableAntichain<T>

fn from(antichain: Antichain<T>) -> Self

Converts to this type from the input type.

impl<'a, T: PartialOrder + Ord + Clone> From<AntichainRef<'a, T>> for MutableAntichain<T>

fn from(antichain: AntichainRef<'a, T>) -> Self

Converts to this type from the input type.

impl<T> FromIterator<(T, i64)> for MutableAntichain<T>

where T: Clone + PartialOrder + Ord,

fn from_iter<I>(iterator: I) -> Self

where I: IntoIterator<Item = (T, i64)>,

Creates a value from an iterator.

impl<T> Serialize for MutableAntichain<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.