rlevo-core 0.2.0

Core traits and types for rlevo (internal crate — use `rlevo` for the full 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

//! Shared utilities used across `rlevo-core` consumers.
//!
//! Currently houses small helpers ([`combinations`]) and the
//! [`seed`] module's deterministic seed-derivation primitives
//! (see [`seed::SeedStream`]).
//!
//! [`combinations`]: crate::util::combinations
//! [`seed`]: crate::util::seed
//! [`seed::SeedStream`]: crate::util::seed::SeedStream

pub mod seed;

/// Returns the binomial coefficient `n choose k` (number of combinations of
/// `n` items taken `k` at a time).
///
/// Returns `0` when `k > n`.
///
/// # Examples
///
/// ```
/// use rlevo_core::util::combinations;
/// assert_eq!(combinations(54, 6), 25_827_165);
/// assert_eq!(combinations(5, 0), 1);
/// assert_eq!(combinations(3, 5), 0);
/// ```
pub fn combinations(n: u64, k: u64) -> u64 {
    if k > n {
        return 0;
    }
    let mut result = 1u64;
    for i in 1..=k {
        result = result * (n - i + 1) / i;
    }
    result
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_combinations_known_values() {
        assert_eq!(combinations(0, 0), 1);
        assert_eq!(combinations(5, 0), 1);
        assert_eq!(combinations(5, 5), 1);
        assert_eq!(combinations(5, 2), 10);
        assert_eq!(combinations(54, 6), 25_827_165);
    }

    #[test]
    fn test_combinations_k_greater_than_n_returns_zero() {
        assert_eq!(combinations(3, 5), 0);
    }
}