Struct clusterphobia::clustering::cluster::Cluster

pub struct Cluster<C: Chopped, M: Chopped> { /* fields omitted */ }

Groups zero or more members into a category as part of a Clustering.

While the members could be Copyable structs, typically they are integer ids the caller can use to obtain the real objects.

• C : Type of the Cluster Category.
• M : Type of the Cluster Members.

Methods

impl<C: Chopped, M: Chopped> Cluster<C, M>

pub fn empty(category: C) -> Self

Create an empty cluster.

pub fn with_member(category: C, member: M) -> Self

Create a cluster containing a single member.

pub fn len(&self) -> usize

Count of members in the cluster

pub fn is_empty(&self) -> bool

Is the Cluster empty?

pub fn get_category(&self) -> C

Get the Cluster category.

pub fn get_members(&self) -> &HashSet<M>

Get the members of the cluster.

pub fn is_member(&self, item: &M) -> bool

Determines if the given item is a member of the cluster.

pub fn add_member(&mut self, item: M) -> bool

Adds a new member to the cluster.

• returns true if a new item was added,
• returns false if the item was already present in the Cluster.

pub fn remove_member(&mut self, item: &M) -> bool

Removes a member from the cluster.

• returns true item was removed,
• returns false if the item is not present in the Cluster.

pub fn merge(&mut self, other: &mut Self)

Merge two clusters, removing all members from the second and inserting them into the first.

Trait Implementations

impl<C: Clone + Chopped, M: Clone + Chopped> Clone for Cluster<C, M>

fn clone(&self) -> Cluster<C, M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Chopped, M: Chopped> Eq for Cluster<C, M>

impl<C: Chopped, M: Chopped> Ord for Cluster<C, M>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<C: Chopped, M: Chopped> PartialEq<Cluster<C, M>> for Cluster<C, M>

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

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

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

This method tests for !=.

impl<C: Chopped, M: Chopped> PartialOrd<Cluster<C, M>> for Cluster<C, M>

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

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

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

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

#[must_use] 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] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<C: Chopped, M: Chopped> Debug for Cluster<C, M>

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

Formats the value using the given formatter.