Struct gardiz::set::Set

pub struct Set<T> where
    T: Ord,  { /* fields omitted */ }

The set of coordinates/vectors in a plane, optimized for being in the plane. Members of the set are Vec2<T>.

Implementations

impl<T> Set<T> where
    T: Ord, 

pub fn new() -> Self

Creates a new empty set.

pub fn is_empty(&self) -> bool

Tests if the set is emtpy.

pub fn len(&self) -> usize

Returns the length of the set, i.e. how many Vec2 are stored in this set.

pub fn contains<U>(&self, point: Vec2<&U>) -> bool where
    T: Borrow<U>,
    U: Ord, 

Tests if the set contains a given point.

pub fn neighbours<U>(
    &self,
    point: Vec2<&U>,
    direction: Direction
) -> Neighbours<'_, T> where
    T: Borrow<U>,
    U: Ord, 

Returns an iterator to the neighbours of a given point in a straight line in the given direction. The starting point is NOT included.

pub fn neighbours_incl<U>(
    &self,
    point: Vec2<&U>,
    direction: Direction
) -> Neighbours<'_, T> where
    T: Borrow<U>,
    U: Ord, 

Returns an iterator to the neighbours of a given point in a straight line in the given direction. The starting point IS included.

pub fn first_neighbour<U>(
    &self,
    point: Vec2<&U>,
    direction: Direction
) -> Option<Vec2<&T>> where
    U: Ord,
    T: Borrow<U>, 

Returns the nearest neighbour in a straight line of a given point in the the given direction.

pub fn last_neighbour<U>(
    &self,
    point: Vec2<&U>,
    direction: Direction
) -> Option<Vec2<&T>> where
    U: Ord,
    T: Borrow<U>, 

Returns the furthest neighbour in a straight line of a given point in the given direction.

pub fn insert(&mut self, point: Vec2<T>) -> bool where
    T: Clone, 

Inserts the given point in the set. Returns whether the insertion actually happened (i.e. the point was not already in the set).

pub fn remove<U>(&mut self, point: Vec2<&U>) -> bool where
    U: Ord,
    T: Borrow<U>, 

Removes a point from the set. Returns whether the removal actuall happened (i.e. the point was in the set).

pub fn rows(&self) -> Rows<'_, T>

Returns an iterator over all the points in the set, in the direction of rows (first point is the lowest), i.e. all X are yielded before going to the next Y.

pub fn columns(&self) -> Columns<'_, T>

Returns an iterator over all the points in the set, in the direction of columns (first point is the lowest), i.e. all Y are yielded before going to the next X.

Trait Implementations

impl<T: Clone> Clone for Set<T> where
    T: Ord, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Set<T> where
    T: Ord, 

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

Formats the value using the given formatter.

impl<T> Default for Set<T> where
    T: Ord, 

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Set<T> where
    T: Ord,
    T: Deserialize<'de> + Clone, 

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

Deserialize this value from the given Serde deserializer.

impl<T> Extend<Vec2<T>> for Set<T> where
    T: Ord + Clone, 

fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = Vec2<T>>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<T> FromIterator<Vec2<T>> for Set<T> where
    T: Ord + Clone, 

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = Vec2<T>>, 

Creates a value from an iterator.

impl<T: PartialEq> PartialEq<Set<T>> for Set<T> where
    T: Ord, 

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

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

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

This method tests for !=.

impl<T> Serialize for Set<T> where
    T: Ord,
    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<T: Eq> Eq for Set<T> where
    T: Ord, 

impl<T> StructuralEq for Set<T> where
    T: Ord, 

impl<T> StructuralPartialEq for Set<T> where
    T: Ord,