|
| 1 | +use crate::core::vector::Vector; |
| 2 | + |
| 3 | +#[derive(Debug, Clone)] |
| 4 | +pub struct Cluster { |
| 5 | + pub centroid: Vector, |
| 6 | + pub members: Vec<Vector>, |
| 7 | +} |
| 8 | + |
| 9 | +impl Cluster { |
| 10 | + fn new(vector: Vector) -> Self { |
| 11 | + Self { |
| 12 | + centroid: vector.clone(), |
| 13 | + members: vec![vector], |
| 14 | + } |
| 15 | + } |
| 16 | + |
| 17 | + fn recompute_centroid(&mut self) { |
| 18 | + if self.members.is_empty() { |
| 19 | + return; |
| 20 | + } |
| 21 | + let dimensions = self.members[0].dimensions; |
| 22 | + let mut sums = vec![0.0f32; dimensions]; |
| 23 | + for v in &self.members { |
| 24 | + for (i, val) in v.values.iter().enumerate() { |
| 25 | + sums[i] += val; |
| 26 | + } |
| 27 | + } |
| 28 | + let len_inv = 1.0 / self.members.len() as f32; |
| 29 | + for sum in &mut sums { |
| 30 | + *sum *= len_inv; |
| 31 | + } |
| 32 | + self.centroid = Vector::new(sums); |
| 33 | + } |
| 34 | +} |
| 35 | + |
| 36 | +/// Perform a simple agglomerative clustering using Euclidean distance. |
| 37 | +/// Clusters are merged until the closest pair has distance greater than |
| 38 | +/// `threshold`. |
| 39 | +pub fn cluster_vectors(vectors: &[Vector], threshold: f32) -> Vec<Cluster> { |
| 40 | + let mut clusters: Vec<Cluster> = vectors.iter().cloned().map(Cluster::new).collect(); |
| 41 | + if clusters.is_empty() { |
| 42 | + return clusters; |
| 43 | + } |
| 44 | + loop { |
| 45 | + let mut best_dist = f32::MAX; |
| 46 | + let mut best_pair: Option<(usize, usize)> = None; |
| 47 | + for i in 0..clusters.len() { |
| 48 | + for j in (i + 1)..clusters.len() { |
| 49 | + let dist = clusters[i] |
| 50 | + .centroid |
| 51 | + .euclidean_distance(&clusters[j].centroid); |
| 52 | + if dist < best_dist { |
| 53 | + best_dist = dist; |
| 54 | + best_pair = Some((i, j)); |
| 55 | + } |
| 56 | + } |
| 57 | + } |
| 58 | + match best_pair { |
| 59 | + Some((i, j)) if best_dist <= threshold => { |
| 60 | + let mut members = clusters[i].members.clone(); |
| 61 | + members.extend(clusters[j].members.clone()); |
| 62 | + clusters[i].members = members; |
| 63 | + clusters[i].recompute_centroid(); |
| 64 | + clusters.remove(j); |
| 65 | + } |
| 66 | + _ => break, |
| 67 | + } |
| 68 | + } |
| 69 | + clusters |
| 70 | +} |
| 71 | + |
| 72 | +#[cfg(test)] |
| 73 | +mod tests { |
| 74 | + use super::*; |
| 75 | + |
| 76 | + #[test] |
| 77 | + fn test_basic_clustering() { |
| 78 | + let v1 = Vector::new(vec![0.0, 0.0]); |
| 79 | + let v2 = Vector::new(vec![0.1, -0.1]); |
| 80 | + let v3 = Vector::new(vec![5.0, 5.0]); |
| 81 | + let v4 = Vector::new(vec![5.2, 4.9]); |
| 82 | + let clusters = cluster_vectors(&[v1, v2, v3, v4], 0.5); |
| 83 | + assert_eq!(clusters.len(), 2); |
| 84 | + } |
| 85 | + |
| 86 | + #[test] |
| 87 | + fn test_single_cluster_when_threshold_large() { |
| 88 | + let vectors = vec![ |
| 89 | + Vector::new(vec![0.0, 0.0]), |
| 90 | + Vector::new(vec![1.0, 0.0]), |
| 91 | + Vector::new(vec![0.0, 1.0]), |
| 92 | + ]; |
| 93 | + let clusters = cluster_vectors(&vectors, 10.0); |
| 94 | + assert_eq!(clusters.len(), 1); |
| 95 | + assert_eq!(clusters[0].members.len(), 3); |
| 96 | + } |
| 97 | + |
| 98 | + #[test] |
| 99 | + fn test_no_merge_when_threshold_small() { |
| 100 | + let vectors = vec![Vector::new(vec![0.0, 0.0]), Vector::new(vec![1.0, 1.0])]; |
| 101 | + let clusters = cluster_vectors(&vectors, 0.1); |
| 102 | + assert_eq!(clusters.len(), 2); |
| 103 | + } |
| 104 | +} |
0 commit comments