sort-steps 0.2.4

Sort terms step by step.
Documentation
use crate::utils::gt_by;

use std::{cmp::Ordering, iter::from_generator};

/// Sorts a slice of data using the gnome sort algorithm with a custom comparator.
///
/// # Examples
///
/// ```
/// # use sort_steps::{gnome_sort};
/// let numbers = [5, 9, 3, 6, 8, 2, 1, 7, 4];
/// println!("Gnome Sort Steps:");
/// for (i, v) in gnome_sort(&numbers).enumerate() {
///     println!("#{:02}: {:?}", i, v);
/// }
/// ```
pub fn gnome_sort<T>(v: &[T]) -> impl Iterator<Item = Vec<T>>
where
    T: PartialOrd + Clone,
{
    gnome_sort_by(v, |a, b| a.partial_cmp(b))
}

/// Sorts a slice of data using the gnome sort algorithm with a custom comparator.
///
/// # Examples
///
/// ```
/// # use sort_steps::{gnome_sort_by};
/// let numbers = [5, 9, 3, 6, 8, 2, 1, 7, 4];
/// println!("Gnome Sort Steps:");
/// for (i, v) in gnome_sort_by(&numbers, |a, b| a.partial_cmp(b)).enumerate() {
///     println!("#{:02}: {:?}", i, v);
/// }
/// ```
pub fn gnome_sort_by<T, F>(v: &[T], compare: F) -> impl Iterator<Item = Vec<T>>
where
    F: Fn(&T, &T) -> Option<Ordering> + Copy,
    T: Clone,
{
    let mut state = v.to_vec();
    let mut i = 0;

    from_generator(move || {
        yield state.to_vec();
        while i < state.len() {
            if i == 0 || gt_by(&state[i - 1], &state[i], compare) {
                i += 1;
            }
            else {
                state.swap(i - 1, i);
                yield state.to_vec();
                i -= 1;
            }
        }
    })
}