permutation-generator 0.1.3

A direct permutation generator
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

use bit_index::BitIndex16;

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct SinglePermutation16 {
    elems:       BitIndex16,
    next_mod:    u64,
    current_idx: u64,
}

impl SinglePermutation16 {
    #[must_use]
    pub fn new(nb_elems: u8, nb_perms: u64, idx: u64) -> Option<Self> {
        if idx >= nb_perms {
            None
        } else {
            Some(Self {
                elems:       BitIndex16::new(nb_elems).unwrap(),
                next_mod:    nb_perms / u64::from(nb_elems),
                current_idx: idx,
            })
        }
    }

    #[inline]
    #[must_use]
    pub fn nb_remaining(&self) -> usize { self.elems.nb_elements() as usize }
}

impl Iterator for SinglePermutation16 {
    type Item = u8;

    #[allow(clippy::cast_possible_truncation)]
    fn next(&mut self) -> Option<Self::Item> {
        if self.elems.nb_elements() == 0 {
            return None;
        }
        let bit_nb = self.current_idx / self.next_mod;
        self.current_idx -= bit_nb * self.next_mod;
        self.next_mod /= u64::from(self.elems.nb_elements()).saturating_sub(2) + 1;
        self.elems.pop(bit_nb as u8)
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        let nb_remaining = self.nb_remaining();
        (nb_remaining, Some(nb_remaining))
    }

    fn count(self) -> usize { self.nb_remaining() }
}

#[cfg(test)]
mod tests {
    use crate::{SinglePermutation16, factorial::factorial64};

    fn single_perm(nb_elems: u8, idx: u64) -> Option<SinglePermutation16> {
        SinglePermutation16::new(nb_elems, factorial64(nb_elems), idx)
    }

    #[test]
    fn new() {
        assert_eq!(None, single_perm(10, 3_628_800));
    }

    #[test]
    fn new_unchecked_iterator() {
        assert_eq!(
            &[0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
            single_perm(10, 0).unwrap().collect::<Vec<_>>().as_slice()
        );

        assert_eq!(
            &[1, 0, 2, 3, 4, 5, 6, 7, 8, 9],
            single_perm(10, 362_880).unwrap().collect::<Vec<_>>().as_slice()
        );

        assert_eq!(
            &[2, 0, 1, 3, 4, 5, 6, 7, 8, 9],
            single_perm(10, 362_880 * 2).unwrap().collect::<Vec<_>>().as_slice()
        );

        assert_eq!(
            &[3, 0, 1, 2, 4, 5, 6, 7, 8, 9],
            single_perm(10, 362_880 * 3).unwrap().collect::<Vec<_>>().as_slice()
        );

        assert_eq!(
            &[9, 8, 7, 6, 5, 4, 3, 2, 1, 0],
            single_perm(10, 3_628_800 - 1).unwrap().collect::<Vec<_>>().as_slice()
        );
    }
}