chronix-analytics 0.7.0

Analytics engine for Chronix — preprocessing, forecasting, anomaly detection, multivariate analysis, model lifecycle, and streaming analytics on a SIMD/rayon CPU compute core
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

//! ForecastModel trait definition.

use crate::forecast::error::ForecastError;
use crate::forecast::result::{ForecastResult, ModelParams, ModelType};

/// Core forecasting abstraction.
///
/// All forecast models implement this trait for uniform dispatch, persistence,
/// and online updating.
pub trait ForecastModel: Send + Sync {
    /// Fit the model on historical data.
    fn fit(&mut self, timestamps: &[i64], values: &[f64]) -> Result<(), ForecastError>;

    /// Predict `horizon` steps ahead.
    fn predict(&self, horizon: usize) -> Result<ForecastResult, ForecastError>;

    /// Online update with a single new observation.
    fn update(&mut self, timestamp: i64, value: f64) -> Result<(), ForecastError>;

    /// Returns the model type.
    fn model_type(&self) -> ModelType;

    /// Returns the fitted parameters.
    fn params(&self) -> &ModelParams;
}