range-set-blaze 0.5.0

Integer sets as fast, sorted integer ranges; Maps with integer-range keys; Full set operations
Documentation
#![cfg(feature = "from_slice")]

use crate::Integer;
use alloc::slice;
use core::simd::{Simd, SimdElement};
use core::{iter::FusedIterator, ops::RangeInclusive, ops::Sub};

#[allow(clippy::redundant_pub_crate)]
#[allow(clippy::module_name_repetitions)]
#[derive(Clone, Debug)]
#[must_use = "iterators are lazy and do nothing unless consumed"]
pub(crate) struct FromSliceIter<'a, T, const N: usize>
where
    T: SimdInteger,
{
    prefix_iter: core::slice::Iter<'a, T>,
    previous_range: Option<RangeInclusive<T>>,
    chunks: slice::Iter<'a, Simd<T, N>>,
    suffix: &'a [T],
    slice_len: usize,
}

impl<'a, T, const N: usize> FromSliceIter<'a, T, N>
where
    T: SimdInteger,
{
    pub(crate) fn new(slice: &'a [T]) -> Self {
        let (prefix, middle, suffix) = slice.as_simd();
        FromSliceIter {
            prefix_iter: prefix.iter(),
            previous_range: None,
            chunks: middle.iter(),
            suffix,
            slice_len: slice.len(),
        }
    }
}

// Only need one implementation of FusedIterator
impl<T, const N: usize> FusedIterator for FromSliceIter<'_, T, N>
where
    T: SimdInteger,
    Simd<T, N>: Sub<Output = Simd<T, N>>,
{
}

impl<T, const N: usize> Iterator for FromSliceIter<'_, T, N>
where
    T: SimdInteger,
    Simd<T, N>: Sub<Output = Simd<T, N>>,
{
    type Item = RangeInclusive<T>;

    #[inline]
    fn next(&mut self) -> Option<RangeInclusive<T>> {
        if let Some(before) = self.prefix_iter.next() {
            return Some(*before..=*before);
        }
        for chunk in self.chunks.by_ref() {
            if T::is_consecutive(*chunk) {
                let this_start = chunk[0];
                let this_end = chunk[N - 1];

                if let Some(inner_previous_range) = self.previous_range.as_mut() {
                    // if some and previous is some and adjacent, combine
                    if (*inner_previous_range.end()).add_one() == this_start {
                        *inner_previous_range = *(inner_previous_range.start())..=this_end;
                    } else {
                        // if some and previous is some but not adjacent, flush previous, set previous to this range.
                        let result = Some(inner_previous_range.clone());
                        *inner_previous_range = this_start..=this_end;
                        return result;
                    }
                } else {
                    // if some and previous is None, set previous to this range.
                    self.previous_range = Some(this_start..=this_end);
                }
            } else {
                // If none, flush previous range, set it to none, output this chunk as a bunch of singletons.
                self.prefix_iter = chunk.as_array().iter();
                if let Some(previous) = self.previous_range.take() {
                    debug_assert!(self.previous_range.is_none());
                    return Some(previous);
                }
                let before = self.prefix_iter.next().expect(".next() is always Some() because we just created it from a non-zero length chunk.");
                return Some(*before..=*before);
            }
        }

        // at the very, very end, flush previous.
        if let Some(previous) = &self.previous_range.take() {
            debug_assert!(self.previous_range.is_none());
            return Some(previous.clone());
        }

        self.prefix_iter = self.suffix.iter();
        self.suffix = &[];

        self.prefix_iter.next().map(|before| *before..=*before)
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        // Best case: if empty then 0. If aligned and all consecutive, then 1.
        let low = self.slice_len.min(1);
        // Worst case is all singletons, so high is the slice length.
        let high = self.slice_len;
        (low, Some(high))
    }
}

#[allow(clippy::redundant_pub_crate)]
pub(crate) trait SimdInteger: Integer + SimdElement {
    fn is_consecutive<const N: usize>(chunk: Simd<Self, N>) -> bool
    where
        Simd<Self, N>: Sub<Simd<Self, N>, Output = Simd<Self, N>>;
}

macro_rules! define_const_reference {
    ($type:ty) => {
        #[allow(clippy::cast_precision_loss)]
        #[allow(clippy::cast_possible_truncation)]
        #[allow(clippy::cast_possible_wrap)]
        const fn comparison_value<const N: usize>() -> Simd<$type, N> {
            let mut arr: [$type; N] = [0; N];
            let mut i = 0;
            while i < N {
                arr[i] = i as $type; // For now, must use "as" because we are in a const context.
                i += 1;
            }
            Simd::from_array(arr)
        }
    };
}

macro_rules! impl_is_consecutive {
    ($type:ty) => {
        // Repeat for each integer type (i8, i16, i32, i64, isize, u8, u16, u32, u64, usize)

        impl SimdInteger for $type {
            #[inline]
            fn is_consecutive<const N: usize>(chunk: Simd<Self, N>) -> bool
            where
                Self: SimdElement,
                Simd<Self, N>: Sub<Simd<Self, N>, Output = Simd<Self, N>>,
            {
                define_const_reference!($type);
                let subtracted = chunk - comparison_value();
                Simd::splat(chunk[0]) == subtracted
            }
        }
    };
}

// Apply the macro to each integer type
impl_is_consecutive!(i8);
impl_is_consecutive!(i16);
impl_is_consecutive!(i32);
impl_is_consecutive!(i64);
impl_is_consecutive!(isize);
impl_is_consecutive!(u8);
impl_is_consecutive!(u16);
impl_is_consecutive!(u32);
impl_is_consecutive!(u64);
impl_is_consecutive!(usize);