s2json-core 1.52.0

use crate::*;
use core::{
    cmp::Ordering,
    f64::consts::PI,
    fmt::Debug,
    ops::{Add, AddAssign, Div, DivAssign, Mul, MulAssign, Neg, Rem, RemAssign, Sub, SubAssign},
};
use libm::{atan, atan2, fabs, fmod, log, sin, sinh, sqrt};
use serde::{Deserialize, Serialize};

/// # Vector Points
///
/// ## Description
/// A Vector Point uses a structure for 2D or 3D points. Useful for geometry that also has m-values
///
/// Implements the ops [`Add`], [`AddAssign`], [`Sub`], [`SubAssign`], [`Mul`], [`MulAssign`], [`Div`], [`DivAssign`], [`Rem`], [`RemAssign`], [`Neg`], [`PartialEq`], and [`Eq`].
///
/// Also implements local traits [`GetXY`], [`GetZ`], [`GetM`], [`SetXY`], [`SetZ`], [`SetM`], [`NewXY`], [`NewXYM`], [`NewXYZ`], [`NewXYZM`], [`MValueCompatible`], [`MValue`], and [`Interpolate`].
///
/// ## Fields
/// - `x`: X coordinate
/// - `y`: Y coordinate
/// - `z`: Z coordinate or "altitude". May be None
/// - `m`: M-Value
/// - `t`: T for tolerance. A tmp value often used for simplification if needed.
///
/// ## Usage
///
/// - [`VectorPoint::new`]: Creates a new VectorPoint
/// - [`VectorPoint::to_m_value`]: Convert to an MValue VectorPoint using to_m_value
/// - [`VectorPoint::project`]: Project the point into the 0->1 coordinate system
/// - [`VectorPoint::unproject`]: Unproject the point from the 0->1 coordinate system
/// - [`VectorPoint::is_empty`]: Returns true if the point is the zero vector
/// - [`VectorPoint::face`]: Returns the S2 face assocated with this point
/// - [`VectorPoint::modulo]: Apply modular arithmetic
/// - [`VectorPoint::angle`]: Returns the angle between "this" and v in radians, in the range [0, pi]. If either vector is zero-length, or nearly zero-length, the result will be zero, regardless of the other value
/// - [`VectorPoint::cross`]: Get the cross product of two Vector Points
/// - [`VectorPoint::dot`]: dot returns the standard dot product of v and ov.
/// - [`VectorPoint::abs`]: Returns the absolute value of the point.
/// - [`VectorPoint::invert`]: Returns the inverse of the point
/// - [`VectorPoint::len`]: Returns the length of the point
/// - [`VectorPoint::norm`]: norm returns the vector's norm. (sqrt of norm2)
/// - [`VectorPoint::norm2`]: norm2 returns the vector's squared norm (self.dot(self))
/// - [`VectorPoint::normalize`]: Normalize this point to unit length
/// - [`VectorPoint::distance`]: return the distance from this point to the other point
/// - [`VectorPoint::largest_abs_component`]: Returns the largest absolute component of the point
/// - [`VectorPoint::interpolate`]: Interpolate between two points with a given t value
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
#[repr(C)]
pub struct VectorPoint<M: Clone = MValue> {
    /// X coordinate
    pub x: f64,
    /// Y coordinate
    pub y: f64,
    /// Z coordinate or "altitude". May be None
    #[serde(skip_serializing_if = "Option::is_none")]
    pub z: Option<f64>,
    /// M-Value
    #[serde(skip_serializing_if = "Option::is_none")]
    pub m: Option<M>,
    /// T for tolerance. A tmp value used for simplification
    #[serde(skip)]
    pub t: Option<f64>,
}
// GET
impl<M: Clone> GetXY for VectorPoint<M> {
    fn x(&self) -> f64 {
        self.x
    }
    fn y(&self) -> f64 {
        self.y
    }
}
impl<M: Clone> GetZ for VectorPoint<M> {
    fn z(&self) -> Option<f64> {
        self.z
    }
}
impl<M: Clone> GetM<M> for VectorPoint<M> {
    fn m(&self) -> Option<&M> {
        self.m.as_ref()
    }
}
// SET
impl<M: Clone> SetXY for VectorPoint<M> {
    fn set_xy(&mut self, x: f64, y: f64) {
        self.x = x;
        self.y = y;
    }

