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

// ---------------------------------------------------------------------------
// Copyright:   (c) 2022 ff. Michael Amrhein (michael@adrhinum.de)
// License:     This program is part of a larger application. For license
//              details please read the file LICENSE.TXT provided together
//              with the application.
// ---------------------------------------------------------------------------
// $Source: src/frequency.rs $
// $Revision: 2022-04-16T08:18:48+02:00 $

//! Definition of derived quantity `Frequency`.

use crate::{duration::Duration, prelude::*};

#[quantity(AmountT / Duration)]
#[ref_unit(Hertz, "Hz", NONE, "Reference unit of quantity `Frequency`")]
#[unit(Kilohertz, "kHz", KILO, 1000, "1000·Hz")]
#[unit(Megahertz, "MHz", MEGA, 1000000, "1000000·Hz")]
#[unit(Gigahertz, "GHz", GIGA, 1000000000, "1000000000·Hz")]
/// Number of occurrences of a repeating event per unit of time
///
/// Definition: 1/Duration
///
/// Reference unit: Hertz ('Hz' = '1/s')
///
/// Predefined units:
///
/// | Symbol | Name                  | Definition        | Equivalent in 'Hz'  |
/// |--------|-----------------------|-------------------|---------------------|
/// | kHz    | Kilohertz             | 1000·Hz           | 1000                |
/// | MHz    | Megahertz             | 1000000·Hz        | 1000000             |
/// | GHz    | Gigahertz             | 1000000000·Hz     | 1000000000          |
pub struct Frequency {}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{assert_almost_eq, duration::MILLISECOND};

    #[test]
    fn test_amount_div_duration() {
        let a: AmountT = Amnt!(9030.);
        let at: AmountT = Amnt!(2.5);
        let t = at * MILLISECOND;
        let f = a / t;
        assert_almost_eq!(f.amount(), a / at);
        assert_eq!(f.unit(), KILOHERTZ);
    }
}