common-range-tools 1.0.0

pub mod checker;

use std::{
    marker::PhantomData,
    mem,
    ops::{Add, RangeBounds, RangeInclusive, Sub},
};

use crate::{
    AnyIncDecCpCmp, CpCmp, DefaultValues, GetBeginEnd, GetBeginEndOption, IncDecCpCmp,
    NumberIncDecCpCmp, RangeRelation, RiFactory, iter::consolidate::checker::ConsolidateChecker,
};
use crate::{range_relation, utils::consolidate};

/// Represents the consolidation order.
#[derive(Clone, Copy)]
pub enum ConsolidationOrder {
    /// Flags an object stating data is expected in the order provided by [crate::sort_forward].
    Forward,

    /// Flags an object stating data is expected in the order provided by [crate::sort_reverse].
    Reverse,
}

impl ConsolidationOrder {
    /// Filters instances of [RangeRelation] for validity against the given [ConsolidationOrder].
    /// When an invalid direction is detected a None is returned.
    ///
    /// There are 2 valid directions for consolidation
    ///  - Forward: see [crate::sort_forward]
    ///  - Reverse: see [crate::sort_reverse]
    ///
    /// Invalid state for: [ConsolidationOrder::Forward]
    ///   - [RangeRelation::After] is not valid.
    ///   - [RangeRelation::Invalid] is not valid.
    ///
    /// Invalid states for: [ConsolidationOrder::Reverse]
    ///   - [RangeRelation::Before] is not valid.
    ///   - [RangeRelation::Invalid] is not valid.
    pub fn check_direction<T>(&self, state: &RangeRelation<T>) -> Result<(), &'static str> {
        match state {
            RangeRelation::Invalid(_) => Err("Range Compare contained Invalid range(s)"),
            RangeRelation::Last(_) | RangeRelation::Overlap(_) => Ok(()),
            RangeRelation::After(_) => match self {
                Self::Forward => {
                    Err("Out of Forward Sequence, Expected: Before|Last|Overlap, got: After")
                }
                Self::Reverse => Ok(()),
            },
            RangeRelation::Before(_) => match self {
                Self::Forward => Ok(()),
                Self::Reverse => {
                    Err("Out of Forward Sequence, Expected: After|Last|Overlap, got: Before")
                }
            },
        }
    }

    /// Cheks if the next range would be wanted in the set.
    /// Returns true if yes, false if no.
    pub fn wants_next<T>(&self, r: &RangeRelation<T>) -> bool {
        match r {
            RangeRelation::Invalid(_) => false,
            RangeRelation::Last(_) | RangeRelation::Overlap(_) => return true,
            RangeRelation::After(_) => match self {
                Self::Forward => return false,
                Self::Reverse => return true,
            },
            RangeRelation::Before(_) => match self {
                Self::Forward => return true,
                Self::Reverse => return false,
            },
        }
    }

    /// Checks the positional value of a against b.
    ///
    /// The tuple returned represents the following
    ///  - 0: when true a overlaps with b
    ///  - 1: when true a is after b.
    pub fn check_position<T>(
        &self,
        a: &impl GetBeginEnd<T>,
        b: &impl GetBeginEnd<T>,
        t: &impl CpCmp<T>,
    ) -> (bool, bool) {
        let r = range_relation(a, b, t);
        match r {
            RangeRelation::Invalid(_) => (false, false),
            RangeRelation::Last(_) => (true, true),
            RangeRelation::Overlap(_) => match self {
                ConsolidationOrder::Forward => (true, t.lt(b.get_end(), a.get_end())),
                ConsolidationOrder::Reverse => (true, t.lt(a.get_begin(), b.get_begin())),
            },
            RangeRelation::After(_) => match self {
                Self::Forward => return (false, true),
                Self::Reverse => return (false, false),
            },
            RangeRelation::Before(_) => match self {
                Self::Forward => return (false, false),
                Self::Reverse => return (false, true),
            },
        }
    }

    /// Returns true if the final directional boundry of a is beyond b.
    ///  - Given, [ConsolidationOrder::Forward] a.get_end() must be gt b.get_end() to return true.
    ///  - Given, [ConsolidationOrder::Reverse] a.get_begin() must be lt b.get_begin() to return true.
    pub fn is_beyond<T>(
        &self,
        a: &impl GetBeginEnd<T>,
        b: &impl GetBeginEnd<T>,
        t: &impl CpCmp<T>,
    ) -> bool {
        match self {
            Self::Forward => t.lt(b.get_end(), a.get_end()),
            Self::Reverse => t.lt(a.get_begin(), b.get_begin()),
        }
    }

    /// Checks if a begins or ends before b relative to the current order.
    pub fn is_before<T>(
        &self,
        a: &impl GetBeginEnd<T>,
        b: &impl GetBeginEnd<T>,
        t: &impl CpCmp<T>,
    ) -> bool {
        match self {
            Self::Forward => t.lt(a.get_end(), b.get_end()),
            Self::Reverse => t.lt(b.get_begin(), a.get_begin()),
        }
    }
}

/// Consolidates duplicate and overlapping ranges.
pub struct Consolidate<
    T,
    V,
    R: GetBeginEnd<T>,
    S: RangeBounds<T>,
    F: GetBeginEndOption<T, R>,
    I: Iterator<Item = S>,
    C: IncDecCpCmp<T, V>,
