libspot-rs 0.2.1

Pure Rust implementation of the SPOT algorithm for time series anomaly detection
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

//! Configuration types for SPOT detector

/// Configuration parameters for SPOT detector
///
/// # Serialization
///
/// When the `serde` feature is enabled, this struct can be serialized and deserialized.
/// This is useful for saving detector configurations or loading them from files.
///
/// # Example with serde (requires `serde` feature)
///
/// ```ignore
/// use libspot_rs::SpotConfig;
/// use serde_json;
///
/// let config = SpotConfig::default();
/// let json = serde_json::to_string(&config).unwrap();
/// let loaded: SpotConfig = serde_json::from_str(&json).unwrap();
/// ```
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct SpotConfig {
    /// Anomaly probability threshold (must be between 0 and 1-level)
    pub q: f64,
    /// Whether to observe lower tail (false = upper tail, true = lower tail)
    pub low_tail: bool,
    /// Whether to discard anomalies from model updates
    pub discard_anomalies: bool,
    /// Excess level - high quantile that delimits the tail (must be between 0 and 1)
    pub level: f64,
    /// Maximum number of excess data points to keep
    pub max_excess: usize,
}

impl Default for SpotConfig {
    /// Default configuration that matches the C implementation
    fn default() -> Self {
        Self {
            q: 0.0001,
            low_tail: false,
            discard_anomalies: true,
            level: 0.998,
            max_excess: 200,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use approx::assert_relative_eq;

    #[test]
    fn test_spot_config_default() {
        let config = SpotConfig::default();

        assert_relative_eq!(config.q, 0.0001);
        assert!(!config.low_tail);
        assert!(config.discard_anomalies);
        assert_relative_eq!(config.level, 0.998);
        assert_eq!(config.max_excess, 200);
    }

    #[test]
    fn test_spot_config_clone() {
        let config1 = SpotConfig::default();
        let config2 = config1.clone();

        assert_relative_eq!(config1.q, config2.q);
        assert_eq!(config1.low_tail, config2.low_tail);
        assert_eq!(config1.discard_anomalies, config2.discard_anomalies);
        assert_relative_eq!(config1.level, config2.level);
        assert_eq!(config1.max_excess, config2.max_excess);
    }
}