Struct timely::progress::frontier::Antichain

pub struct Antichain<T> { /* fields omitted */ }

A set of mutually incomparable elements.

An antichain is a set of partially ordered elements, each of which is incomparable to the others. This antichain implementation allows you to repeatedly introduce elements to the antichain, and which will evict larger elements to maintain the minimal antichain, those incomparable elements no greater than any other element.

Methods

impl<T: PartialOrder> Antichain<T>

pub fn insert(&mut self, element: T) -> bool

Updates the Antichain if the element is not greater than or equal to some present element.

Returns true if element is added to the set

Examples

 use timely::progress::frontier::Antichain;

 let mut frontier = Antichain::new();
 assert!(frontier.insert(2));
 assert!(!frontier.insert(3));

pub fn extend<I: IntoIterator<Item = T>>(&mut self, iterator: I) -> bool

Performs a sequence of insertion and return true iff any insertion does.

Examples

 use timely::progress::frontier::Antichain;

 let mut frontier = Antichain::new();
 assert!(frontier.extend(Some(3)));
 assert!(frontier.extend(vec![2, 5]));
 assert!(!frontier.extend(vec![3, 4]));

pub fn new() -> Antichain<T>

Creates a new empty Antichain.

Examples

 use timely::progress::frontier::Antichain;

 let mut frontier = Antichain::<u32>::new();

pub fn from_elem(element: T) -> Antichain<T>

Creates a new singleton Antichain.

Examples

 use timely::progress::frontier::Antichain;

 let mut frontier = Antichain::from_elem(2);

pub fn clear(&mut self)

Clears the contents of the antichain.

Examples

 use timely::progress::frontier::Antichain;

 let mut frontier = Antichain::from_elem(2);
 frontier.clear();
 assert!(frontier.elements().is_empty());

pub fn sort(&mut self) where
    T: Ord, 

Sorts the elements so that comparisons between antichains can be made.

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

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

Examples

 use timely::progress::frontier::Antichain;

 let mut frontier = Antichain::from_elem(2);
 assert!(frontier.less_than(&3));
 assert!(!frontier.less_than(&2));
 assert!(!frontier.less_than(&1));

 frontier.clear();
 assert!(!frontier.less_than(&3));

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

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

Examples

 use timely::progress::frontier::Antichain;

 let mut frontier = Antichain::from_elem(2);
 assert!(frontier.less_equal(&3));
 assert!(frontier.less_equal(&2));
 assert!(!frontier.less_equal(&1));

 frontier.clear();
 assert!(!frontier.less_equal(&3));

pub fn dominates(&self, other: &Antichain<T>) -> bool

Returns true if every element of other is greater or equal to some element of self.

Important traits for &'_ mut [u8]

impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]

pub fn elements(&self) -> &[T]

Reveals the elements in the antichain.

Examples

 use timely::progress::frontier::Antichain;

 let mut frontier = Antichain::from_elem(2);
 assert_eq!(frontier.elements(), &[2]);

Trait Implementations

impl<T: Clone> Clone for Antichain<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Default> Default for Antichain<T>

fn default() -> Antichain<T>

Returns the "default value" for a type.

impl<T: Eq> Eq for Antichain<T>

impl<T: PartialEq> PartialEq<Antichain<T>> for Antichain<T>

fn eq(&self, other: &Antichain<T>) -> bool

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

fn ne(&self, other: &Antichain<T>) -> bool

This method tests for !=.

impl<T: Debug> Debug for Antichain<T>

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

Formats the value using the given formatter.

impl<T> StructuralPartialEq for Antichain<T>

impl<T> StructuralEq for Antichain<T>

impl<T> Abomonation for Antichain<T> where
    Vec<T>: Abomonation,
    T: Abomonation, 

unsafe fn entomb<W: Write>(&self, _write: &mut W) -> Result<()>

Write any additional information about &self beyond its binary representation.

fn extent(&self) -> usize

Reports the number of further bytes required to entomb self.

unsafe fn exhume<'a, 'b>(
    &'a mut self,
    bytes: &'b mut [u8]
) -> Option<&'b mut [u8]>

Recover any information for &mut self not evident from its binary representation.

impl<T> Serialize for Antichain<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.

impl<'de, T> Deserialize<'de> for Antichain<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.