> {
    iter: I,
    last: Option<(R, Vec<(usize, S)>)>,
    next: Option<RangeRelation<(R, Vec<(usize, S)>)>>,
    cmp: C,
    facotry: F,
    offset: usize,
    rebound: V,
    _p: PhantomData<(T, S)>,
}
impl<
    T,
    V,
    R: GetBeginEnd<T>,
    S: RangeBounds<T>,
    F: GetBeginEndOption<T, R>,
    I: Iterator<Item = S>,
    C: IncDecCpCmp<T, V>,
> Consolidate<T, V, R, S, F, I, C>
{
    pub fn new(mut iter: I, cmp: C, factory: F, rebound: V) -> Self {
        let mut last = None;
        let (offset, next) = consolidate(&mut last, &mut iter, &cmp, &rebound, &factory, 0);
        return Self {
            iter,
            last,
            next,
            cmp: cmp,
            facotry: factory,
            offset,
            rebound,
            _p: PhantomData,
        };
    }

    /// Returns a ref to the internal [CpCmp] instance.
    pub fn get_cmp(&self) -> &C {
        return &self.cmp;
    }

    /// Returns the internal factory interface ref.
    pub fn get_factory(&self) -> &F {
        return &self.facotry;
    }
}

impl<
    T,
    V,
    R: GetBeginEnd<T>,
    S: RangeBounds<T>,
    F: GetBeginEndOption<T, R>,
    I: Iterator<Item = S>,
    C: IncDecCpCmp<T, V>,
> Consolidate<T, V, R, S, F, I, C>
{
    /// Converts the current instance to [ConsolidateChecker] instance.
    pub fn to_consolidate_checker(
        self,
        order: ConsolidationOrder,
    ) -> ConsolidateChecker<T, V, R, S, F, I, C> {
        return ConsolidateChecker::new(order, self);
    }
}

impl<T, S: RangeBounds<T>, I: Iterator<Item = S>>
    Consolidate<T, T, RangeInclusive<T>, S, RiFactory<T>, I, NumberIncDecCpCmp<T>>
where
    NumberIncDecCpCmp<T>: DefaultValues<T, T>,
    T: Copy + Clone,
{
    pub fn num(iter: I, cmp: NumberIncDecCpCmp<T>, factory: RiFactory<T>) -> Self {
        return Self::new(iter, cmp, factory, cmp.default_rebound());
    }
}

impl<T, S: RangeBounds<T>, I: Iterator<Item = S>>
    Consolidate<T, T, RangeInclusive<T>, S, RiFactory<T>, I, NumberIncDecCpCmp<T>>
where
    NumberIncDecCpCmp<T>: DefaultValues<T, T>,
    T: Copy + Clone,
{
    pub fn num_defaults(iter: I) -> Self {
        let cmp = NumberIncDecCpCmp::<T>::defaults();
        let factory = RiFactory::<T>::new();
        return Self::num(iter, cmp, factory);
    }
}

impl<V, R: GetBeginEnd<T>, S: RangeBounds<T>, T, I: Iterator<Item = S>, F: GetBeginEndOption<T, R>>
    Consolidate<T, V, R, S, F, I, AnyIncDecCpCmp<T>>
where
    V: Copy,
    T: PartialOrd + Copy + Add<V, Output = T> + Sub<V, Output = T>,
{
    pub fn any(iter: I, cmp: AnyIncDecCpCmp<T>, factory: F, rebound: V) -> Self {
        return Self::new(iter, cmp, factory, rebound);
    }
}

impl<T, V, I: Iterator<Item = RangeInclusive<T>>>
    Consolidate<T, V, RangeInclusive<T>, RangeInclusive<T>, RiFactory<T>, I, AnyIncDecCpCmp<T>>
where
    V: Copy,
    T: PartialOrd + Copy + Add<V, Output = T> + Sub<V, Output = T>,
{
    pub fn any_defaults(iter: I, min: T, max: T, rebound: V) -> Self {
        return Self::any(
            iter,
            AnyIncDecCpCmp::new(min, max),
            RiFactory::new(),
            rebound,
        );
    }
}

impl<
    T,
    V,
    R: GetBeginEnd<T>,
    S: RangeBounds<T>,
    F: GetBeginEndOption<T, R>,
    I: Iterator<Item = S>,
    C: IncDecCpCmp<T, V>,
> Iterator for Consolidate<T, V, R, S, F, I, C>
{
    type Item = RangeRelation<(R, Vec<(usize, S)>)>;

    /// The [RangeRelation] returnd represnets relative position to the next set of data.  
    /// -- The R [GetBeginEnd] instance represnets the overlapping range.
    /// -- The [Vec] of ([usize],[GetBeginEnd]), the usize represents the [Iterator] position and the [GetBeginEnd] is the raw range.
    fn next(&mut self) -> Option<Self::Item> {
        if self.next.is_none() {
            return None;
        }
        let next;
        (self.offset, next) = consolidate(
            &mut self.last,
            &mut self.iter,
            &self.cmp,
            &self.rebound,
            &self.facotry,
            self.offset,
        );

        return mem::replace(&mut self.next, next);
    }
}