esox 0.1.4

Library for NISECI and HFBI calc
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

use crate::domain::hfbi::{
    AnagraficaHFBI, CampionamentoHFBI, CondizioniRiferimentoHFBI, StatoEcologicoHFBI,
    ValoriIntermediHFBI,
};
use crate::engines::hfbi::{
    bbent::calc_bbent, bn::calc_bn, dbent::calc_dbent, ddom::calc_ddom, dhzp::calc_dhzp,
    dmig::calc_dmig,
};

// WEIGHTS
const W_DDOM: f32 = 1.0;
const W_BN: f32 = 0.7;
const W_DMIG: f32 = 0.05;
const W_BBENT: f32 = 0.82;
const W_DBENT: f32 = 0.37;
const W_DHZP: f32 = 0.84;

// MAGIC CONST
const HFBI_T: f32 = -0.167;
const HFBI_S: f32 = 0.150;

/// This calculation is order-dependent due to calc_ddom() being order-dependent.
/// Proper ordering of `campionamento` is by descending `peso` (RecordHFBI.peso).
pub fn calculate_mmi(
    campionamento: &CampionamentoHFBI,
    anagrafica: &AnagraficaHFBI,
) -> Result<ValoriIntermediHFBI, String> {
    let condizioni_riferimento = match CondizioniRiferimentoHFBI::get_cond_riferimento(anagrafica) {
        Some(cond) => cond,
        None => return Err(String::from("Errore condizioni di riferimento non trovate")),
    };

    let bbent: f32 = calc_bbent(campionamento, anagrafica)?;
    let bn: f32 = calc_bn(campionamento);
    let dbent: f32 = calc_dbent(campionamento, anagrafica)?;
    let ddom: f32 = calc_ddom(campionamento, anagrafica)?;
    let dhzp: f32 = calc_dhzp(campionamento, anagrafica)?;
    let dmig: f32 = calc_dmig(campionamento, anagrafica)?;
    let rqe_bbent = bbent / condizioni_riferimento.bbent;
    let rqe_bn = bn / condizioni_riferimento.bn;
    let rqe_dbent = dbent / condizioni_riferimento.dbent;
    let rqe_ddom = ddom / condizioni_riferimento.ddom;
    let rqe_dhzp = dhzp / condizioni_riferimento.dhzp;
    let rqe_dmig = dmig / condizioni_riferimento.dmig;
    let weighted_rqe_bbent = W_BBENT * rqe_bbent;
    let weighted_rqe_bn = W_BN * rqe_bn;
    let weighted_rqe_dbent = W_DBENT * rqe_dbent;
    let weighted_rqe_ddom = W_DDOM * rqe_ddom;
    let weighted_rqe_dhzp = W_DHZP * rqe_dhzp;
    let weighted_rqe_dmig = W_DMIG * rqe_dmig;

    let weighted_rqe_sum = weighted_rqe_ddom
        + weighted_rqe_bn
        + weighted_rqe_dmig
        + weighted_rqe_bbent
        + weighted_rqe_dbent
        + weighted_rqe_dhzp;
    let weight_sum = W_DDOM + W_BN + W_DMIG + W_BBENT + W_DBENT + W_DHZP;

    let mmi = weighted_rqe_sum / weight_sum;
    let rounded_mmi = (1000.0 * mmi).round() / 1000.0;

    let intermediates = ValoriIntermediHFBI {
        bbent,
        bn,
        dbent,
        ddom,
        dhzp,
        dmig,
        mmi: rounded_mmi,
    };
    Ok(intermediates)
}

