Struct NodeSet 

pub struct NodeSet<T = IdRangeList> { /* private fields */ }

An unordered collection of nodes indexed in one or more dimensions.

Two implementations are provided:

• NodeSet<IdRangeList> which stores node indices in Vecs
• NodeSet<IdRangeTree> which stores node indices in BTrees

By default IdRangeList are used as they are faster to build for one shot operations which are the most common, especially when using the CLI. However, if many updates are performed on a large NodeSet IdRangeTree may more efficient especially for one-dimensional NodeSets.

Implementations

impl NodeSet<IdRangeList>

pub fn new() -> Self

impl<T> NodeSet<T>

where T: IdRange + PartialEq + Clone + Display + Debug,

pub fn len(&self) -> usize

Returns the number of elements in the set

pub fn is_empty(&self) -> bool

Returns true if the set contains no element

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

Returns an iterator over all elements of the set

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

Returns a new set containing elements found in self and other

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

Returns a new set containing elements found in self but not in other

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

Returns a new set containing elements that are in both self and other

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

Returns a new set containing the elements found in either self or other but not in both

Trait Implementations

impl<T: Clone> Clone for NodeSet<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for NodeSet<T>

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

Formats the value using the given formatter.

impl<T> Default for NodeSet<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Display for NodeSet<T>

where T: IdRange + Display + PartialEq + Clone + Debug,

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

Formats the value using the given formatter.

impl<T> FromStr for NodeSet<T>

where T: IdRange + PartialEq + Clone + Display + Debug,

type Err = NodeSetParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<T: PartialEq> PartialEq for NodeSet<T>

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

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

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<T: Eq> Eq for NodeSet<T>

impl<T> StructuralPartialEq for NodeSet<T>