bva 0.4.1

bva is a rust crate for manipulating and doing arithmetics on bit vectors of fixed but arbitrary size.
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

use std::ops::Range;

use crate::{Bit, BitVector};

/// An iterator over the bits of a [`BitVector`].
pub struct BitIterator<'a, B: BitVector> {
    bv: &'a B,
    range: Range<usize>,
}

impl<'a, B: BitVector> BitIterator<'a, B> {
    pub(crate) fn new(bv: &'a B) -> Self {
        Self {
            bv,
            range: 0..bv.len(),
        }
    }
}

impl<B: BitVector> Iterator for BitIterator<'_, B> {
    type Item = Bit;

    fn next(&mut self) -> Option<Self::Item> {
        if self.range.start < self.range.end {
            let bit = self.bv.get(self.range.start);
            self.range.start += 1;
            Some(bit)
        } else {
            None
        }
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        let remaining = self.range.end - self.range.start;
        (remaining, Some(remaining))
    }

    fn count(self) -> usize {
        self.range.end - self.range.start
    }

    fn last(self) -> Option<Self::Item> {
        if self.range.start < self.range.end {
            Some(self.bv.get(self.range.end - 1))
        } else {
            None
        }
    }

    fn nth(&mut self, n: usize) -> Option<Self::Item> {
        if self.range.start + n < self.range.end {
            let bit = self.bv.get(self.range.start + n);
            self.range.start += n + 1;
            Some(bit)
        } else {
            self.range.start = self.range.end;
            None
        }
    }
}

impl<B: BitVector> DoubleEndedIterator for BitIterator<'_, B> {
    fn next_back(&mut self) -> Option<Self::Item> {
        if self.range.start < self.range.end {
            self.range.end -= 1;
            Some(self.bv.get(self.range.end))
        } else {
            None
        }
    }

    fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
        if self.range.start + n < self.range.end {
            self.range.end -= n + 1;
            Some(self.bv.get(self.range.end))
        } else {
            self.range.end = self.range.start;
            None
        }
    }
}