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

//! Unit tests for KMeans config and algorithm

#[cfg(test)]
mod tests {
    use super::super::config::*;
    use super::super::algorithm::*;
    use crate::core::FormicaXError;

    #[test]
    fn test_kmeans_config_builder() {
        // Test basic builder functionality
        let config = KMeansConfig::builder()
            .k(5)
            .variant(KMeansVariant::Elkan)
            .max_iterations(200)
            .tolerance(1e-6)
            .parallel(true)
            .simd(true)
            .build()
            .unwrap();

        assert_eq!(config.k, 5);
        assert_eq!(config.variant, KMeansVariant::Elkan);
        assert_eq!(config.max_iterations, 200);
        assert_eq!(config.tolerance, 1e-6);
        assert!(config.parallel);
        assert!(config.simd);
    }

    #[test]
    fn test_kmeans_config_defaults() {
        // Test default values when not specified
        let config = KMeansConfig::builder()
            .k(3)
            .build()
            .unwrap();

        assert_eq!(config.k, 3);
        assert_eq!(config.variant, KMeansVariant::Lloyd); // Default variant
        assert_eq!(config.max_iterations, 100); // Default max_iterations
        assert_eq!(config.tolerance, 1e-8); // Default tolerance
        assert!(!config.parallel); // Default parallel
        assert!(!config.simd); // Default simd
    }

    #[test]
    fn test_kmeans_config_validation_errors() {
        // Test missing k parameter
        let result = KMeansConfig::builder().build();
        assert!(matches!(
            result,
            Err(FormicaXError::Clustering(crate::core::ClusteringError::InvalidParameters { message }))
            if message.contains("k")
        ));

        // Test k < 2
        let result = KMeansConfig::builder().k(1).build();
        assert!(matches!(
            result,
            Err(FormicaXError::Clustering(crate::core::ClusteringError::InvalidParameters { message }))
            if message.contains("clusters")
        ));

        // Test max_iterations = 0
        let result = KMeansConfig::builder().k(3).max_iterations(0).build();
        assert!(matches!(
            result,
            Err(FormicaXError::Clustering(crate::core::ClusteringError::InvalidParameters { message }))
            if message.contains("iterations")
        ));

        // Test tolerance <= 0
        let result = KMeansConfig::builder().k(3).tolerance(0.0).build();
        assert!(matches!(
            result,
            Err(FormicaXError::Clustering(crate::core::ClusteringError::InvalidParameters { message }))
            if message.contains("Tolerance")
        ));

        let result = KMeansConfig::builder().k(3).tolerance(-1.0).build();
        assert!(matches!(
            result,
            Err(FormicaXError::Clustering(crate::core::ClusteringError::InvalidParameters { message }))
            if message.contains("Tolerance")
        ));
    }

    #[test]
    fn test_kmeans_variant_default() {
        assert_eq!(KMeansVariant::default(), KMeansVariant::Lloyd);
    }

    #[test]
    fn test_kmeans_struct_creation() {
        let config = KMeansConfig::builder()
            .k(4)
            .variant(KMeansVariant::Hamerly)
            .build()
            .unwrap();

        let kmeans = KMeans::with_config(config);
        // For now, just verify the struct can be created
        // The actual fit method is still unimplemented
        assert!(true); // Placeholder assertion
    }
}