Skip to main content

AgglomerativeClustering

Struct AgglomerativeClustering 

Source
pub struct AgglomerativeClustering { /* private fields */ }
Expand description

Agglomerative (bottom-up) hierarchical clustering.

Builds a tree of clusters (dendrogram) by iteratively merging closest clusters using various linkage methods.

§Algorithm

  1. Start with each point as its own cluster
  2. Repeat until reaching n_clusters:
    • Find two closest clusters using linkage method
    • Merge them
    • Update distance matrix
  3. Return cluster labels

§Examples

use aprender::prelude::*;

let data = Matrix::from_vec(6, 2, vec![
    1.0, 1.0, 1.1, 1.0, 1.0, 1.1,
    5.0, 5.0, 5.1, 5.0, 5.0, 5.1,
]).expect("Valid matrix dimensions and data length");

let mut hc = AgglomerativeClustering::new(2, Linkage::Average);
hc.fit(&data).expect("Fit succeeds with valid data");

let labels = hc.predict(&data);
assert_eq!(labels.len(), 6);

§Performance

  • Time complexity: O(n³) for naive implementation
  • Space complexity: O(n²) for distance matrix

Implementations§

Source§

impl AgglomerativeClustering

Source

pub fn new(n_clusters: usize, linkage: Linkage) -> Self

Create new AgglomerativeClustering with target number of clusters and linkage method.

Source

pub fn n_clusters(&self) -> usize

Get target number of clusters.

Source

pub fn linkage(&self) -> Linkage

Get linkage method.

Source

pub fn is_fitted(&self) -> bool

Check if model has been fitted.

Source

pub fn labels(&self) -> &Vec<usize>

Get cluster labels (panic if not fitted).

Source

pub fn dendrogram(&self) -> &Vec<Merge>

Get dendrogram merge history (panic if not fitted).

Trait Implementations§

Source§

impl Clone for AgglomerativeClustering

Source§

fn clone(&self) -> AgglomerativeClustering

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AgglomerativeClustering

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for AgglomerativeClustering

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for AgglomerativeClustering

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl UnsupervisedEstimator for AgglomerativeClustering

Source§

type Labels = Vec<usize>

The type of labels/clusters produced.
Source§

fn fit(&mut self, x: &Matrix<f32>) -> Result<()>

Fits the model to data. Read more
Source§

fn predict(&self, _x: &Matrix<f32>) -> Self::Labels

Predicts cluster assignments or transforms data.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,