Struct Set

pub struct Set {
    pub authoritative: Arc<BTreeSet<Value>>,
    pub fast: Option<Arc<HashSet<Literal>>>,
}

Value’s internal representation of a Set

Fields

authoritative: Arc<BTreeSet<Value>>

the values in the set, stored in a BTreeSet

fast: Option<Arc<HashSet<Literal>>>

if possible, HashSet<Literal> representation of the set. (This is possible if all the elements are literals.) Some operations are much faster in this case.

INVARIANT (FastRepr) we guarantee that if the elements are all literals, then this will be Some. (This allows us to further optimize e.g. equality checks between sets: for instance, we know that if one set has fast and another does not, the sets can’t be equal.)

Implementations

impl Set

pub fn empty() -> Self

Create an empty set

pub fn new(vals: impl IntoIterator<Item = Value>) -> Self

Create a set with the given Values as elements

pub fn from_lits(lits: impl IntoIterator<Item = Literal>) -> Self

Create a set with the given Literals as elements

pub fn len(&self) -> usize

Get the number of items in the set

pub fn is_empty(&self) -> bool

Convenience method to check if a set is empty

pub fn iter(&self) -> impl Iterator<Item = &Value>

Borrowed iterator

pub fn is_subset(&self, other: &Set) -> bool

Subset test

pub fn is_disjoint(&self, other: &Set) -> bool

Disjointness test

pub fn contains(&self, value: &Value) -> bool

Membership test

Trait Implementations

impl Clone for Set

fn clone(&self) -> Set

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Set

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

Formats the value using the given formatter.

impl FromIterator<Literal> for Set

fn from_iter<T: IntoIterator<Item = Literal>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Value> for Set

fn from_iter<T: IntoIterator<Item = Value>>(iter: T) -> Self

Creates a value from an iterator.

impl Ord for Set

fn cmp(&self, other: &Set) -> 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.

impl PartialEq for Set

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Set

fn partial_cmp(&self, other: &Self) -> 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.

impl Eq for Set