frequenz-microgrid 0.2.2

A high-level interface to the Frequenz Microgrid API.
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

// License: MIT
// Copyright © 2025 Frequenz Energy-as-a-Service GmbH

//! This module defines the `Percentage` quantity and its operations.

qty_ctor! {
    #[doc = "A quantity representing a percentage (typically 0% to 100%)."]
    Percentage => {
        (from_percentage, as_percentage, "%", 1.0),
        (from_fraction, as_fraction, None, 100.0),
    }
}

#[cfg(test)]
mod tests {
    use super::Percentage;
    use crate::quantity::{Quantity as _, test_utils::assert_f32_eq};

    #[test]
    fn test_percentage() {
        let perc_1 = Percentage::from_percentage(50.0);

        assert_f32_eq(perc_1.as_percentage(), 50.0);
        assert_f32_eq(perc_1.as_fraction(), 0.5);

        let perc_2 = Percentage::from_fraction(0.8);
        assert_f32_eq(perc_2.as_percentage(), 80.0);
        assert_f32_eq(perc_2.as_fraction(), 0.8);

        assert!(perc_1 < perc_2);
        assert!(perc_2 > perc_1);

        assert_f32_eq((perc_1 + perc_2).as_percentage(), 130.0);
        assert_f32_eq((perc_2 - perc_1).as_percentage(), 30.0);
        assert_f32_eq((perc_1 * 2.0).as_percentage(), 100.0);
        assert_f32_eq((perc_2 / 2.0).as_percentage(), 40.0);
        assert_f32_eq((perc_1 * perc_2).as_percentage(), 40.0);
        assert_f32_eq(perc_2 / perc_1, 1.6);

        assert_f32_eq(Percentage::zero().as_percentage(), 0.0);

        let perc_3 = Percentage::from_percentage(150.0);
        assert_f32_eq(perc_3.as_fraction(), 1.5);
        let perc_4 = Percentage::from_fraction(-0.1);
        assert_f32_eq(perc_4.as_percentage(), -10.0);

        assert!(perc_3 > Percentage::from_percentage(100.0));
        assert!(perc_4 < Percentage::from_percentage(0.0));
        assert!(perc_4 > Percentage::from_percentage(-20.0));
    }

    #[test]
    fn test_percentage_formatting() {
        let s = |value| Percentage::from_percentage(value).to_string();
        let p = |value, prec| format!("{:.prec$}", Percentage::from_percentage(value), prec = prec);
        assert_eq!(s(0.0), "0 %");
        assert_eq!(s(12.3456), "12.346 %");
        assert_eq!(p(12.3456, 2), "12.35 %");
        assert_eq!(p(12.3456, 4), "12.3456 %");
        assert_eq!(p(12.3456, 5), "12.3456 %");
        assert_eq!(s(100.0), "100 %");
        assert_eq!(s(-5.5), "-5.5 %");
        assert_eq!(s(1234.5678), "1234.568 %");
        assert_eq!(p(-1234.5678, 1), "-1234.6 %");
    }
}