    fn set_x(&mut self, x: f64) {
        self.x = x;
    }

    fn set_y(&mut self, y: f64) {
        self.y = y;
    }
}
impl<M: Clone> SetZ for VectorPoint<M> {
    fn set_z(&mut self, z: f64) {
        self.z = Some(z);
    }
}
impl<M: Clone> SetM<M> for VectorPoint<M> {
    fn set_m(&mut self, m: M) {
        self.m = Some(m);
    }
}
// NEW
impl<M: Clone> NewXY for VectorPoint<M> {
    fn new_xy(x: f64, y: f64) -> Self {
        Self { x, y, z: None, m: None, t: None }
    }
}
impl<M: Clone> NewXYM<M> for VectorPoint<M> {
    fn new_xym(x: f64, y: f64, m: M) -> Self {
        Self { x, y, z: None, m: Some(m), t: None }
    }
}
impl<M: Clone> NewXYZ for VectorPoint<M> {
    fn new_xyz(x: f64, y: f64, z: f64) -> Self {
        Self { x, y, z: Some(z), m: None, t: None }
    }
}
impl<M: Clone> NewXYZM<M> for VectorPoint<M> {
    fn new_xyzm(x: f64, y: f64, z: f64, m: M) -> Self {
        Self { x, y, z: Some(z), m: Some(m), t: None }
    }
}
// MValue METHODS
impl VectorPoint<MValue> {
    /// Helper function for tests. Create a new point quickly from an xy coordinate
    pub fn from_xy(x: f64, y: f64) -> Self {
        Self { x, y, z: None, m: None, t: None }
    }

    /// Helper function for tests. Create a new point quickly from an xyz coordinate
    pub fn from_xyz(x: f64, y: f64, z: f64) -> Self {
        Self { x, y, z: Some(z), m: None, t: None }
    }
}
// M METHODS
impl<M: Clone> VectorPoint<M> {
    /// Create a new point
    pub fn new(x: f64, y: f64, z: Option<f64>, m: Option<M>) -> Self {
        Self { x, y, z, m, t: None }
    }

    /// Create a new point with xy
    pub fn new_xy(x: f64, y: f64, m: Option<M>) -> Self {
        Self { x, y, z: None, m, t: None }
    }

    /// Create a new point with xyz
    pub fn new_xyz(x: f64, y: f64, z: f64, m: Option<M>) -> Self {
        Self { x, y, z: Some(z), m, t: None }
    }

    /// Convert to an MValue VectorPoint
    pub fn to_m_value(&self) -> VectorPoint<MValue>
    where
        M: Into<MValue>,
    {
        VectorPoint {
            x: self.x,
            y: self.y,
            z: self.z,
            m: self.m.clone().map(|m| m.into()),
            t: None,
        }
    }

    /// Project the point into the 0->1 coordinate system
    pub fn project(&mut self, bbox: Option<&mut BBox3D>) {
        let y = self.y;
        let x = self.x;
        let sin = sin((y * PI) / 180.);
        let y2 = 0.5 - (0.25 * log((1. + sin) / (1. - sin))) / PI;
        self.x = x / 360. + 0.5;
        self.y = y2.clamp(0., 1.);

        if let Some(bbox) = bbox {
            bbox.extend_from_point(self)
        };
    }

    /// Unproject the point from the 0->1 coordinate system back to a lon-lat coordinate
    pub fn unproject(&mut self) {
        let lon = (self.x - 0.5) * 360.;
        let y2 = 0.5 - self.y;
        let lat = atan(sinh(PI * (y2 * 2.))).to_degrees();

        self.x = lon;
        self.y = lat;
    }

    /// Returns true if the point is the zero vector.
    pub fn is_empty(&self) -> bool {
        let zero = f64::default();
        self.x == zero && self.y == zero && (self.z.is_none() || self.z.unwrap() == zero)
    }

    /// Returns the S2 face assocated with this point
    pub fn face(&self, f: u8) -> f64 {
        if f == 0 {
            self.x
        } else if f == 1 {
            self.y
        } else {
            self.z.unwrap_or(0.)
        }
    }

    /// Apply modular arithmetic to x, y, and z using `modulus`
    pub fn modulo(self, modulus: f64) -> Self {
        let modulus = fabs(modulus); // Ensure positive modulus
        Self {
            x: fmod(self.x, modulus),
            y: fmod(self.y, modulus),
            z: self.z.map(|z| fmod(z, modulus)),
            m: self.m,
            t: None,
        }
    }

