Struct abd_clam::UniBall

pub struct UniBall<U: Number> { /* private fields */ }

A UniBall is a cluster that behaves as clusters used to before the introduction of the Cluster trait.

A UniBall has a center and a radius, and (optionally) has two children.

Trait Implementations

impl<U: Number> Cluster<U> for UniBall<U>

fn new_root<I: Instance, D: Dataset<I, U>>(data: &D, seed: Option<u64>) -> Self

Creates a new Cluster from a given dataset.

fn partition<I: Instance, D: Dataset<I, U>, P: PartitionCriterion<U>>( self, data: &mut D, criteria: &P, seed: Option<u64> ) -> Self

Recursively partitions the Cluster until the PartitionCriteria are met.

fn offset(&self) -> usize

The offset of the indices of the Cluster’s instances in the dataset.

fn cardinality(&self) -> usize

The number of points in the cluster.

fn depth(&self) -> usize

The depth of the cluster in the tree.

fn arg_center(&self) -> usize

The index of the instance at the center of the Cluster.

fn radius(&self) -> U

The radius of the cluster.

fn arg_radial(&self) -> usize

The index of the instance with the maximum distance from the center

fn lfd(&self) -> f64

The local fractal dimension of the å.

fn children(&self) -> Option<[&Self; 2]>

The two child clusters.

fn polar_distance(&self) -> Option<U>

The distance between the two poles of the Cluster used for partitioning.

fn arg_poles(&self) -> Option<[usize; 2]>

The indices of the instances used as poles for partitioning.

fn name(&self) -> String

The name of the Cluster String.

fn descend_to(&self, offset: usize, cardinality: usize) -> Option<&Self>

Descends to the Cluster with the given offset and cardinality.

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

Whether the Cluster is an ancestor of another Cluster.

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

Whether the Cluster is a descendant of another Cluster.

fn is_leaf(&self) -> bool

Whether the Cluster is a leaf node in the tree.

fn is_singleton(&self) -> bool

Whether the Cluster is a singleton, i.e. it contains only one instance or has a radius of zero.

fn indices(&self) -> Range<usize>

The indices of the instances in the Cluster after the dataset has been reordered.

fn subtree(&self) -> Vec<&Self>

The subtree of the Cluster.

fn max_leaf_depth(&self) -> usize

The maximum depth of and leaf in the subtree of the Cluster.

fn distance_to_instance<I: Instance, D: Dataset<I, U>>( &self, data: &D, instance: &I ) -> U

Distance from the center to the given instance.

fn distance_to_other<I: Instance, D: Dataset<I, U>>( &self, data: &D, other: &Self ) -> U

Distance from the center of this Cluster to the center of the other Cluster.

fn overlapping_children<I: Instance, D: Dataset<I, U>>( &self, data: &D, query: &I, radius: U ) -> Vec<&Self>

Assuming the Cluster overlaps with the query ball, we return only those children that also overlap with the query ball.

fn save(&self, path: &Path) -> Result<(), String>

Saves a Cluster to a given location.

fn load(path: &Path) -> Result<Self, String>

Loads a Cluster from a given location.

impl<U: Debug + Number> Debug for UniBall<U>

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

Formats the value using the given formatter.

impl<'de, U: Number> Deserialize<'de> for UniBall<U>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<U: Number> Display for UniBall<U>

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

Formats the value using the given formatter.

impl<U: Number> Hash for UniBall<U>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<U: Number> Ord for UniBall<U>

fn cmp(&self, other: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl<U: Number> PartialEq for UniBall<U>

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

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

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

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

impl<U: Number> PartialOrd for UniBall<U>

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

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

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

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

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

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

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<U: Number> Serialize for UniBall<U>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<U: Number> Eq for UniBall<U>