envelope 0.6.1

use interpolation::Spatial;
use num::Float;
use point::Point;


/// Types representable as an Envelope.
pub trait Envelope<'a, P>: Sized {
    /// An iterator yielding references to `P`s.
    type Points: Iterator<Item=&'a P> + ExactSizeIterator + DoubleEndedIterator + Clone + 'a;

    /// An iterator yielding the `Point`s of the Envelope.
    fn points(&'a self) -> Self::Points;

    /// The index of the `Point` that comes directly before the given `x`.
    #[inline]
    fn point_idx_before<X, Y>(&'a self, x: X) -> Option<usize> where
        P: Point<X, Y> + 'a,
        X: PartialOrd + 'a,
        Y: Spatial + 'a,
        Y::Scalar: Float + 'a,
    {
        point_idx_before(self, x)
    }

    /// The index of the `Point` that either lands on or comes directly before the given `x`.
    #[inline]
    fn point_idx_on_or_before<X, Y>(&'a self, x: X) -> Option<usize> where
        P: Point<X, Y> + 'a,
        X: PartialOrd + 'a,
        Y: Spatial + 'a,
        Y::Scalar: Float + 'a,
    {
        point_idx_on_or_before(self, x)
    }

    /// The index of the `Point` that comes directly after the given `x`.
    #[inline]
    fn point_idx_after<X, Y>(&'a self, x: X) -> Option<usize> where
        P: Point<X, Y> + 'a,
        X: PartialOrd + 'a,
        Y: Spatial + 'a,
        Y::Scalar: Float + 'a,
    {
        point_idx_after(self, x)
    }

    /// The index of the `Point` that comes directly after the given `x`.
    #[inline]
    fn point_idx_on_or_after<X, Y>(&'a self, x: X) -> Option<usize> where
        P: Point<X, Y> + 'a,
        X: PartialOrd + 'a,
        Y: Spatial + 'a,
        Y::Scalar: Float + 'a,
    {
        point_idx_on_or_after(self, x)
    }

    /// A reference to the first point that comes before the given `x`.
    #[inline]
    fn point_before<X, Y>(&'a self, x: X) -> Option<&'a P> where
        P: Point<X, Y> + 'a,
        X: PartialOrd + 'a,
        Y: Spatial + 'a,
        Y::Scalar: Float + 'a,
    {
        self.point_idx_before(x).and_then(|i| self.points().nth(i))
    }

    /// A reference to the first point that is equal to or comes before the given `x`.
    #[inline]
    fn point_on_or_before<X, Y>(&'a self, x: X) -> Option<&'a P> where
        P: Point<X, Y> + 'a,
        X: PartialOrd + 'a,
        Y: Spatial + 'a,
        Y::Scalar: Float + 'a,
    {
        self.point_idx_on_or_before(x).and_then(|i| self.points().nth(i))
    }

    /// A reference to the first point that comes before the given `x` along with its index.
    #[inline]
    fn point_before_with_idx<X, Y>(&'a self, x: X) -> Option<(usize, &'a P)> where
        P: Point<X, Y> + 'a,
        X: PartialOrd + 'a,
        Y: Spatial + 'a,
        Y::Scalar: Float + 'a,
    {
        self.point_idx_before(x).and_then(|i| self.points().nth(i).map(|p| (i, p)))
    }

    /// A reference to the first point that is equal to or comes before the given `x` along with
    /// its index.
    #[inline]
    fn point_on_or_before_with_idx<X, Y>(&'a self, x: X) -> Option<(usize, &'a P)> where
        P: Point<X, Y> + 'a,
        X: PartialOrd + 'a,
        Y: Spatial + 'a,
        Y::Scalar: Float + 'a,
    {
        self.point_idx_on_or_before(x).and_then(|i| self.points().nth(i).map(|p| (i, p)))
    }

    /// A reference to the first point that comes after the given `x`.
    #[inline]
    fn point_after<X, Y>(&'a self, x: X) -> Option<&'a P> where
        P: Point<X, Y> + 'a,
        X: PartialOrd + 'a,
        Y: Spatial + 'a,
        Y::Scalar: Float + 'a,
    {
        self.point_idx_after(x).and_then(|i| self.points().nth(i))
    }

    /// A reference to the first point that is equal to or comes after the given `x`.
    #[inline]
    fn point_on_or_after<X, Y>(&'a self, x: X) -> Option<&'a P> where
        P: Point<X, Y> + 'a,
        X: PartialOrd + 'a,
        Y: Spatial + 'a,
        Y::Scalar: Float + 'a,
    {
        self.point_idx_on_or_after(x).and_then(|i| self.points().nth(i))
    }

    /// A reference to the first point that comes after the given `x` along with its index.
    #[inline]
    fn point_after_with_idx<X, Y>(&'a self, x: X) -> Option<(usize, &'a P)> where
        P: Point<X, Y> + 'a,
        X: PartialOrd + 'a,
        Y: Spatial + 'a,
        Y::Scalar: Float + 'a,
    {
        self.point_idx_after(x).and_then(|i| self.points().nth(i).map(|p| (i, p)))
    }

    /// A reference to the first point that is equal to or comes after the given `x` along with
    /// its index.
    #[inline]
    fn point_on_or_after_with_idx<X, Y>(&'a self, x: X) -> Option<(usize, &'a P)> where
        P: Point<X, Y> + 'a,
        X: PartialOrd + 'a,
        Y: Spatial + 'a,
        Y::Scalar: Float + 'a,
    {
        self.point_idx_on_or_after(x).and_then(|i| self.points().nth(i).map(|p| (i, p)))
    }


    /// Return `y` for the given `x`.
    ///
    /// If there is less than two points interpolation is not meaningful,
    /// thus we should just return None.
    ///
    /// Note: It is assumed that the points owned by the Envelope are sorted by `x`.
    #[inline]
    fn y<X, Y>(&'a self, x: X) -> Option<Y>
        where
            X: PartialOrd + 'a,
            Y: Spatial + PartialEq + 'a,
            Y::Scalar: Float + 'a,
            P: Point<X, Y> + 'a,
    {
        y(self, x)
    }

    // /// An iterator yielding the X for each point at which the envelope intersects the given `y`.
    // ///
    // /// If there are any periods at which X is continuous, only the start X of the continuous
    // /// period will be returned.
    // fn xs_at_y(&self, y: Y) -> XsAtY {
    //     unimplemented!();
    // }

}




#[inline]
fn point_idx_before<'a, E, P, X, Y>(env: &'a E, x: X) -> Option<usize> where
    E: Envelope<'a, P>,
    P: Point<X, Y> + 'a,
    X: PartialOrd + 'a,
    Y: Spatial + 'a,
    Y::Scalar: Float + 'a,
{
    env.points().enumerate()
        .take_while(|&(_, point)| point.x() < x )
        .last()
        .map(|(i, _)| i)
}


#[inline]
fn point_idx_on_or_before<'a, E, P, X, Y>(env: &'a E, x: X) -> Option<usize> where
    E: Envelope<'a, P>,
    P: Point<X, Y> + 'a,
    X: PartialOrd + 'a,
    Y: Spatial + 'a,
    Y::Scalar: Float + 'a,
{
    env.points().enumerate()
        .take_while(|&(_, point)| point.x() <= x )
        .last()
        .map(|(i, _)| i)
}


#[inline]
fn point_idx_after<'a, E, P, X, Y>(env: &'a E, x: X) -> Option<usize> where
    E: Envelope<'a, P>,
    P: Point<X, Y> + 'a,
    X: PartialOrd + 'a,
    Y: Spatial + 'a,
    Y::Scalar: Float + 'a,
{
    env.points().enumerate().rev()
        .take_while(|&(_, point)| point.x() > x )
        .last()
        .map(|(i, _)| i)
}


#[inline]
fn point_idx_on_or_after<'a, E, P, X, Y>(env: &'a E, x: X) -> Option<usize> where
    E: Envelope<'a, P>,
    P: Point<X, Y> + 'a,
    X: PartialOrd + 'a,
    Y: Spatial + 'a,
    Y::Scalar: Float + 'a,
{
    env.points().enumerate().rev()
        .take_while(|&(_, point)| point.x() >= x )
        .last()
        .map(|(i, _)| i)
}


#[inline]
fn y<'a, E, P, X, Y>(env: &'a E, x: X) -> Option<Y> where
    E: Envelope<'a, P>,
    P: Point<X, Y> + 'a,
    X: PartialOrd + 'a,
    Y: Spatial + PartialEq + 'a,
    Y::Scalar: Float + 'a,
{

    let mut points: E::Points = env.points();
    let len = points.len();

    // If we have less than two points, there is nothing to interpolate.
    if len < 2 {
        // However if we only have one point...
        if len == 1 {
            // And that point happens to be exactly equal to the given X.
            let only_point: &P = points.clone().next().unwrap();
            if only_point.x() == x {
                // Return the Y at that given X.
                return Some(only_point.y());
            }
        }
        return None;
    }

    // If the given `x` is less than our first point's `X` or greater than our last point's
    // `X`, we cannot interpolate the envelope and thus must return `None`.
    let first_point: &P = points.clone().next().unwrap();
    let last_point: &P = points.clone().last().unwrap();
    if x < first_point.x() || x > last_point.x() {
        return None;
    }

    // Otherwise, we know that X lies within our points and that we can interpolate it!
    let mut end_idx = 1;
    let last_idx = len - 1;
    let mut end_points = points.clone().skip(1);
    while end_idx < last_idx {
        if x >= end_points.next().unwrap().x() {
            end_idx += 1;
        } else {
            break;
        }
    }

    let start_idx = end_idx - 1;
    let start_point = points.clone().nth(start_idx).unwrap();
    let end_point = points.nth(end_idx).unwrap();
    Some(Point::interpolate(x, start_point, end_point))
}