    /// Returns the angle between "this" and v in radians, in the range [0, pi]. If
    /// either vector is zero-length, or nearly zero-length, the result will be
    /// zero, regardless of the other value.
    pub fn angle<M2: Clone>(&self, b: &VectorPoint<M2>) -> f64 {
        atan2(self.cross(b).norm(), self.dot(b))
    }

    /// Get the cross product of two Vector Points
    pub fn cross<M2: Clone>(&self, b: &VectorPoint<M2>) -> Self {
        if let (Some(z), Some(bz)) = (self.z, b.z) {
            Self::new_xyz(
                self.y * bz - z * b.y,
                z * b.x - self.x * bz,
                self.x * b.y - self.y * b.x,
                None,
            )
        } else {
            Self::new_xy(self.x * b.y - self.y * b.x, self.y * b.x - self.x * b.y, None)
        }
    }

    /// dot returns the standard dot product of v and ov.
    pub fn dot<M2: Clone>(&self, b: &VectorPoint<M2>) -> f64 {
        if let (Some(z), Some(bz)) = (self.z, b.z) {
            self.x * b.x + self.y * b.y + z * bz
        } else {
            self.x * b.x + self.y * b.y
        }
    }

    /// Returns the absolute value of the point.
    pub fn abs(&self) -> Self {
        Self::new(fabs(self.x), fabs(self.y), self.z.map(fabs), None)
    }

    /// Returns the inverse of the point
    pub fn invert(&self) -> Self {
        -self
    }

    /// Returns the length of the point.
    pub fn len(&self) -> f64 {
        self.norm()
    }

    /// norm returns the vector's norm.
    pub fn norm(&self) -> f64 {
        sqrt(self.norm2())
    }

    /// norm2 returns the vector's squared norm.
    pub fn norm2(&self) -> f64 {
        self.dot(self)
    }

    /// Normalize this point to unit length.
    pub fn normalize(&mut self) {
        let len = self.len();
        if len > 0.0 {
            self.x /= len;
            self.y /= len;
            if let Some(z) = self.z {
                self.z = Some(z / len);
            }
        }
    }

    /// return the distance from this point to the other point in radians
    pub fn distance<M2: Clone>(&self, b: &VectorPoint<M2>) -> f64 {
        let d: VectorPoint<M> = self - b;
        d.len()
    }

    /// Returns the largest absolute component of the point.
    pub fn largest_abs_component(&self) -> u8 {
        let tmp = self.abs();
        let tmp_z = tmp.z.unwrap_or(-2.);
        if tmp.x > tmp.y {
            if tmp.x > tmp_z { 0 } else { 2 }
        } else if tmp.y > tmp_z {
            1
        } else {
            2
        }
    }

    /// Returns the intermediate point between this and the other point.
    pub fn intermediate<M2: Clone>(&self, b: &VectorPoint<M2>, t: f64) -> Self {
        if let (Some(z), Some(bz)) = (self.z, b.z) {
            Self::new_xyz(
                self.x + ((b.x - self.x) * (1.0 - t)),
                self.y + ((b.y - self.y) * (1.0 - t)),
                z + ((bz - z) * (1.0 - t)),
                None,
            )
        } else {
            Self::new_xy(
                self.x + ((b.x - self.x) * (1.0 - t)),
                self.y + ((b.y - self.y) * (1.0 - t)),
                None,
            )
        }
    }

