Struct easy_collections::EasySet

pub struct EasySet<K: Eq + Hash> { /* fields omitted */ }

A wrapper around HashSet which implements a lot of traits. One of the main benefits is that this map implements the BitAnd, BitOr, BitXor, Sub and Ord traits in the same manner as Python's sets: https://docs.python.org/2/library/sets.html#set-objects

use easy_collections::set;

let a = &set!{1, 2, 3};
let b = &set!{2, 3, 4};
// intersection
assert_eq!(a & b, set!{2, 3});
// union
assert_eq!(a | b, set!{1, 2, 3, 4});
// symmetric difference
assert_eq!(a ^ b, set!{1, 4});
// difference
assert_eq!(a - b, set!{1});

let c = &set!{1, 2, 3, 4};
// subset
assert!(a < c && b < c);
// superset
assert!(c > a && c > b);
// equality
assert!(a == a);

Implementations

impl<K: Eq + Hash> EasySet<K>

pub fn new() -> EasySet<K>

Create a new EasySet.

Note, there are macros to make this easier:

use easy_collections::{EasySet, set};

// create an empty set
let set: EasySet<usize> = set!{};
// create a set with values
let set = set!{'a', 'b', 'c', 'd'};

pub fn insert(&mut self, k: K) -> bool

Same as HashSet::insert.

pub fn contains(&self, k: &K) -> bool

Same as HashSet::contains.

pub fn remove(&mut self, k: &K) -> bool

Same as HashSet::remove.

Methods from Deref<Target = HashSet<K>>

pub fn capacity(&self) -> usize

Returns the number of elements the set can hold without reallocating.

Examples

use std::collections::HashSet;
let set: HashSet<i32> = HashSet::with_capacity(100);
assert!(set.capacity() >= 100);

pub fn iter(&self) -> Iter<'_, T>

An iterator visiting all elements in arbitrary order. The iterator element type is &'a T.

Examples

use std::collections::HashSet;
let mut set = HashSet::new();
set.insert("a");
set.insert("b");

// Will print in an arbitrary order.
for x in set.iter() {
    println!("{}", x);
}

pub fn len(&self) -> usize

Returns the number of elements in the set.

Examples

use std::collections::HashSet;

let mut v = HashSet::new();
assert_eq!(v.len(), 0);
v.insert(1);
assert_eq!(v.len(), 1);

pub fn is_empty(&self) -> bool

Returns true if the set contains no elements.

Examples

use std::collections::HashSet;

let mut v = HashSet::new();
assert!(v.is_empty());
v.insert(1);
assert!(!v.is_empty());

pub fn hasher(&self) -> &S

Returns a reference to the set's BuildHasher.

Examples

use std::collections::HashSet;
use std::collections::hash_map::RandomState;

let hasher = RandomState::new();
let set: HashSet<i32> = HashSet::with_hasher(hasher);
let hasher: &RandomState = set.hasher();

pub fn difference(&'a self, other: &'a HashSet<T, S>) -> Difference<'a, T, S>

Visits the values representing the difference, i.e., the values that are in self but not in other.

Examples

use std::collections::HashSet;
let a: HashSet<_> = [1, 2, 3].iter().cloned().collect();
let b: HashSet<_> = [4, 2, 3, 4].iter().cloned().collect();

// Can be seen as `a - b`.
for x in a.difference(&b) {
    println!("{}", x); // Print 1
}

let diff: HashSet<_> = a.difference(&b).collect();
assert_eq!(diff, [1].iter().collect());

// Note that difference is not symmetric,
// and `b - a` means something else:
let diff: HashSet<_> = b.difference(&a).collect();
assert_eq!(diff, [4].iter().collect());

pub fn symmetric_difference(
    &'a self,
    other: &'a HashSet<T, S>
) -> SymmetricDifference<'a, T, S>

Visits the values representing the symmetric difference, i.e., the values that are in self or in other but not in both.

Examples

