evoc-rs 0.2.1

Rust port of the EVoC clustering algorithm for high dimensional data
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

//! Re-exports of commonly used types, traits, structures and functions across
//! the crate:
//!
//! ```rust
//! use evoc_rs::prelude::*;
//! ```

pub use crate::errors::EvocErrors;
pub use crate::graph::EvocEmbeddingParams;
pub use crate::nearest_neighbours::nearest_neighbour_cpu::NearestNeighbourParamsEvoc;
pub use crate::utils::sparse::CoordinateList;
pub use crate::utils::traits::EvocFloat;

#[cfg(feature = "gpu")]
pub use crate::nearest_neighbours::nearest_neighbour_gpu::NearestNeighbourParamsGpuEvoc;

///////////
// Enums //
///////////

/// Enum that controls verbosity
#[derive(Clone, Copy, Debug, Default)]
pub enum Verbosity {
    /// No verbosity at all
    #[default]
    Quiet,
    /// Normal levels of verbosity
    Normal,
    /// Detailed verbosity with increased messages
    Detailed,
}

impl Verbosity {
    /// Returns true if normal or detailed verbosity is set
    pub fn normal_verbosity(&self) -> bool {
        matches!(self, Verbosity::Normal | Verbosity::Detailed)
    }

    /// Returns true if detailed verbosity is set
    pub fn detailed_verbosity(&self) -> bool {
        matches!(self, Verbosity::Detailed)
    }
}

/// Parse verbosity leverl
///
/// ### Params
///
/// * `level` - If `1` returns [Verbosity::Normal], with `2`
///   [Verbosity::Detailed]
///
/// ### Returns
///
/// The desired [Verbosity] level.
pub fn parse_verbosity_level(level: usize) -> Verbosity {
    match level {
        0 => Verbosity::Quiet,
        1 => Verbosity::Normal,
        2 => Verbosity::Detailed,
        _ => Verbosity::Quiet,
    }
}

///////////
// Types //
///////////

/// The kNN search results in manifolds. If Ok, it's (indices, distances);
/// otherwise a [EvocErrors].
///
/// ### Fields
///
/// If successful:
///
/// * `0` - The indices of the nearest neighbours excluding self.
/// * `1` - The distances of the nearest neighbours excluding self.
pub type EvocKnnResults<T> = Result<(Vec<Vec<usize>>, Vec<Vec<T>>), EvocErrors>;

/// Type for the pre-computed kNN
///
/// ### Fields
///
/// * `0` - The indices of the nearest neighbours excluding self.
/// * `1` - The distances of the nearest neighbours excluding self.
pub type PreComputedKnn<T> = Option<(Vec<Vec<usize>>, Vec<Vec<T>>)>;