routers 0.2.3

Rust-Based Routing Tooling for System-Agnostic Maps.
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

use core::ops::Add;
use pathfinding::num_traits::Zero;
use routers_network::edge::Weight;

/// A fractional value, broken into a stored numerator and denominator.
/// It supports the [`Add`] trait wherein the combination of numerator
/// and denominator is supported.
///
/// The fractional value can be derived by the [`Fraction::value`] function.
#[derive(Copy, Clone, Hash, Debug)]
pub struct Fraction {
    pub numerator: Weight,
    pub denominator: u32,
}

impl Fraction {
    /// Returns the fractional value (num / denom) of the cumulative fraction.
    pub(crate) const fn value(&self) -> Weight {
        if self.denominator == 0 {
            return 0;
        }

        self.numerator / self.denominator
    }

    #[inline]
    pub(crate) const fn mul(numerator: Weight) -> Self {
        Fraction {
            numerator,
            denominator: 1,
        }
    }
}

impl Zero for Fraction {
    fn zero() -> Self {
        Fraction {
            numerator: 0,
            denominator: 0,
        }
    }

    fn is_zero(&self) -> bool {
        self.value() == 0
    }
}

impl Add<Fraction> for Fraction {
    type Output = Fraction;

    fn add(self, rhs: Fraction) -> Self::Output {
        Fraction {
            numerator: self.numerator + rhs.numerator,
            denominator: self.denominator + rhs.denominator,
        }
    }
}