/// This calculation is order-dependent due to:
/// - calc_mmi() being order-dependent
///   - Due to calc_ddom() being order-dependent
///
/// Proper ordering of `campionamento` is by descending `peso` (RecordHFBI.peso).
pub fn calculate_hfbi(
    campionamento: &CampionamentoHFBI,
    anagrafica: &AnagraficaHFBI,
) -> Result<(f32, ValoriIntermediHFBI), String> {
    match calculate_mmi(campionamento, anagrafica) {
        Ok(intermediates) => {
            let hfbi = (intermediates.mmi + HFBI_T) / HFBI_S;
            let rounded_hfbi = (1000.0 * hfbi).round() / 1000.0;
            Ok((rounded_hfbi, intermediates))
        }
        Err(error) => Err(error),
    }
}

pub fn calculate_stato_ecologico_hfbi(hfbi: Option<f32>) -> Option<StatoEcologicoHFBI> {
    hfbi.map(StatoEcologicoHFBI::from)
}

#[cfg(test)]
mod full_hfbi_private_tests {
    // We use the structs from the domain, but NOT the functions from the parent module.
    // By defining our own mock functions with the same names, they will be used instead.
    use crate::domain::hfbi::{
        AnagraficaHFBI, CampionamentoHFBI, GruppoEcoHFBI, GruppoTrofHFBI, HabitatHFBI, RecordHFBI,
        SpecieHFBI, StagioneHFBI, TipoLagunaCostieraHFBI,
    };

    const EPSILON: f32 = 1e-6;

    fn create_specie_record(
        codice_specie: &'static str,
        gruppo_eco: GruppoEcoHFBI,
        peso: f32,
    ) -> RecordHFBI {
        RecordHFBI {
            specie: SpecieHFBI {
                nome_comune: "Test Specie".to_string(),
                codice_specie: codice_specie.to_string(),
                autoctono: true,
                gruppo_eco,
                gruppo_trofico: GruppoTrofHFBI {
                    microbentivori: 0.0,
                    macrobentivori: 0.0,
                    iperbentivori: 0.0,
                    erbivori: 0.0,
                    detritivori: 0.0,
                    planctivori: 0.0,
                    onnivori: 0.0,
                },
            },
            numero_individui: 1,
            peso,
        }
    }

    // Bring in the functions we actually want to test from the parent module.
    use super::{calculate_hfbi, calculate_mmi};
    use crate::domain::location::Location; // Assuming path is correct

    // Test helper to create a minimal Anagrafica struct.
    fn create_test_anagrafica(codice_stazione: &str) -> AnagraficaHFBI {
        AnagraficaHFBI::new_raw_unchecked(
            codice_stazione.to_string(),
            "TestCorpoIdrico".to_string(),
            Location {
                regione: "Test".to_string(),
                provincia: "Test".to_string(),
            },
            "01/01/2025".to_string(),
            TipoLagunaCostieraHFBI::MAt1,
            StagioneHFBI::Primavera,
            HabitatHFBI::NonVegetato,
            100.0,
            100.0,
        )
    }

    // ===================================================================
    // ===== 2. Tests
    // ===================================================================

    #[test]
    fn test_mmi_order_invariant() {
        let anagrafica = create_test_anagrafica("OK_STATION_INTEGRATION");
        let campione = CampionamentoHFBI::new_raw_unsorted(vec![
            // Species 2: Migratory, contributes to most metrics
            create_specie_record("SP2", GruppoEcoHFBI::MigratoriMarini, 1.0),
            // Species 3: Resident, not dominant
            create_specie_record("SP3", GruppoEcoHFBI::ResidentiDiEstuario, 1.0),
            // Species 1: Migratory, dominant, contributes to all metrics
            create_specie_record("SP1", GruppoEcoHFBI::Diadromi, 900.0),
        ]);
        let sorted = CampionamentoHFBI::new_raw_unsorted(vec![
            // Species 1: Migratory, dominant, contributes to all metrics
            create_specie_record("SP1", GruppoEcoHFBI::Diadromi, 900.0),
            // Species 2: Migratory, contributes to most metrics
            create_specie_record("SP2", GruppoEcoHFBI::MigratoriMarini, 1.0),
            // Species 3: Resident, not dominant
            create_specie_record("SP3", GruppoEcoHFBI::ResidentiDiEstuario, 1.0),
        ]);
        let mmi = calculate_mmi(&campione, &anagrafica).expect("Failed mmi calc");
        let mmi_sorted = calculate_mmi(&sorted, &anagrafica).expect("Failed mmi_sorted calc");
        assert!((mmi.mmi - mmi_sorted.mmi).abs() < EPSILON);
    }

