carbonfr-core 0.9.6

Domain, use cases and ports for carbon-fr's carbon-intensity core — pure, IO-free Rust (hexagonal architecture).
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
//! Cas d'usage : **backtest** d'un modèle de prévision (ADR-0009).
//!
//! Évaluation *walk-forward* : pour une suite d'**origines** dans une fenêtre de
//! test, on prévoit l'horizon à partir de l'origine (le modèle ne voit que le
//! passé strict de l'origine — pas de fuite), puis on compare la prévision à
//! l'observé. On agrège MAE/RMSE global et par horizon, et on calcule une
//! **référence de persistance** (« demain = dernière valeur connue ») pour
//! situer le modèle. C'est ce qui permet d'annoncer une précision **mesurée**.

use std::collections::HashMap;

use time::{Duration, OffsetDateTime};

use crate::domain::{
    EmissionFactors, ErrorAccumulator, ErrorMetrics, HorizonBands, Measurement, Region,
    TD_LOSS_FACTOR_V1, TimeRange, derive_consumption_series,
};
use crate::ports::{CrossBorderRepository, ForecastError, ForecastModel, IntensityRepository};

use super::ApplicationError;

/// Erreurs d'un horizon donné : modèle vs référence de persistance.
#[derive(Debug, Clone, Copy)]
pub struct HorizonError {
    pub horizon: Duration,
    pub model: Option<ErrorMetrics>,
    pub persistence: Option<ErrorMetrics>,
}

/// Résultat d'un backtest.
#[derive(Debug, Clone)]
pub struct BacktestReport {
    /// Nombre d'origines effectivement évaluées (prévision non vide).
    pub origins: usize,
    /// Erreur globale du modèle (tous horizons confondus).
    pub model: Option<ErrorMetrics>,
    /// Erreur globale de la référence de persistance.
    pub persistence: Option<ErrorMetrics>,
    /// Détail par horizon demandé (h+1, h+6, h+24…).
    pub by_horizon: Vec<HorizonError>,
}

/// Backtest *walk-forward* d'un [`ForecastModel`] contre l'observé d'un
/// [`IntensityRepository`].
pub struct BacktestForecast<F: ForecastModel, R: IntensityRepository> {
    forecast: F,
    repository: R,
    methodology_id: String,
}

impl<F: ForecastModel, R: IntensityRepository> BacktestForecast<F, R> {
    pub fn new(forecast: F, repository: R, methodology_id: impl Into<String>) -> Self {
        Self {
            forecast,
            repository,
            methodology_id: methodology_id.into(),
        }
    }

