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
//! Set operations for [`BitSet`] that make sense over any universe.
//!
//! For methods specific to integer sets, see [`math`].
use crate::*;
impl<W: Word> BitSet<W> {
/// An iterator over the elements in ascending order.
///
/// Note that [`Self::iter`] takes the set by value and yields elements by value, making it
/// equivalent to [`Self::into_iter`]. This is because [`BitSet`] implements [`Copy`] at a
/// trivial cost and only stores elements in a compressed representation.
///
/// # Examples
///
/// ```
/// # use pibs::prelude::*;
/// let set = set![7, 3..=5, 1];
/// assert!(set.iter().eq([1, 3, 4, 5, 7]));
/// assert!(set.iter().rev().eq([7, 5, 4, 3, 1]));
/// ```
#[inline]
pub fn iter(self) -> BitSetIter<W> {
BitSetIter::<W>(self.0)
}
/// The set with an element added to it (or left in).
///
/// This is the same as `self + e`.
///
/// # Preconditions
///
/// The caller must ensure that `e <= Self::MAX`.
///
/// # Examples
///
/// ```
/// # use pibs::prelude::*;
/// let set = set![1..=3];
/// assert_eq!(set.with(2), set![1..=3]); // Does nothing.
/// assert_eq!(set.with(4), set![1..=4]);
/// ```
#[inline]
pub fn with(self, e: Element) -> Self {
Self::debug_bound_check(e);
Self(self.0 | W::ONE << e)
}
/// The set with an element removed from it (if present).
///
/// This is the same as `self - e`.
///
/// # Preconditions
///
/// The caller must ensure that `e <= Self::MAX`.
///
/// # Examples
///
/// ```
/// # use pibs::prelude::*;
/// let set = set![1..=3];
/// assert_eq!(set.without(2), set![1, 3]);
/// assert_eq!(set.without(4), set![1..=3]); // Does nothing.
/// ```
#[inline]
pub fn without(self, e: Element) -> Self {
Self::debug_bound_check(e);
Self(self.0 & !(W::ONE << e))
}
/// The union of two sets.
///
/// This is the same as `self | other`.
///
/// # Examples
///
/// ```
/// # use pibs::prelude::*;
/// let a = set![1..=5];
/// let b = set![3..=7];
/// assert_eq!(a.union(b), set![1..=7]);
/// ```
#[inline]
pub fn union(self, other: Self) -> Self {
Self(self.0 | other.0)
}
/// The intersection of two sets.
///
/// This is the same as `self & other`.
///
/// # Examples
///
/// ```
/// # use pibs::prelude::*;
/// let a = set![1..=5];
/// let b = set![3..=7];
/// assert_eq!(a.intersection(b), set![3..=5]);
/// ```
#[inline]
pub fn intersection(self, other: Self) -> Self {
Self(self.0 & other.0)
}
/// The set with every element also present in another set removed.
///
/// # Examples
///
/// ```
/// # use pibs::prelude::*;
/// let a = set![1..=5];
/// let b = set![3..=7];
/// assert_eq!(a.difference(b), set![1..=2]);
/// ```
#[inline]
pub fn difference(self, other: Self) -> Self {
Self(self.0 & !other.0)
}
/// The symmetric difference of two sets.
///
/// This is the same as `self ^ other`.
///
/// # Examples
///
/// ```
/// # use pibs::prelude::*;
/// let a = set![1..=5];
/// let b = set![3..=7];
/// assert_eq!(a.symmetric_difference(b), set![1..=2, 6..=7]);
/// ```
#[inline]
pub fn symmetric_difference(self, other: Self) -> Self {
Self(self.0 ^ other.0)
}
}