use std::collections::HashSet;
let a: HashSet<_> = [1, 2, 3].iter().cloned().collect();
let b: HashSet<_> = [4, 2, 3, 4].iter().cloned().collect();

// Print 1, 4 in arbitrary order.
for x in a.symmetric_difference(&b) {
    println!("{}", x);
}

let diff1: HashSet<_> = a.symmetric_difference(&b).collect();
let diff2: HashSet<_> = b.symmetric_difference(&a).collect();

assert_eq!(diff1, diff2);
assert_eq!(diff1, [1, 4].iter().collect());

pub fn intersection(
    &'a self,
    other: &'a HashSet<T, S>
) -> Intersection<'a, T, S>

Visits the values representing the intersection, i.e., the values that are both in self and other.

Examples

use std::collections::HashSet;
let a: HashSet<_> = [1, 2, 3].iter().cloned().collect();
let b: HashSet<_> = [4, 2, 3, 4].iter().cloned().collect();

// Print 2, 3 in arbitrary order.
for x in a.intersection(&b) {
    println!("{}", x);
}

let intersection: HashSet<_> = a.intersection(&b).collect();
assert_eq!(intersection, [2, 3].iter().collect());

pub fn union(&'a self, other: &'a HashSet<T, S>) -> Union<'a, T, S>

Visits the values representing the union, i.e., all the values in self or other, without duplicates.

Examples

use std::collections::HashSet;
let a: HashSet<_> = [1, 2, 3].iter().cloned().collect();
let b: HashSet<_> = [4, 2, 3, 4].iter().cloned().collect();

// Print 1, 2, 3, 4 in arbitrary order.
for x in a.union(&b) {
    println!("{}", x);
}

let union: HashSet<_> = a.union(&b).collect();
assert_eq!(union, [1, 2, 3, 4].iter().collect());

pub fn contains<Q>(&self, value: &Q) -> bool where
    T: Borrow<Q>,
    Q: Hash + Eq + ?Sized, 

Returns true if the set contains a value.

The value may be any borrowed form of the set's value type, but Hash and Eq on the borrowed form must match those for the value type.

Examples

use std::collections::HashSet;

let set: HashSet<_> = [1, 2, 3].iter().cloned().collect();
assert_eq!(set.contains(&1), true);
assert_eq!(set.contains(&4), false);

pub fn get<Q>(&self, value: &Q) -> Option<&T> where
    T: Borrow<Q>,
    Q: Hash + Eq + ?Sized, 

Returns a reference to the value in the set, if any, that is equal to the given value.

The value may be any borrowed form of the set's value type, but Hash and Eq on the borrowed form must match those for the value type.

Examples

use std::collections::HashSet;

let set: HashSet<_> = [1, 2, 3].iter().cloned().collect();
assert_eq!(set.get(&2), Some(&2));
assert_eq!(set.get(&4), None);

pub fn is_disjoint(&self, other: &HashSet<T, S>) -> bool

Returns true if self has no elements in common with other. This is equivalent to checking for an empty intersection.

Examples

use std::collections::HashSet;

let a: HashSet<_> = [1, 2, 3].iter().cloned().collect();
let mut b = HashSet::new();

assert_eq!(a.is_disjoint(&b), true);
b.insert(4);
assert_eq!(a.is_disjoint(&b), true);
b.insert(1);
assert_eq!(a.is_disjoint(&b), false);

pub fn is_subset(&self, other: &HashSet<T, S>) -> bool

Returns true if the set is a subset of another, i.e., other contains at least all the values in self.

Examples

use std::collections::HashSet;

let sup: HashSet<_> = [1, 2, 3].iter().cloned().collect();
let mut set = HashSet::new();

assert_eq!(set.is_subset(&sup), true);
set.insert(2);
assert_eq!(set.is_subset(&sup), true);
set.insert(4);
assert_eq!(set.is_subset(&sup), false);

pub fn is_superset(&self, other: &HashSet<T, S>) -> bool

Returns true if the set is a superset of another, i.e., self contains at least all the values in other.

