Struct threshold::MaxSet

pub struct MaxSet { /* fields omitted */ }

Implementations

impl MaxSet

pub fn from(max: u64) -> Self

Creates a MaxSet from the highest event.

Trait Implementations

impl Clone for MaxSet

fn clone(&self) -> MaxSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MaxSet

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

Formats the value using the given formatter.

impl Default for MaxSet

fn default() -> MaxSet

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for MaxSet

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for MaxSet

impl EventSet for MaxSet

type EventIter = EventIter

fn new() -> Self

Returns a new MaxSet instance.

fn next_event(&mut self) -> u64

Generates the next event.

Examples

use threshold::*;

let mut maxset = MaxSet::new();
assert_eq!(maxset.next_event(), 1);
assert_eq!(maxset.next_event(), 2);

fn add_event(&mut self, event: u64) -> bool

Adds an event to the set. Returns true if it's a new event.

Examples

use threshold::*;

let mut maxset = MaxSet::new();
assert!(!maxset.is_event(9));
assert!(!maxset.is_event(10));

maxset.add_event(10);
assert!(maxset.is_event(9));
assert!(maxset.is_event(10));

fn add_event_range(&mut self, start: u64, end: u64) -> bool

Adds a range of events to the set. Returns true if a new event was added.

In the case of MaxSet we have that:

• add_event_range(start, end) == add_event(end)

fn is_event(&self, event: u64) -> bool

Checks if an event is part of the set.

Examples

use threshold::*;

let mut maxset = MaxSet::new();
let event = maxset.next_event();
assert!(maxset.is_event(event));

fn events(&self) -> (u64, Vec<u64>)

Returns all events seen.

Examples

use threshold::*;

let mut maxset = MaxSet::new();
maxset.add_event(2);
maxset.add_event(4);
assert_eq!(maxset.events(), (4, vec![]));

fn frontier(&self) -> u64

Returns the frontier (the highest contiguous event seen). For a MaxSet, this is not necessarily the highest contiguous event, but simply the highest event. For exact EventSet representations that will actually return the highest contiguous event, see AboveExSet and BelowExSet.

Examples

use threshold::*;

let mut maxset = MaxSet::new();
assert_eq!(maxset.frontier(), 0);

maxset.add_event(1);
assert_eq!(maxset.frontier(), 1);

maxset.add_event(3);
assert_eq!(maxset.frontier(), 3);

maxset.add_event(2);
assert_eq!(maxset.frontier(), 3);

maxset.add_event(4);
assert_eq!(maxset.frontier(), 4);

maxset.add_event(6);
assert_eq!(maxset.frontier(), 6);

fn join(&mut self, other: &Self)

Merges other MaxSet into self.

Examples

use threshold::*;

let mut maxset = MaxSet::from_event(10);
assert!(!maxset.is_event(20));

maxset.join(&MaxSet::from_event(20));
assert!(maxset.is_event(20));

fn meet(&mut self, other: &Self)

Intersects other MaxSet with self.

Examples

use threshold::*;

let mut maxset = MaxSet::from_event(20);
assert!(maxset.is_event(20));

maxset.meet(&MaxSet::from_event(10));
assert!(!maxset.is_event(20));

fn event_iter(self) -> Self::EventIter

Returns a MaxSet event iterator with all events from lowest to highest.

Examples

use threshold::*;

let mut maxset = MaxSet::new();
maxset.add_event(3);

let mut iter = maxset.event_iter();
assert_eq!(iter.next(), Some(1));
assert_eq!(iter.next(), Some(2));
assert_eq!(iter.next(), Some(3));
assert_eq!(iter.next(), None);

fn from_event(event: u64) -> Self

Creates a new instance from event.

fn from_event_range(start: u64, end: u64) -> Self

Creates a new instance from a range of events.

fn from_events<I: IntoIterator<Item = u64>>(iter: I) -> Self

Creates a new instance from several events.

impl PartialEq<MaxSet> for MaxSet

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

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

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

This method tests for !=.

impl Serialize for MaxSet

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

Serialize this value into the given Serde serializer.

impl StructuralEq for MaxSet

impl StructuralPartialEq for MaxSet