electosim 0.3.0

Library to compute electoral methods (as D'Hondt) and simulate elections
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

//! # Utils

use crate::interface::{WithSeats, WithVotes};

/// Clears the seats won by the candidates.
///
/// # Arguments
///
/// * `results` - A mutable reference to a vector of candidates.
///
/// # Example
///
/// ```rust
/// use electosim::utils::clear_results;
/// use electosim::interface::WithSeats;
/// use electosim::models::Candidacy;
///
/// fn main() {
///    let mut candidacies = vec![
///       Candidacy::new(2010, 9),
///       Candidacy::new(1018, 4),
///       Candidacy::new(86, 0),
///       Candidacy::new(77, 0),
///    ];
///
///   clear_results(&mut candidacies);
///
///   assert_eq!(candidacies[0].get_seats(), 0);
///   assert_eq!(candidacies[1].get_seats(), 0);
///   assert_eq!(candidacies[2].get_seats(), 0);
///   assert_eq!(candidacies[3].get_seats(), 0);
/// }
/// ```
pub fn clear_results<T>(results: &mut Vec<T>)
where
    T: WithSeats,
{
    results.iter_mut().for_each(|r| r.set_seats(0));
}

/// Computes the total number of votes.
///
/// # Arguments
///
/// * `results` - A reference to a vector of candidates.
///
/// # Example
///
/// ```rust
/// use electosim::utils::compute_total_votes;
/// use electosim::models::Candidacy;
///
/// fn main() {
///     let candidacies = vec![Candidacy::new(2010, 9), Candidacy::new(1018, 4)];
///     let total_votes = compute_total_votes(&candidacies);
///     println!("Total votes: {}", total_votes);
/// }
/// ```
pub fn compute_total_votes<T>(results: &Vec<T>) -> u32
where
    T: WithVotes,
{
    results.iter().map(|x| x.get_votes()).sum()
}

/// Computes the total number of seats.
///
/// # Arguments
///
/// * `results` - A reference to a vector of candidates.
///
/// # Example
///
/// ```rust
/// use electosim::utils::compute_total_seats;
/// use electosim::models::Candidacy;
///
/// fn main() {
///     let candidacies = vec![Candidacy::new(2010, 9), Candidacy::new(1018, 4)];
///     let total_seats = compute_total_seats(&candidacies);
///     println!("Total seats: {}", total_seats);
/// }
/// ```
#[allow(dead_code)]
pub fn compute_total_seats<T>(results: &Vec<T>) -> u16
where
    T: WithSeats,
{
    results.iter().map(|x| x.get_seats()).sum()
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn listing_candidacy() {
        let candidacies = vec![
            crate::models::Candidacy::new(2010, 9),
            crate::models::Candidacy::new(1018, 4),
            crate::models::Candidacy::new(86, 0),
            crate::models::Candidacy::new(77, 0),
        ];

        assert_eq!(compute_total_votes(&candidacies), 3191);
        assert_eq!(compute_total_seats(&candidacies), 13);
    }

    #[test]
    fn clearing_results() {
        let mut candidacies = vec![
            crate::models::Candidacy::new(2010, 9),
            crate::models::Candidacy::new(1018, 4),
            crate::models::Candidacy::new(86, 0),
            crate::models::Candidacy::new(77, 0),
        ];

        clear_results(&mut candidacies);

        assert_eq!(candidacies[0].get_seats(), 0);
        assert_eq!(candidacies[1].get_seats(), 0);
        assert_eq!(candidacies[2].get_seats(), 0);
        assert_eq!(candidacies[3].get_seats(), 0);
    }
}