Examples

use std::collections::HashSet;

let sub: HashSet<_> = [1, 2].iter().cloned().collect();
let mut set = HashSet::new();

assert_eq!(set.is_superset(&sub), false);

set.insert(0);
set.insert(1);
assert_eq!(set.is_superset(&sub), false);

set.insert(2);
assert_eq!(set.is_superset(&sub), true);

Trait Implementations

impl<K: Eq + Hash + Clone> BitAnd<&'_ EasySet<K>> for &EasySet<K>

type Output = EasySet<K>

The resulting type after applying the & operator.

pub fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl<K: Eq + Hash + Clone> BitAnd<EasySet<K>> for EasySet<K>

type Output = Self

The resulting type after applying the & operator.

pub fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl<K: Eq + Hash + Clone> BitAndAssign<EasySet<K>> for EasySet<K>

pub fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl<K: Eq + Hash + Clone> BitOr<&'_ EasySet<K>> for &EasySet<K>

type Output = EasySet<K>

The resulting type after applying the | operator.

pub fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl<K: Eq + Hash + Clone> BitOr<EasySet<K>> for EasySet<K>

type Output = Self

The resulting type after applying the | operator.

pub fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl<K: Eq + Hash + Clone> BitOrAssign<EasySet<K>> for EasySet<K>

pub fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl<K: Eq + Hash + Clone> BitXor<&'_ EasySet<K>> for &EasySet<K>

type Output = EasySet<K>

The resulting type after applying the ^ operator.

pub fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl<K: Eq + Hash + Clone> BitXor<EasySet<K>> for EasySet<K>

type Output = Self

The resulting type after applying the ^ operator.

pub fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl<K: Eq + Hash + Clone> BitXorAssign<EasySet<K>> for EasySet<K>

pub fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl<K: Clone + Eq + Hash> Clone for EasySet<K>

pub fn clone(&self) -> EasySet<K>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug + Eq + Hash> Debug for EasySet<K>

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

Formats the value using the given formatter.

impl<K: Eq + Hash> Deref for EasySet<K>

type Target = HashSet<K>

The resulting type after dereferencing.

pub fn deref(&self) -> &Self::Target

Dereferences the value.

impl<K: Eq + Hash> Eq for EasySet<K>

impl<K: Eq + Hash + Clone> From<&'_ [K]> for EasySet<K>

pub fn from(v: &[K]) -> Self

Performs the conversion.

impl From<String> for EasySet<char>

pub fn from(s: String) -> Self

Performs the conversion.

impl<K: Eq + Hash> From<Vec<K, Global>> for EasySet<K>

pub fn from(v: Vec<K>) -> Self

Performs the conversion.

impl<K: Eq + Hash> FromIterator<K> for EasySet<K>

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

Creates a value from an iterator.

impl<K: Eq + Hash> IntoIterator for EasySet<K>

type Item = K

The type of the elements being iterated over.

type IntoIter = IntoIter<Self::Item>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K: Eq + Hash> Ord for EasySet<K>

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<K: PartialEq + Eq + Hash> PartialEq<EasySet<K>> for EasySet<K>

pub fn eq(&self, other: &EasySet<K>) -> bool

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

pub fn ne(&self, other: &EasySet<K>) -> bool

This method tests for !=.

impl<K: Eq + Hash> PartialOrd<EasySet<K>> for EasySet<K>

pub fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<K: Eq + Hash> StructuralEq for EasySet<K>

impl<K: Eq + Hash> StructuralPartialEq for EasySet<K>

impl<K: Eq + Hash + Clone> Sub<&'_ EasySet<K>> for &EasySet<K>

type Output = EasySet<K>

The resulting type after applying the - operator.

pub fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<K: Eq + Hash + Clone> Sub<EasySet<K>> for EasySet<K>

type Output = Self

The resulting type after applying the - operator.

pub fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<K: Eq + Hash + Clone> SubAssign<EasySet<K>> for EasySet<K>

pub fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.