flow-knn 0.1.1

Algorithm-agnostic k-NN graphs for flow cytometry — exact, usearch HNSW, optional ann-search-rs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

//! Errors for k-NN graph construction.

use thiserror::Error;

use crate::config::DistanceMetric;

#[derive(Debug, Error)]
pub enum KnnError {
    #[error("Dataset too small: need at least 2 points, got {n}")]
    DatasetTooSmall { n: usize },

    #[error("Dimension mismatch: data slice length {len} is not divisible by d={d}")]
    DimensionMismatch { len: usize, d: usize },

    #[error("KNN method not implemented: {method}")]
    MethodNotImplemented { method: String },

    #[error("KNN index error: {0}")]
    Index(String),

    #[error("GPU adapter unavailable: {0}")]
    GpuUnavailable(String),

    #[error(
        "KNN graph size mismatch: graph has n={graph_n} (neighbors len {neighbors_len}), \
         data has n={data_n}"
    )]
    GraphSizeMismatch {
        graph_n: usize,
        neighbors_len: usize,
        data_n: usize,
    },

    #[error(
        "KNN graph k={graph_k} is too small; need at least {required_k} \
         (typically n_neighbors + 50, capped by n − 1)"
    )]
    GraphInsufficientK { graph_k: usize, required_k: usize },

    #[error("KNN graph metric {graph:?} does not match requested metric {requested:?}")]
    GraphMetricMismatch {
        graph: DistanceMetric,
        requested: DistanceMetric,
    },

    #[error("KNN graph I/O error: {0}")]
    Io(String),
}