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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
//! This crate provides set and relational operations for all iterators in the standard library that are known
//! at compile time to be sorted.
//!
//! # Set operations
//! ```
//! # extern crate maplit;
//! # use maplit::*;
//! # extern crate sorted_iter;
//! use sorted_iter::SortedIterator;
//!
//! let primes = btreeset! { 2, 3, 5, 7, 11, 13u64 }.into_iter();
//! let fibs = btreeset! { 1, 2, 3, 5, 8, 13u64 }.into_iter();
//! let fib_primes = primes.intersection(fibs);
//! ```
//!
//! It is possible to efficiently define set operations on sorted iterators. Sorted iterators are
//! very common in the standard library. E.g. the elements of a [BTreeSet] or the keys of a [BTreeMap]
//! are guaranteed to be sorted according to the element order, as are iterable ranges like `0..100`.
//!
//! There are also a number of operations on iterators that preserve the sort order. E.g. if an
//! iterator is sorted, [take], [take_while] etc. are going to result in a sorted iterator as well.
//!
//! Since the complete types of iterators are typically visible in rust, it is possible to encode these
//! rules at type level. This is what this crate does.
//!
//! For available set operations, see [SortedIterator].
//! For sorted iterators in the std lib, see instances for the [SortedByItem] marker trait.
//!
//! # Relational operations
//! ```
//! # extern crate maplit;
//! # use maplit::*;
//! # extern crate sorted_iter;
//! use sorted_iter::SortedPairIterator;
//!
//! let cities = btreemap! {
//! 1 => "New York",
//! 2 => "Tokyo",
//! 3u8 => "Berlin"
//! }.into_iter();
//! let countries = btreemap! {
//! 1 => "USA",
//! 2 => "Japan",
//! 3u8 => "Germany"
//! }.into_iter();
//! let cities_and_countries = cities.join(countries);
//! ```
//!
//! Iterators of pairs that are sorted according to the first element / key are also very common in
//! the standard library and elsewhere. E.g. the elements of a [BTreeMap] are guaranteed to be sorted
//! according to the key order.
//!
//! The same rules as for sorted iterators apply for preservation of the sort order, except that there
//! are some additional operations that preserve sort order. Anything that only operates on the value,
//! like e.g. map or filter_map on the value, is guaranteed to preserve the sort order.
//!
//! The operations that can be defined on sorted pair operations are the relational operations known
//! from relational algebra / SQL, namely join, left_join, right_join and outer_join.
//!
//! For available relational operations, see [SortedPairIterator].
//! For sorted iterators in the std lib, see instances the for [SortedByKey] marker trait.
//!
//! # Transformations that retain order are allowed
//! ```
//! # extern crate sorted_iter;
//! use sorted_iter::*;
//!
//! let odd = (1..31).step_by(2);
//! let multiples_of_3 = (3..30).step_by(3);
//! let either = odd.union(multiples_of_3);
//! ```
//!
//! # Transformations that can change the order lose the sorted property
//! ```compile_fail
//! # extern crate sorted_iter;
//! use sorted_iter::*;
//!
//! // we have no idea what map does to the order. could be anything!
//! let a = (1..31).map(|x| -x);
//! let b = (3..30).step_by(3);
//! let either = a.union(b); // does not compile!
//! ```
//!
//! # Assuming sort ordering
//!
//! For most std lib iterators, this library already provides instances. But there will occasionally be an iterator
//! from a third party library where you *know* that it is properly sorted.
//!
//! For this case, there is an escape hatch:
//!
//! ```
//! // the assume_ extensions have to be implicitly imported
//! use sorted_iter::*;
//! use sorted_iter::assume::*;
//! let odd = vec![1,3,5,7u8].into_iter().assume_sorted_by_item();
//! let even = vec![2,4,6,8u8].into_iter().assume_sorted_by_item();
//! let all = odd.union(even);
//!
//! let cities = vec![(1u8, "New York")].into_iter().assume_sorted_by_key();
//! let countries = vec![(1u8, "USA")].into_iter().assume_sorted_by_key();
//! let cities_and_countries = cities.join(countries);
//! ```
//!
//! # Marking your own iterators
//!
//! If you have a library and want to mark some iterators as sorted, this is possible by implementing the
//! appropriate marker trait, [SortedByItem] or [SortedByKey].
//!
//! ```
//! # extern crate sorted_iter;
//! // marker traits are not at top level, since usually you don't need them
//! use sorted_iter::sorted_iterator::SortedByItem;
//! use sorted_iter::sorted_pair_iterator::SortedByKey;
//!
//! pub struct MySortedIter<T> { whatever: T }
//! pub struct MySortedPairIter<K, V> { whatever: (K, V) }
//!
//! impl<T> SortedByItem for MySortedIter<T> {}
//! impl<K, V> SortedByKey for MySortedPairIter<K, V> {}
//! ```
//!
//! By reexporting the extension traits, you get a seamless experience for people using your library.
//!
//! ```
//! extern crate sorted_iter;
//! pub use sorted_iter::{SortedIterator, SortedPairIterator};
//! ```
//!
//! ## Tests
//!
//! Tests are done using the fantastic [quickcheck] crate, by comparing against the operations defined on
//! [BTreeSet] and [BTreeMap].
//!
//! [SortedIterator]: trait.SortedIterator.html
//! [SortedPairIterator]: trait.SortedPairIterator.html
//! [SortedByItem]: sorted_iterator/trait.SortedByItem.html
//! [SortedByKey]: sorted_pair_iterator/trait.SortedByKey.html
//! [quickcheck]: https://github.com/BurntSushi/quickcheck
//! [BTreeSet]: https://doc.rust-lang.org/std/collections/struct.BTreeSet.html
//! [BTreeMap]: https://doc.rust-lang.org/std/collections/struct.BTreeMap.html
//! [take]: https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.take
//! [take_while]: https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.take_while
//! [Ord]: https://doc.rust-lang.org/std/cmp/trait.Ord.html
#[cfg(test)]
extern crate quickcheck;
#[cfg(test)]
#[macro_use(quickcheck)]
extern crate quickcheck_macros;
use core::cmp::Ordering;
pub mod one_or_less_iterator;
pub mod sorted_iterator;
pub mod sorted_pair_iterator;
pub use one_or_less_iterator::OneOrLess;
use crate::sorted_iterator::*;
use crate::sorted_pair_iterator::*;
#[deny(missing_docs)]
/// set operations for iterators where the items are sorted according to the natural order
pub trait SortedIterator: Iterator + Sized {
/// Visits the values representing the union, i.e., all the values in `self` or `other`,
/// without duplicates.
fn union<J>(self, other: J) -> Union<Self, J>
where
J: SortedIterator<Item = Self::Item>,
{
Union {
a: self.peekable(),
b: other.peekable(),
}
}
/// Visits the values representing the intersection, i.e., the values that are both in `self`
/// and `other`.
fn intersection<J>(self, other: J) -> Intersection<Self, J>
where
J: SortedIterator<Item = Self::Item>,
{
Intersection {
a: self,
b: other.peekable(),
}
}
/// Visits the values representing the difference, i.e., the values that are in `self` but not
/// in `other`.
fn difference<J>(self, other: J) -> Difference<Self, J>
where
J: SortedIterator<Item = Self::Item>,
{
Difference {
a: self,
b: other.peekable(),
}
}
/// Visits the values representing the symmetric difference, i.e., the values that are in
/// `self` or in `other` but not in both.
fn symmetric_difference<J>(self, other: J) -> SymmetricDifference<Self, J>
where
J: SortedIterator<Item = Self::Item>,
{
SymmetricDifference {
a: self.peekable(),
b: other.peekable(),
}
}
/// Creates an iterator that pairs each element of `self` with `()`. This transforms a
/// `SortedIterator` into a [`SortedPairIterator`].
fn pairs(self) -> Pairs<Self> {
Pairs { i: self }
}
/// Returns `true` if `self` has no elements in common with `other`. This is equivalent to
/// checking for an empty intersection.
fn is_disjoint<J>(self, mut other: J) -> bool
where
J: SortedIterator<Item = Self::Item>,
Self::Item: Ord,
{
let mut next_b = other.next();
'next_a: for a in self {
while let Some(b) = &next_b {
match a.cmp(b) {
Ordering::Less => continue 'next_a,
Ordering::Equal => return false,
Ordering::Greater => next_b = other.next(),
}
}
break;
}
true
}
/// Returns `true` if this sorted iterator is a subset of another, i.e., `other` contains at
/// least all the values in `self`.
fn is_subset<J>(self, mut other: J) -> bool
where
J: SortedIterator<Item = Self::Item>,
Self::Item: Ord,
{
'next_a: for a in self {
while let Some(b) = other.next() {
match a.cmp(&b) {
Ordering::Less => break,
Ordering::Equal => continue 'next_a,
Ordering::Greater => continue,
}
}
return false;
}
true
}
/// Returns `true` if this sorted iterator is a superset of another, i.e., `self` contains at
/// least all the values in `other`.
fn is_superset<J>(self, other: J) -> bool
where
J: SortedIterator<Item = Self::Item>,
Self::Item: Ord,
{
other.is_subset(self)
}
}
impl<I> SortedIterator for I where I: Iterator + SortedByItem {}
/// Union of multiple sorted iterators.
///
/// An advantage of this function over multiple calls to `SortedIterator::union`
/// is that the number of merged sequences does not need to be known at the
/// compile time. The drawback lies in the fact that all iterators have to be
/// of the same type.
///
/// The algorithmic complexity of fully consuming the resulting iterator is
/// *O(N log(K))* where *N* is the total number of items that the input iterators
/// yield and *K* is the number of input iterators.
///
/// # Examples
///
/// ```
/// # extern crate maplit;
/// # use maplit::*;
/// # extern crate sorted_iter;
/// # use std::collections::BTreeSet;
/// use sorted_iter::multiway_union;
///
/// let sequences = vec![
/// btreeset! { 0, 5, 10, 15, 20, 25 }.into_iter(),
/// btreeset! { 0, 1, 4, 9, 16, 25, 36 }.into_iter(),
/// btreeset! { 4, 7, 11, 15, 18 }.into_iter(),
/// ];
///
/// assert_eq!(
/// multiway_union(sequences).collect::<BTreeSet<u64>>(),
/// btreeset! { 0, 1, 4, 5, 7, 9, 10, 11, 15, 16, 18, 20, 25, 36 }
/// );
/// ```
pub fn multiway_union<T, I>(iters: T) -> MultiwayUnion<I>
where
I: SortedIterator,
T: IntoIterator<Item = I>,
I::Item: Ord,
{
MultiwayUnion::from_iter(iters)
}
/// relational operations for iterators of pairs where the items are sorted according to the key
pub trait SortedPairIterator<K, V>: Iterator + Sized {
fn join<W, J: SortedPairIterator<K, W>>(self, that: J) -> Join<Self, J> {
Join {
a: self.peekable(),
b: that.peekable(),
}
}
fn left_join<W, J: SortedPairIterator<K, W>>(self, that: J) -> LeftJoin<Self, J> {
LeftJoin {
a: self.peekable(),
b: that.peekable(),
}
}
fn right_join<W, J: SortedPairIterator<K, W>>(self, that: J) -> RightJoin<Self, J> {
RightJoin {
a: self.peekable(),
b: that.peekable(),
}
}
fn outer_join<W, J: SortedPairIterator<K, W>>(self, that: J) -> OuterJoin<Self, J> {
OuterJoin {
a: self.peekable(),
b: that.peekable(),
}
}
fn map_values<W, F: (FnMut(V) -> W)>(self, f: F) -> MapValues<Self, F> {
MapValues { i: self, f }
}
fn filter_map_values<W, F: (FnMut(V) -> W)>(self, f: F) -> FilterMapValues<Self, F> {
FilterMapValues { i: self, f }
}
fn keys(self) -> Keys<Self> {
Keys { i: self }
}
}
impl<K, V, I> SortedPairIterator<K, V> for I where I: Iterator<Item = (K, V)> + SortedByKey {}
pub mod assume {
//! extension traits for unchecked conversions from iterators to sorted iterators
use super::*;
/// extension trait for any iterator to add a assume_sorted_by_item method
pub trait AssumeSortedByItemExt: Iterator + Sized {
/// assume that the iterator is sorted by its item order
fn assume_sorted_by_item(self) -> AssumeSortedByItem<Self> {
AssumeSortedByItem { i: self }
}
}
impl<I: Iterator + Sized> AssumeSortedByItemExt for I {}
/// extension trait for any iterator of pairs to add a assume_sorted_by_key method
pub trait AssumeSortedByKeyExt: Iterator + Sized {
fn assume_sorted_by_key(self) -> AssumeSortedByKey<Self> {
AssumeSortedByKey { i: self }
}
}
impl<K, V, I: Iterator<Item = (K, V)> + Sized> AssumeSortedByKeyExt for I {}
}
#[cfg(test)]
mod tests {
use super::*;
type Element = i64;
type Reference = std::collections::BTreeSet<Element>;
#[quickcheck]
fn disjoint(a: Reference, b: Reference) -> bool {
a.is_disjoint(&b) == a.iter().is_disjoint(b.iter())
}
#[quickcheck]
fn subset(a: Reference, b: Reference) -> bool {
a.is_subset(&b) == a.iter().is_subset(b.iter())
}
#[quickcheck]
fn superset(a: Reference, b: Reference) -> bool {
a.is_superset(&b) == a.iter().is_superset(b.iter())
}
}