fast-umap 1.4.0

Configurable UMAP (Uniform Manifold Approximation and Projection) in Rust
Documentation
use burn::tensor::{Int, Tensor, TensorData, TensorPrimitive};

use crate::backend::Backend;

/// Compute the full [n, n] pairwise Euclidean distance matrix for `data` [n, d].
///
/// Differentiable: the custom `euclidean_pairwise_distance` kernel registers its
/// own backward pass, so gradients flow back through this call during training.
pub fn pairwise_distances<B: Backend>(data: Tensor<B, 2>) -> Tensor<B, 2> {
    let x = data.into_primitive().tensor();
    let pairwise = B::euclidean_pairwise_distance(x);
    Tensor::from_primitive(TensorPrimitive::Float(pairwise))
}

/// CPU-side k-NN: given a flat row-major [n × n] distance matrix (f32), find
/// the k nearest neighbours for every row (excluding the self-distance).
///
/// Returns `(indices, distances)` each flat in row-major order, length `n * k`.
/// * `indices`   – neighbour column indices as i32
/// * `distances` – corresponding Euclidean distances as f32
pub fn knn_from_pairwise_cpu(flat: &[f32], n: usize, k: usize) -> (Vec<i32>, Vec<f32>) {
    assert!(k < n, "k ({k}) must be strictly less than n ({n})");

    let mut out_idx = vec![0i32; n * k];
    let mut out_dist = vec![0f32; n * k];

    for i in 0..n {
        let mut row: Vec<(f32, usize)> = (0..n)
            .filter(|&j| j != i)
            .map(|j| (flat[i * n + j], j))
            .collect();

        // Partial-sort: first k entries become the k smallest (not yet ordered).
        if k < row.len() {
            row.select_nth_unstable_by(k - 1, |a, b| {
                a.0.partial_cmp(&b.0).unwrap_or(std::cmp::Ordering::Equal)
            });
        }
        // Sort the k winners in ascending order.
        row[..k].sort_by(|a, b| {
            a.0.partial_cmp(&b.0).unwrap_or(std::cmp::Ordering::Equal)
        });

        for (slot, (dist, idx)) in row[..k].iter().enumerate() {
            out_idx[i * k + slot] = *idx as i32;
            out_dist[i * k + slot] = *dist;
        }
    }

    (out_idx, out_dist)
}

/// Pack raw CPU k-NN output into GPU tensors.
///
/// Returns `(knn_indices [n, k] Int, knn_dist [n, k] Float)`.
/// The distances are raw Euclidean values (not normalised) — the UMAP loss
/// uses the indices to gather distances and applies the Student-t kernel
/// directly, so no pre-normalisation is needed here.
#[allow(dead_code)]
pub fn knn_tensors_from_cpu<B: Backend>(
    idx_flat: Vec<i32>,
    dist_flat: Vec<f32>,
    n: usize,
    k: usize,
    device: &burn::tensor::Device<B>,
) -> (Tensor<B, 2, Int>, Tensor<B, 2>) {
    let knn_indices: Tensor<B, 2, Int> =
        Tensor::from_data(TensorData::new(idx_flat, [n, k]), device);
    let knn_dist: Tensor<B, 2> =
        Tensor::from_data(TensorData::new(dist_flat, [n, k]), device);
    (knn_indices, knn_dist)
}