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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
use alloc::collections::btree_map;
use core::{
    iter::FusedIterator,
    ops::{self, RangeInclusive},
};

use itertools::Itertools;

use crate::{
    BitAndMerge, BitOrMerge, BitSubMerge, BitXOr, BitXOrTee, Integer, NotIter, SortedDisjoint,
    SortedStarts,
};

/// An iterator that visits the ranges in the [`RangeSetBlaze`],
/// i.e., the integers as sorted & disjoint ranges.
///
/// This `struct` is created by the [`ranges`] method on [`RangeSetBlaze`]. See [`ranges`]'s
/// documentation for more.
///
/// [`RangeSetBlaze`]: crate::RangeSetBlaze
/// [`ranges`]: crate::RangeSetBlaze::ranges
#[derive(Clone, Debug)]
#[must_use = "iterators are lazy and do nothing unless consumed"]
pub struct RangesIter<'a, T: Integer> {
    pub(crate) iter: btree_map::Iter<'a, T, T>,
}

impl<'a, T: Integer> AsRef<RangesIter<'a, T>> for RangesIter<'a, T> {
    fn as_ref(&self) -> &Self {
        // Self is RangesIter<'a>, the type for which we impl AsRef
        self
    }
}

// RangesIter (one of the iterators from RangeSetBlaze) is SortedDisjoint
impl<T: Integer> SortedStarts<T> for RangesIter<'_, T> {}
impl<T: Integer> SortedDisjoint<T> for RangesIter<'_, T> {}

impl<T: Integer> ExactSizeIterator for RangesIter<'_, T> {
    #[must_use]
    fn len(&self) -> usize {
        self.iter.len()
    }
}

impl<'a, T: Integer> FusedIterator for RangesIter<'a, T> {}

// Range's iterator is just the inside BTreeMap iterator as values
impl<'a, T: Integer> Iterator for RangesIter<'a, T> {
    type Item = RangeInclusive<T>;

    fn next(&mut self) -> Option<Self::Item> {
        self.iter.next().map(|(start, end)| *start..=*end)
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        self.iter.size_hint()
    }
}

impl<T: Integer> DoubleEndedIterator for RangesIter<'_, T> {
    fn next_back(&mut self) -> Option<Self::Item> {
        self.iter.next_back()
            .map(|(start, end)| *start..=*end)
    }
}

#[must_use = "iterators are lazy and do nothing unless consumed"]
/// An iterator that moves out the ranges in the [`RangeSetBlaze`],
/// i.e., the integers as sorted & disjoint ranges.
///
/// This `struct` is created by the [`into_ranges`] method on [`RangeSetBlaze`]. See [`into_ranges`]'s
/// documentation for more.
///
/// [`RangeSetBlaze`]: crate::RangeSetBlaze
/// [`into_ranges`]: crate::RangeSetBlaze::into_ranges
#[derive(Debug)]
pub struct IntoRangesIter<T: Integer> {
    pub(crate) iter: alloc::collections::btree_map::IntoIter<T, T>,
}

impl<T: Integer> SortedStarts<T> for IntoRangesIter<T> {}
impl<T: Integer> SortedDisjoint<T> for IntoRangesIter<T> {}

impl<T: Integer> ExactSizeIterator for IntoRangesIter<T> {
    #[must_use]
    fn len(&self) -> usize {
        self.iter.len()
    }
}

impl<T: Integer> FusedIterator for IntoRangesIter<T> {}

// Range's iterator is just the inside BTreeMap iterator as values
impl<T: Integer> Iterator for IntoRangesIter<T> {
    type Item = RangeInclusive<T>;

    fn next(&mut self) -> Option<Self::Item> {
        self.iter.next().map(|(start, end)| start..=end)
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        self.iter.size_hint()
    }
}

impl<T: Integer> DoubleEndedIterator for IntoRangesIter<T> {
    fn next_back(&mut self) -> Option<Self::Item> {
        self.iter.next_back()
            .map(|(start, end)| start..=end)
    }
}


impl<T: Integer> ops::Not for RangesIter<'_, T> {
    type Output = NotIter<T, Self>;

    fn not(self) -> Self::Output {
        self.complement()
    }
}

impl<T: Integer> ops::Not for IntoRangesIter<T> {
    type Output = NotIter<T, Self>;

    fn not(self) -> Self::Output {
        self.complement()
    }
}

impl<T: Integer, I> ops::BitOr<I> for RangesIter<'_, T>
where
    I: SortedDisjoint<T>,
{
    type Output = BitOrMerge<T, Self, I>;

    fn bitor(self, other: I) -> Self::Output {
        SortedDisjoint::union(self, other)
    }
}

impl<T: Integer, I> ops::BitOr<I> for IntoRangesIter<T>
where
    I: SortedDisjoint<T>,
{
    type Output = BitOrMerge<T, Self, I>;

    fn bitor(self, other: I) -> Self::Output {
        SortedDisjoint::union(self, other)
    }
}

impl<T: Integer, I> ops::Sub<I> for RangesIter<'_, T>
where
    I: SortedDisjoint<T>,
{
    type Output = BitSubMerge<T, Self, I>;

    fn sub(self, other: I) -> Self::Output {
        SortedDisjoint::difference(self, other)
    }
}

impl<T: Integer, I> ops::Sub<I> for IntoRangesIter<T>
where
    I: SortedDisjoint<T>,
{
    type Output = BitSubMerge<T, Self, I>;

    fn sub(self, other: I) -> Self::Output {
        SortedDisjoint::difference(self, other)
    }
}

impl<T: Integer, I> ops::BitXor<I> for RangesIter<'_, T>
where
    I: SortedDisjoint<T>,
{
    type Output = BitXOr<T, Self, I>;

    #[allow(clippy::suspicious_arithmetic_impl)]
    fn bitxor(self, other: I) -> Self::Output {
        // We optimize by using self.clone() instead of tee
        let lhs1 = self.clone();
        let (rhs0, rhs1) = other.tee();
        (self - rhs0) | (rhs1.difference(lhs1))
    }
}

impl<T: Integer, I> ops::BitXor<I> for IntoRangesIter<T>
where
    I: SortedDisjoint<T>,
{
    type Output = BitXOrTee<T, Self, I>;

    #[allow(clippy::suspicious_arithmetic_impl)]
    fn bitxor(self, other: I) -> Self::Output {
        SortedDisjoint::symmetric_difference(self, other)
    }
}

impl<T: Integer, I> ops::BitAnd<I> for RangesIter<'_, T>
where
    I: SortedDisjoint<T>,
{
    type Output = BitAndMerge<T, Self, I>;

    #[allow(clippy::suspicious_arithmetic_impl)]
    fn bitand(self, other: I) -> Self::Output {
        SortedDisjoint::intersection(self, other)
    }
}

impl<T: Integer, I> ops::BitAnd<I> for IntoRangesIter<T>
where
    I: SortedDisjoint<T>,
{
    type Output = BitAndMerge<T, Self, I>;

    #[allow(clippy::suspicious_arithmetic_impl)]
    fn bitand(self, other: I) -> Self::Output {
        SortedDisjoint::intersection(self, other)
    }
}