    /// Évalue le modèle sur les origines `[test.start, test.end)` espacées de
    /// `origin_step`, aux horizons `checkpoints` (au pas natif `step`).
    ///
    /// L'horizon de prévision couvre le plus grand checkpoint (plus un pas, pour
    /// que ce dernier point existe). La persistance prédit, sur tout l'horizon,
    /// la dernière valeur observée **avant** l'origine.
    pub async fn execute(
        &self,
        region: Region,
        test: TimeRange,
        origin_step: Duration,
        step: Duration,
        checkpoints: &[Duration],
    ) -> Result<BacktestReport, ApplicationError> {
        let max_checkpoint = checkpoints
            .iter()
            .copied()
            .max()
            .unwrap_or_else(|| Duration::hours(24));
        // +step pour inclure le point au checkpoint maximal (horizon semi-ouvert).
        let horizon = max_checkpoint + step;

        let mut model = ErrorAccumulator::default();
        let mut persistence = ErrorAccumulator::default();
        let mut h_model = vec![ErrorAccumulator::default(); checkpoints.len()];
        let mut h_persistence = vec![ErrorAccumulator::default(); checkpoints.len()];
        let mut origins = 0usize;
        let step_secs = step.whole_seconds();

        let mut cursor = test.start();
        while cursor < test.end() {
            // L'origine est **alignée sur la grille du pas** (le quart d'heure
            // éCO2mix tombe sur :00/:15/:30/:45 UTC) : sans cet alignement, les
            // points prévus (origine + k·pas) ne coïncideraient pas avec les
            // horodatages observés et aucune paire ne serait comparée.
            let origin = align_down(cursor, step_secs);

            // Une origine sans assez d'historique (typique en début de fenêtre)
            // est **sautée**, pas fatale : seules les vraies erreurs (base,
            // prévision indisponible) interrompent le backtest.
            let predicted = match self
                .forecast
                .forecast(region, &self.methodology_id, origin, horizon)
                .await
            {
                Ok(points) => points,
                Err(ForecastError::NotEnoughData) => {
                    cursor += origin_step;
                    continue;
                }
                Err(other) => return Err(other.into()),
            };

            if !predicted.is_empty() {
                origins += 1;

                // Une seule lecture : le passé proche (pour l'ancre de
                // persistance) et l'observé de l'horizon.
                let observed = if let Some(range) =
                    TimeRange::new(origin - Duration::days(1), origin + horizon)
                {
                    self.repository
                        .range(region, &self.methodology_id, range)
                        .await?
                } else {
                    Vec::new()
                };

                let anchor = observed
                    .iter()
                    .filter(|m| m.at < origin)
                    .max_by_key(|m| m.at)
                    .map(|m| m.intensity.value());
                let actual: HashMap<OffsetDateTime, f64> = observed
                    .iter()
                    .filter(|m| m.at >= origin)
                    .map(|m| (m.at, m.intensity.value()))
                    .collect();

                for point in &predicted {
                    let Some(&truth) = actual.get(&point.at) else {
                        continue;
                    };
                    let forecast_value = point.expected.value();
                    model.observe(forecast_value, truth);
                    if let Some(anchor) = anchor {
                        persistence.observe(anchor, truth);
                    }

                    let offset = point.at - origin;
                    for (index, &checkpoint) in checkpoints.iter().enumerate() {
                        if offset == checkpoint {
                            h_model[index].observe(forecast_value, truth);
                            if let Some(anchor) = anchor {
                                h_persistence[index].observe(anchor, truth);
                            }
                        }
                    }
                }
            }

            cursor += origin_step;
        }

        let by_horizon = checkpoints
            .iter()
            .enumerate()
            .map(|(index, &horizon)| HorizonError {
                horizon,
                model: h_model[index].metrics(),
                persistence: h_persistence[index].metrics(),
            })
            .collect();

        Ok(BacktestReport {
            origins,
            model: model.metrics(),
            persistence: persistence.metrics(),
            by_horizon,
        })
    }

    /// Calibre les **bandes d'incertitude par horizon** (ADR-0011 §5) : *walk-
    /// forward* collectant, par décalage d'horizon, les résidus `observed −
    /// expected`, puis retient les quantiles `q` / `1 − q`. Les bandes obtenues
    /// alimentent le modèle (intervalles s'élargissant avec l'horizon).
    pub async fn calibrate_bands(
        &self,
        region: Region,
        test: TimeRange,
        origin_step: Duration,
        step: Duration,
        horizon: Duration,
        q: f64,
    ) -> Result<HorizonBands, ApplicationError> {
        let step_secs = step.whole_seconds();
        if step_secs <= 0 || horizon <= Duration::ZERO {
            return Ok(HorizonBands::from_residuals(step, &[], q));
        }

        // Résidus par index d'horizon (k·step).
        let mut residuals: Vec<Vec<f64>> = Vec::new();
        let mut cursor = test.start();
        while cursor < test.end() {
            let origin = align_down(cursor, step_secs);
            let predicted = match self
                .forecast
                .forecast(region, &self.methodology_id, origin, horizon)
                .await
            {
                Ok(points) => points,
                Err(ForecastError::NotEnoughData) => {
                    cursor += origin_step;
                    continue;
                }
                Err(other) => return Err(other.into()),
            };

            if !predicted.is_empty() {
                let observed = if let Some(range) = TimeRange::new(origin, origin + horizon) {
                    self.repository
                        .range(region, &self.methodology_id, range)
                        .await?
                } else {
                    Vec::new()
                };
                let actual: HashMap<OffsetDateTime, f64> = observed
                    .iter()
                    .map(|m| (m.at, m.intensity.value()))
                    .collect();

                for point in &predicted {
                    if let Some(&truth) = actual.get(&point.at) {
                        let idx = ((point.at - origin).whole_seconds() / step_secs).max(0) as usize;
                        if residuals.len() <= idx {
                            residuals.resize(idx + 1, Vec::new());
                        }
                        // Erreur = observé − estimation centrale.
                        residuals[idx].push(truth - point.expected.value());
                    }
                }
            }

            cursor += origin_step;
        }

        Ok(HorizonBands::from_residuals(step, &residuals, q))
    }
}

