sim-lib-discrete-comb 0.2.0

Discrete combinatorics.
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

//! Browse/help card content for the combinatorics family, as static data.

/// A browse/help card descriptor for the combinatorics family.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct CardSpec {
    /// Stable card key.
    pub key: &'static str,
    /// One-line summary.
    pub summary: &'static str,
    /// Operation names exposed by this family.
    pub operations: &'static [&'static str],
    /// Data forms / value types this family deals in.
    pub data_forms: &'static [&'static str],
    /// Known limits and capability needs.
    pub limits: &'static str,
}

/// The combinatorics family cards.
pub fn combinatorics_cards() -> &'static [CardSpec] {
    const CARDS: &[CardSpec] = &[CardSpec {
        key: "discrete/combinatorics",
        summary: "Exact counts, lazy enumerators, and canonical ordinals.",
        operations: &[
            "factorial",
            "binomial",
            "stirling2",
            "bell-number",
            "integer-partition-count",
            "subsets",
            "combinations",
            "permutations",
            "words",
            "integer-partitions",
            "canonical-cycles",
            "longest-only",
            "rank-unrank",
        ],
        data_forms: &[
            "word",
            "bit-vector",
            "subset",
            "combination",
            "permutation",
            "cycle",
            "partition",
        ],
        limits: "Counts are exact BigUint. Bitmask iterators cap cardinality at \
                 127; explosive enumerations require explicit bounds from the \
                 caller via take/limit.",
    }];
    CARDS
}

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

    #[test]
    fn card_present() {
        assert_eq!(combinatorics_cards()[0].key, "discrete/combinatorics");
    }
}