nonempty-collections 1.3.0

//! Extra non-empty iterator adaptors, functions and macros.
//!
//! To extend [`NonEmptyIterator`] with methods in this crate, import
//! the [`NonEmptyItertools`] trait:
//!
//! ```
//! use nonempty_collections::NonEmptyItertools;
//! ```

use crate::IntoNonEmptyIterator;
use crate::NonEmptyIterator;
use core::fmt;
use itertools::Itertools;
use std::fmt::Debug;

/// A [`NonEmptyIterator`] blanket implementation that provides extra adaptors
/// and methods, similar to [`Itertools`](https://docs.rs/itertools/) for `Iterator`.
pub trait NonEmptyItertools: NonEmptyIterator {
    /// Return a non-empty iterator adaptor that iterates over the non-empty
    /// cartesian product of the element sets of two iterators `self` and
    /// `J`.
    ///
    /// `NonEmptyIterator`element type is `(Self::Item, J::Item)`.
    ///
    /// ```
    /// use nonempty_collections::*;
    ///
    /// let product = nev![0, 1]
    ///     .nonempty_iter()
    ///     .copied()
    ///     .cartesian_product("αβ".chars().try_into_nonempty_iter().unwrap())
    ///     .collect::<NEVec<_>>();
    /// assert_eq!(nev![(0, 'α'), (0, 'β'), (1, 'α'), (1, 'β')], product);
    /// ```
    fn cartesian_product<J>(self, other: J) -> Product<Self, J::IntoNEIter>
    where
        Self: Sized,
        Self::Item: Clone,
        J: IntoNonEmptyIterator,
        <J::IntoNEIter as IntoIterator>::IntoIter: Clone,
    {
        Product {
            inner: Itertools::cartesian_product(self.into_iter(), other.into_nonempty_iter()),
        }
    }

    /// Check whether all elements are unique (non equal).
    ///
    /// # Examples
    ///
    /// ```
    /// use nonempty_collections::*;
    ///
    /// let data = nev![1, 2, 3, 4, 1, 5];
    /// assert!(!nev![1, 2, 3, 4, 1, 5].nonempty_iter().all_unique());
    /// assert!(nev![2, 3, 4, 1, 5].nonempty_iter().all_unique());
    /// ```
    #[must_use]
    fn all_unique(self) -> bool
    where
        Self: Sized,
        Self::Item: Eq + std::hash::Hash,
    {
        self.into_iter().all_unique()
    }
}

impl<T> NonEmptyItertools for T where T: NonEmptyIterator + ?Sized {}

/// A non-empty iterator adaptor that iterates over the cartesian product of
/// the element sets of two iterators `I` and `J`.
///
/// Iterator element type is `(I::Item, J::Item)`.
///
/// See [`.cartesian_product()`](crate::itertools::Itertools::cartesian_product)
/// for more information.
#[must_use = "iterator adaptors are lazy and do nothing unless consumed"]
pub struct Product<I, J>
where
    I: NonEmptyIterator,
    J: NonEmptyIterator,
{
    inner: itertools::Product<I::IntoIter, J::IntoIter>,
}

impl<I, J> NonEmptyIterator for Product<I, J>
where
    I: NonEmptyIterator,
    J: NonEmptyIterator,
    J::Item: Clone,
    I::Item: Clone,
    J::IntoIter: Clone,
    I::IntoIter: Clone,
{
}

impl<I, J> IntoIterator for Product<I, J>
where
    I: NonEmptyIterator,
    J: NonEmptyIterator,
    J::Item: Clone,
    I::Item: Clone,
    J::IntoIter: Clone,
    I::IntoIter: Clone,
{
    type Item = (I::Item, J::Item);

    type IntoIter = itertools::Product<I::IntoIter, J::IntoIter>;

    fn into_iter(self) -> Self::IntoIter {
        self.inner
    }
}

impl<I, J> Debug for Product<I, J>
where
    I: NonEmptyIterator,
    J: NonEmptyIterator,
    I::Item: Debug,
    J::Item: Debug,
    I::IntoIter: Debug,
    J::IntoIter: Debug,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        Debug::fmt(&self.inner, f)
    }
}