    /// Returns the perpendicular vector
    pub fn perpendicular(&self) -> Self {
        if let Some(z) = self.z {
            let ref_point = if fabs(self.x) > fabs(z) {
                Self::new_xyz(0., 0., 1., None)
            } else {
                Self::new_xyz(1., 0., 0., None)
            };
            let cross = self.cross(&ref_point);
            Self::new_xyz(-self.y, self.x, cross.z.unwrap(), None)
        } else {
            Self::new_xy(-self.y, self.x, None)
        }
    }
}
impl<M: Clone, P: GetXYZ> From<&P> for VectorPoint<M> {
    fn from(p: &P) -> Self {
        Self { x: p.x(), y: p.y(), z: p.z(), m: None, t: None }
    }
}
impl<M: Clone> From<Point> for VectorPoint<M> {
    fn from(p: Point) -> Self {
        Self { x: p.0, y: p.1, z: None, m: None, t: None }
    }
}
impl<M: Clone> From<Point3D> for VectorPoint<M> {
    fn from(p: Point3D) -> Self {
        Self { x: p.0, y: p.1, z: Some(p.2), m: None, t: None }
    }
}
impl<M1: Clone, M2: Clone> Add<&VectorPoint<M2>> for &VectorPoint<M1> {
    type Output = VectorPoint<M1>;
    fn add(self, other: &VectorPoint<M2>) -> Self::Output {
        VectorPoint {
            x: self.x + other.x,
            y: self.y + other.y,
            // Only add `z` if both `self.z` and `other.z` are `Some`
            z: match (self.z, other.z) {
                (Some(z1), Some(z2)) => Some(z1 + z2),
                _ => None, // If either `z` is None, the result is `None`
            },
            m: None, // Combine m values
            t: None, // Handle `t` as necessary
        }
    }
}
impl<M1: Clone, M2: Clone> AddAssign<&VectorPoint<M2>> for VectorPoint<M1> {
    fn add_assign(&mut self, other: &VectorPoint<M2>) {
        self.x += other.x;
        self.y += other.y;
        if let (Some(z), Some(other_z)) = (self.z, other.z) {
            self.z = Some(z + other_z);
        }
    }
}
impl<M: Clone> Add<f64> for &VectorPoint<M> {
    type Output = VectorPoint<M>;
    fn add(self, other: f64) -> Self::Output {
        VectorPoint {
            x: self.x + other,
            y: self.y + other,
            z: self.z.map(|z| z + other),
            m: None,
            t: None,
        }
    }
}
impl<M: Clone> AddAssign<f64> for VectorPoint<M> {
    fn add_assign(&mut self, other: f64) {
        self.x += other;
        self.y += other;
        if let Some(z) = self.z {
            self.z = Some(z + other);
        }
    }
}
// Implementing the Sub trait for VectorPoint
impl<M1: Clone, M2: Clone> Sub<&VectorPoint<M2>> for &VectorPoint<M1> {
    type Output = VectorPoint<M1>;
    fn sub(self, other: &VectorPoint<M2>) -> Self::Output {
        VectorPoint {
            x: self.x - other.x,
            y: self.y - other.y,
            z: match (self.z, other.z) {
                (Some(z1), Some(z2)) => Some(z1 - z2),
                _ => None, // If either `z` is None, the result is `None`
            },
            m: None, // Combine m values
            t: None, // Handle `t` as necessary
        }
    }
}
impl<M1: Clone, M2: Clone> SubAssign<&VectorPoint<M2>> for VectorPoint<M1> {
    fn sub_assign(&mut self, other: &VectorPoint<M2>) {
        self.x -= other.x;
        self.y -= other.y;
        if let (Some(z), Some(other_z)) = (self.z, other.z) {
            self.z = Some(z - other_z);
        }
    }
}
impl<M: Clone> Sub<f64> for &VectorPoint<M> {
    type Output = VectorPoint<M>;
    fn sub(self, other: f64) -> Self::Output {
        VectorPoint {
            x: self.x - other,
            y: self.y - other,
            z: self.z.map(|z| z - other),
            m: None,
            t: None,
        }
    }
}
impl<M: Clone> SubAssign<f64> for VectorPoint<M> {
    fn sub_assign(&mut self, other: f64) {
        self.x -= other;
        self.y -= other;
        if let Some(z) = self.z {
            self.z = Some(z - other);
        }
    }
}
// Implementing the Neg trait for VectorPoint
impl<M: Clone> Neg for &VectorPoint<M> {
    type Output = VectorPoint<M>;
    fn neg(self) -> Self::Output {
        VectorPoint { x: -self.x, y: -self.y, z: self.z.map(|z| -z), m: None, t: None }
    }
}
// Implementing the Div trait for VectorPoint
impl<M1: Clone, M2: Clone> Div<&VectorPoint<M2>> for &VectorPoint<M1> {
    type Output = VectorPoint<M1>;
    fn div(self, other: &VectorPoint<M2>) -> Self::Output {
        VectorPoint {
            x: self.x / other.x,
            y: self.y / other.y,
            z: match (self.z, other.z) {
                (Some(z1), Some(z2)) => Some(z1 / z2),
                _ => None, // If either `z` is None, the result is `None`
            },
            m: None, // Combine m values
            t: None, // Handle `t` as necessary
        }
    }
}
impl<M1: Clone, M2: Clone> DivAssign<&VectorPoint<M2>> for VectorPoint<M1> {
    fn div_assign(&mut self, other: &VectorPoint<M2>) {
        self.x /= other.x;
        self.y /= other.y;
        if let (Some(z), Some(other_z)) = (self.z, other.z) {
            self.z = Some(z / other_z);
        }
    }
}
impl<M: Clone> Div<f64> for &VectorPoint<M> {
    type Output = VectorPoint<M>;
    fn div(self, other: f64) -> Self::Output {
        VectorPoint {
            x: self.x / other,
            y: self.y / other,
            z: self.z.map(|z| z / other),
            m: None,
            t: None,
        }
    }
}
impl<M: Clone> DivAssign<f64> for VectorPoint<M> {
    fn div_assign(&mut self, other: f64) {
        self.x /= other;
        self.y /= other;
        if let Some(z) = self.z {
            self.z = Some(z / other);
        }
    }
}
// Implementing the Mul trait for VectorPoint
impl<M1: Clone, M2: Clone> Mul<&VectorPoint<M2>> for &VectorPoint<M1> {
    type Output = VectorPoint<M1>;
    fn mul(self, other: &VectorPoint<M2>) -> Self::Output {
        VectorPoint {
            x: self.x * other.x,
            y: self.y * other.y,
            z: match (self.z, other.z) {
                (Some(z1), Some(z2)) => Some(z1 * z2),
                _ => None, // If either `z` is None, the result is `None`
            },
            m: None, // Combine m values
            t: None, // Handle `t` as necessary
        }
    }
}
impl<M1: Clone, M2: Clone> MulAssign<&VectorPoint<M2>> for VectorPoint<M1> {
    fn mul_assign(&mut self, other: &VectorPoint<M2>) {
        self.x *= other.x;
        self.y *= other.y;
        if let (Some(z), Some(other_z)) = (self.z, other.z) {
            self.z = Some(z * other_z);
        }
    }
}
impl<M: Clone> Mul<f64> for &VectorPoint<M> {
    type Output = VectorPoint<M>;
    fn mul(self, other: f64) -> Self::Output {
        VectorPoint {
            x: self.x * other,
            y: self.y * other,
            z: self.z.map(|z| z * other),
            m: None,
            t: None,
        }
    }
}
impl<M: Clone> MulAssign<f64> for VectorPoint<M> {
    fn mul_assign(&mut self, other: f64) {
        self.x *= other;
        self.y *= other;
        if let Some(z) = self.z {
            self.z = Some(z * other);
        }
    }
}
impl<M: Clone> Rem<f64> for VectorPoint<M> {
    type Output = VectorPoint<M>;