/// Backtest *walk-forward* de la prévision **`acv-ademe@2`** (ADR-0013).
///
/// La vérité `@2` **n'est pas stockée** : on la **dérive** de l'observé (mix FR
/// `acv-ademe@1` + contexte d'import) par [`derive_consumption_series`], une fois
/// pour toute la fenêtre, puis on compare la prévision `@2` à cette vérité. Même
/// principe anti-fuite et même garde (vs persistance) que [`BacktestForecast`].
pub struct BacktestConsumptionForecast<F, R, C> {
    forecast: F,
    repository: R,
    cross_border: C,
}

impl<F, R, C> BacktestConsumptionForecast<F, R, C>
where
    F: ForecastModel,
    R: IntensityRepository,
    C: CrossBorderRepository,
{
    pub fn new(forecast: F, repository: R, cross_border: C) -> Self {
        Self {
            forecast,
            repository,
            cross_border,
        }
    }

    /// Série `@2` **observée** (dérivée) sur `range`, triée par horodatage.
    async fn observed_truth(
        &self,
        region: Region,
        range: TimeRange,
    ) -> Result<Vec<Measurement>, ApplicationError> {
        let mix = self.repository.range(region, "acv-ademe", range).await?;
        let flows = self.cross_border.flows_range(range).await?;
        Ok(derive_consumption_series(
            &mix,
            &flows,
            &EmissionFactors::acv_ademe_v1(),
            TD_LOSS_FACTOR_V1,
        ))
    }

    /// Évalue la prévision `@2` sur `[test.start, test.end)` (mêmes paramètres que
    /// [`BacktestForecast::execute`]).
    pub async fn execute(
        &self,
        region: Region,
        test: TimeRange,
        origin_step: Duration,
        step: Duration,
        checkpoints: &[Duration],
    ) -> Result<BacktestReport, ApplicationError> {
        let max_checkpoint = checkpoints
            .iter()
            .copied()
            .max()
            .unwrap_or_else(|| Duration::hours(24));
        let horizon = max_checkpoint + step;

        // Vérité `@2` dérivée une fois, sur toute la fenêtre (+ marge ancre/horizon).
        let truth_window = TimeRange::new(test.start() - Duration::days(1), test.end() + horizon)
            .ok_or(ApplicationError::InsufficientSeries)?;
        let truth_series = self.observed_truth(region, truth_window).await?;
        let truth: HashMap<OffsetDateTime, f64> = truth_series
            .iter()
            .map(|m| (m.at, m.intensity.value()))
            .collect();

        let mut model = ErrorAccumulator::default();
        let mut persistence = ErrorAccumulator::default();
        let mut h_model = vec![ErrorAccumulator::default(); checkpoints.len()];
        let mut h_persistence = vec![ErrorAccumulator::default(); checkpoints.len()];
        let mut origins = 0usize;
        let step_secs = step.whole_seconds();

        let mut cursor = test.start();
        while cursor < test.end() {
            let origin = align_down(cursor, step_secs);
            let predicted = match self
                .forecast
                .forecast(region, "acv-ademe", origin, horizon)
                .await
            {
                Ok(points) => points,
                Err(ForecastError::NotEnoughData) => {
                    cursor += origin_step;
                    continue;
                }
                Err(other) => return Err(other.into()),
            };

            if !predicted.is_empty() {
                origins += 1;
                // Ancre de persistance : dernière vérité `@2` avant l'origine.
                let anchor = truth_series
                    .iter()
                    .filter(|m| m.at < origin)
                    .max_by_key(|m| m.at)
                    .map(|m| m.intensity.value());

                for point in &predicted {
                    let Some(&t) = truth.get(&point.at) else {
                        continue;
                    };
                    let forecast_value = point.expected.value();
                    model.observe(forecast_value, t);
                    if let Some(anchor) = anchor {
                        persistence.observe(anchor, t);
                    }
                    let offset = point.at - origin;
                    for (index, &checkpoint) in checkpoints.iter().enumerate() {
                        if offset == checkpoint {
                            h_model[index].observe(forecast_value, t);
                            if let Some(anchor) = anchor {
                                h_persistence[index].observe(anchor, t);
                            }
                        }
                    }
                }
            }

            cursor += origin_step;
        }

        let by_horizon = checkpoints
            .iter()
            .enumerate()
            .map(|(index, &horizon)| HorizonError {
                horizon,
                model: h_model[index].metrics(),
                persistence: h_persistence[index].metrics(),
            })
            .collect();

        Ok(BacktestReport {
            origins,
            model: model.metrics(),
            persistence: persistence.metrics(),
            by_horizon,
        })
    }

    /// Calibre les bandes d'incertitude `@2` par horizon (résidus vérité − prévu).
    pub async fn calibrate_bands(
        &self,
        region: Region,
        test: TimeRange,
        origin_step: Duration,
        step: Duration,
        horizon: Duration,
        q: f64,
    ) -> Result<HorizonBands, ApplicationError> {
        let step_secs = step.whole_seconds();
        if step_secs <= 0 || horizon <= Duration::ZERO {
            return Ok(HorizonBands::from_residuals(step, &[], q));
        }
        let truth_window = TimeRange::new(test.start(), test.end() + horizon)
            .ok_or(ApplicationError::InsufficientSeries)?;
        let truth: HashMap<OffsetDateTime, f64> = self
            .observed_truth(region, truth_window)
            .await?
            .iter()
            .map(|m| (m.at, m.intensity.value()))
            .collect();

        let mut residuals: Vec<Vec<f64>> = Vec::new();
        let mut cursor = test.start();
        while cursor < test.end() {
            let origin = align_down(cursor, step_secs);
            let predicted = match self
                .forecast
                .forecast(region, "acv-ademe", origin, horizon)
                .await
            {
                Ok(points) => points,
                Err(ForecastError::NotEnoughData) => {
                    cursor += origin_step;
                    continue;
                }
                Err(other) => return Err(other.into()),
            };
            for point in &predicted {
                if let Some(&t) = truth.get(&point.at) {
                    let idx = ((point.at - origin).whole_seconds() / step_secs).max(0) as usize;
                    if residuals.len() <= idx {
                        residuals.resize(idx + 1, Vec::new());
                    }
                    residuals[idx].push(t - point.expected.value());
                }
            }
            cursor += origin_step;
        }
        Ok(HorizonBands::from_residuals(step, &residuals, q))
    }
}

/// Aligne un instant **vers le bas** sur la grille du pas (multiples de
/// `step_secs` depuis l'époque UNIX), nanosecondes remises à zéro. Aligne les
/// origines sur la grille du quart d'heure éCO2mix.
fn align_down(at: OffsetDateTime, step_secs: i64) -> OffsetDateTime {
    if step_secs <= 0 {
        return at;
    }
    let secs = at.unix_timestamp();
    let aligned = secs - secs.rem_euclid(step_secs);
    OffsetDateTime::from_unix_timestamp(aligned).unwrap_or(at)
}