formica 0.1.0

High-performance Rust clustering library for financial data analysis
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

//! Configuration and builder for KMeans clustering

use crate::core::{ConfigError, FormicaXError};

/// Supported KMeans algorithm variants
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum KMeansVariant {
    Lloyd,
    Elkan,
    Hamerly,
    MiniBatch,
}

impl Default for KMeansVariant {
    fn default() -> Self {
        Self::Lloyd
    }
}

/// Builder for KMeans configuration
#[derive(Debug, Clone)]
pub struct KMeansConfig {
    /// Number of clusters
    pub k: usize,
    /// Algorithm variant
    pub variant: KMeansVariant,
    /// Enable parallel processing
    pub parallel: bool,
    /// Maximum number of iterations
    pub max_iterations: usize,
    /// Convergence tolerance
    pub tolerance: f64,
    /// Random seed for reproducibility
    pub random_seed: Option<u64>,
    /// Enable SIMD optimization
    pub simd: bool,
}

impl KMeansConfig {
    /// Start building a new KMeansConfig
    pub fn builder() -> KMeansConfigBuilder {
        KMeansConfigBuilder::default()
    }
}

#[derive(Debug, Clone, Default)]
pub struct KMeansConfigBuilder {
    k: Option<usize>,
    variant: Option<KMeansVariant>,
    parallel: Option<bool>,
    max_iterations: Option<usize>,
    tolerance: Option<f64>,
    random_seed: Option<u64>,
}

impl KMeansConfigBuilder {
    /// Set the number of clusters
    pub fn k(mut self, k: usize) -> Self {
        self.k = Some(k);
        self
    }

    /// Set the K-means variant
    pub fn variant(mut self, variant: KMeansVariant) -> Self {
        self.variant = Some(variant);
        self
    }

    /// Enable parallel processing
    pub fn parallel(mut self, parallel: bool) -> Self {
        self.parallel = Some(parallel);
        self
    }

    /// Set maximum iterations
    pub fn max_iterations(mut self, max_iterations: usize) -> Self {
        self.max_iterations = Some(max_iterations);
        self
    }

    /// Set convergence tolerance
    pub fn tolerance(mut self, tolerance: f64) -> Self {
        self.tolerance = Some(tolerance);
        self
    }

    /// Set random seed
    pub fn random_seed(mut self, random_seed: u64) -> Self {
        self.random_seed = Some(random_seed);
        self
    }

    /// Build the configuration
    pub fn build(self) -> Result<KMeansConfig, FormicaXError> {
        let k = self
            .k
            .ok_or(FormicaXError::Config(ConfigError::MissingField {
                field: "k".to_string(),
            }))?;

        if k == 0 {
            return Err(FormicaXError::Config(ConfigError::InvalidValue {
                field: "k".to_string(),
                message: "must be greater than 0".to_string(),
            }));
        }

        Ok(KMeansConfig {
            k,
            variant: self.variant.unwrap_or(KMeansVariant::Lloyd),
            parallel: self.parallel.unwrap_or(false),
            max_iterations: self.max_iterations.unwrap_or(100),
            tolerance: self.tolerance.unwrap_or(1e-8),
            random_seed: self.random_seed,
            simd: false,
        })
    }
}