    #[test]
    fn test_hfbi_order_invariant() {
        let anagrafica = create_test_anagrafica("OK_STATION_INTEGRATION");
        let campione = CampionamentoHFBI::new_raw_unsorted(vec![
            // Species 2: Migratory, contributes to most metrics
            create_specie_record("SP2", GruppoEcoHFBI::MigratoriMarini, 1.0),
            // Species 3: Resident, not dominant
            create_specie_record("SP3", GruppoEcoHFBI::ResidentiDiEstuario, 1.0),
            // Species 1: Migratory, dominant, contributes to all metrics
            create_specie_record("SP1", GruppoEcoHFBI::Diadromi, 900.0),
        ]);
        let sorted = CampionamentoHFBI::new_raw_unsorted(vec![
            // Species 1: Migratory, dominant, contributes to all metrics
            create_specie_record("SP1", GruppoEcoHFBI::Diadromi, 900.0),
            // Species 2: Migratory, contributes to most metrics
            create_specie_record("SP2", GruppoEcoHFBI::MigratoriMarini, 1.0),
            // Species 3: Resident, not dominant
            create_specie_record("SP3", GruppoEcoHFBI::ResidentiDiEstuario, 1.0),
        ]);
        let (hfbi, _intermediates) =
            calculate_hfbi(&campione, &anagrafica).expect("Failed mmi calc");
        let (hfbi_sorted, _intermediates_sorted) =
            calculate_hfbi(&sorted, &anagrafica).expect("Failed mmi_sorted calc");
        assert!((hfbi - hfbi_sorted).abs() < EPSILON);
    }

    #[test]
    fn test_mmi_and_hfbi() {
        let anagrafica = create_test_anagrafica("OK_STATION_INTEGRATION");
        // We will create a non-empty campione with specific data.
        let campione = CampionamentoHFBI::new(vec![
            // Species 1: Migratory, dominant, contributes to all metrics
            create_specie_record("SP1", GruppoEcoHFBI::Diadromi, 500.0),
            // Species 2: Migratory, contributes to most metrics
            create_specie_record("SP2", GruppoEcoHFBI::MigratoriMarini, 200.0),
            // Species 3: Resident, not dominant
            create_specie_record("SP3", GruppoEcoHFBI::ResidentiDiEstuario, 100.0),
        ]);

        // We can't know the exact intermediate values without re-implementing all the
        // functions here. But we can ensure the logic flows and produces a valid, finite number.
        let mmi_result = calculate_mmi(&campione, &anagrafica);
        assert!(
            mmi_result.is_ok(),
            "calculate_mmi should succeed with non-empty data"
        );

        let intermediates = mmi_result.unwrap();

        let tested: f32 = 0.552; // ho testato a mano il risultato

        assert!(
            intermediates.mmi.is_finite(),
            "MMI should be a finite number, but was {}",
            intermediates.mmi
        );
        assert!(intermediates.bbent.is_finite(), "bbent should be finite");
        assert!(intermediates.bn.is_finite(), "bn should be finite");
        assert!(intermediates.ddom.is_finite(), "ddom should be finite");
        assert!((intermediates.mmi - tested).abs() < EPSILON);

        // Now, we test the final step with the calculated MMI
        let hfbi_result = calculate_hfbi(&campione, &anagrafica);
        assert!(hfbi_result.is_ok(), "calculate_hfbi should also succeed");

        let (hfbi, _) = hfbi_result.unwrap();
        assert!(
            hfbi.is_finite(),
            "HFBI should be a finite number, but was {}",
            hfbi
        );
    }
}