    fn rem(self, modulus: f64) -> Self::Output {
        self.modulo(modulus)
    }
}
impl<M: Clone> RemAssign<f64> for VectorPoint<M> {
    fn rem_assign(&mut self, modulus: f64) {
        let modulus = fabs(modulus);
        self.x = fmod(self.x, modulus);
        self.y = fmod(self.y, modulus);
        if let Some(z) = self.z {
            self.z = Some(fmod(z, modulus));
        }
    }
}
impl<M: Clone> Eq for VectorPoint<M> {}
impl<M: Clone> Ord for VectorPoint<M> {
    fn cmp(&self, other: &VectorPoint<M>) -> Ordering {
        match self.x.partial_cmp(&other.x) {
            Some(Ordering::Equal) => {}
            other => return other.unwrap_or(Ordering::Greater), /* Handle cases where `x` comparison is not equal */
        }
        match self.y.partial_cmp(&other.y) {
            Some(Ordering::Equal) => {}
            other => return other.unwrap_or(Ordering::Greater), /* Handle cases where `y` comparison is not equal */
        }
        match self.z.partial_cmp(&other.z) {
            Some(order) => order,
            None => Ordering::Equal, // This handles the NaN case safely
        }
    }
}
impl<M: Clone> PartialEq for VectorPoint<M> {
    fn eq(&self, other: &VectorPoint<M>) -> bool {
        self.x == other.x && self.y == other.y && self.z == other.z
    }
}
impl<M: Clone> PartialOrd for VectorPoint<M> {
    fn partial_cmp(&self, other: &VectorPoint<M>) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}