siderust 0.7.0

// SPDX-License-Identifier: AGPL-3.0-or-later
// Copyright (C) 2026 Vallés Puig, Ramon

//! # VSOP87A Heliocentric Rectangular Coordinates (Generated Data)
//!
//! ## Scientific scope
//!
//! This file contains the machine-generated coefficient tables for the
//! VSOP87A solution: heliocentric ecliptic rectangular coordinates
//! (X, Y, Z) for all eight major planets, referred to the mean ecliptic
//! and equinox of J2000.0.
//!
//! Time argument `T` is Julian millennia from J2000.0 (TDB).
//! Positions are in **astronomical units** (AU).
//!
//! ## Technical scope
//!
//! - One `impl <Planet>` block per planet, each providing methods
//!   `vsop87a_x`, `vsop87a_y`, `vsop87a_z`.
//! - Each method delegates to [`super::vsop87_impl::position`] with
//!   the planet-specific coefficient slices.
//! - The top-level `vsop87a` method on each planet is generated by the
//!   `impl_vsop87_for_planet!` macro in `vsop87_trait.rs`.
//! - Coefficient source: original VSOP87A data file from the IMCCE archive.
//!
//! ## References
//!
//! - Bretagnon, P., & Francou, G. (1988). "Planetary theories in rectangular
//!   and spherical variables: VSOP87 solutions".
//!   *Astronomy and Astrophysics* 202, 309–315.
//! - IMCCE VSOP87 coefficient archive:
//!   <https://www.imcce.fr/inpop/ephemerides/vsop87/>

use super::*;
use crate::bodies::solar_system::Moon;
use crate::bodies::solar_system::*;
use crate::coordinates::{
    cartesian::{Position, Velocity},
    centers::Heliocentric,
    frames::EclipticMeanJ2000,
};
use crate::qtty::*;
use crate::time::JulianDate;
type AuPerDay = crate::qtty::Per<AstronomicalUnit, Day>;

#[allow(clippy::approx_constant)]
#[rustfmt::skip]
mod vsop_data {
    include!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/archive/vsop87a.rs"));
}
use vsop_data::*;

macro_rules! impl_vsop87a {
    (
        $Planet:ident,
        x: [$($x:ident),+ $(,)?],
        y: [$($y:ident),+ $(,)?],
        z: [$($z:ident),+ $(,)?]
    ) => {
        impl $Planet {
            pub fn vsop87a(jd: JulianDate) -> Position<Heliocentric, EclipticMeanJ2000, AstronomicalUnit> {
                let (x, y, z) = position(
                    jd,
                    &[$( &$x ),+],
                    &[$( &$y ),+],
                    &[$( &$z ),+]
                );
                Position::new(
                    AstronomicalUnits::new(x),
                    AstronomicalUnits::new(y),
                    AstronomicalUnits::new(z),
                )
            }

            pub fn vsop87a_vel(jd: JulianDate) -> Velocity<EclipticMeanJ2000, AuPerDay> {
                let (vx, vy, vz) = velocity(
                    jd,
                    &[$( &$x ),+],
                    &[$( &$y ),+],
                    &[$( &$z ),+]
                );
                Velocity::new(
                    crate::qtty::velocity::Velocity::<AstronomicalUnit, Day>::new(vx),
                    crate::qtty::velocity::Velocity::<AstronomicalUnit, Day>::new(vy),
                    crate::qtty::velocity::Velocity::<AstronomicalUnit, Day>::new(vz)
                )
            }

            pub fn vsop87a_pos_vel(jd: JulianDate)
                -> (Position<Heliocentric, EclipticMeanJ2000, AstronomicalUnit>, Velocity<EclipticMeanJ2000, AuPerDay>) {
                let ((x, y, z), (vx, vy, vz)) = position_velocity(
                    jd,
                    &[$( &$x ),+],
                    &[$( &$y ),+],
                    &[$( &$z ),+]
                );
                (
                    Position::new(
                        AstronomicalUnits::new(x),
                        AstronomicalUnits::new(y),
                        AstronomicalUnits::new(z),
                    ),
                    Velocity::new(
                        crate::qtty::velocity::Velocity::<AstronomicalUnit, Day>::new(vx),
                        crate::qtty::velocity::Velocity::<AstronomicalUnit, Day>::new(vy),
                        crate::qtty::velocity::Velocity::<AstronomicalUnit, Day>::new(vz))
                )
            }
        }
    };
}

impl_vsop87a!(
    Mercury,
    x: [MERCURY_X0, MERCURY_X1, MERCURY_X2, MERCURY_X3, MERCURY_X4, MERCURY_X5],
    y: [MERCURY_Y0, MERCURY_Y1, MERCURY_Y2, MERCURY_Y3, MERCURY_Y4, MERCURY_Y5],
    z: [MERCURY_Z0, MERCURY_Z1, MERCURY_Z2, MERCURY_Z3, MERCURY_Z4, MERCURY_Z5]
);

impl_vsop87a!(
    Venus,
    x: [VENUS_X0, VENUS_X1, VENUS_X2, VENUS_X3, VENUS_X4, VENUS_X5],
    y: [VENUS_Y0, VENUS_Y1, VENUS_Y2, VENUS_Y3, VENUS_Y4, VENUS_Y5],
    z: [VENUS_Z0, VENUS_Z1, VENUS_Z2, VENUS_Z3, VENUS_Z4, VENUS_Z5]
);

impl_vsop87a!(
    Earth,
    x: [EARTH_X0, EARTH_X1, EARTH_X2, EARTH_X3, EARTH_X4, EARTH_X5],
    y: [EARTH_Y0, EARTH_Y1, EARTH_Y2, EARTH_Y3, EARTH_Y4, EARTH_Y5],
    z: [EARTH_Z0, EARTH_Z1, EARTH_Z2, EARTH_Z3, EARTH_Z4, EARTH_Z5]
);

impl_vsop87a!(
    Mars,
    x: [MARS_X0, MARS_X1, MARS_X2, MARS_X3, MARS_X4, MARS_X5],
    y: [MARS_Y0, MARS_Y1, MARS_Y2, MARS_Y3, MARS_Y4, MARS_Y5],
    z: [MARS_Z0, MARS_Z1, MARS_Z2, MARS_Z3, MARS_Z4, MARS_Z5]
);

impl_vsop87a!(
    Jupiter,
    x: [JUPITER_X0, JUPITER_X1, JUPITER_X2, JUPITER_X3, JUPITER_X4, JUPITER_X5],
    y: [JUPITER_Y0, JUPITER_Y1, JUPITER_Y2, JUPITER_Y3, JUPITER_Y4, JUPITER_Y5],
    z: [JUPITER_Z0, JUPITER_Z1, JUPITER_Z2, JUPITER_Z3, JUPITER_Z4, JUPITER_Z5]
);

impl_vsop87a!(
    Saturn,
    x: [SATURN_X0, SATURN_X1, SATURN_X2, SATURN_X3, SATURN_X4, SATURN_X5],
    y: [SATURN_Y0, SATURN_Y1, SATURN_Y2, SATURN_Y3, SATURN_Y4, SATURN_Y5],
    z: [SATURN_Z0, SATURN_Z1, SATURN_Z2, SATURN_Z3, SATURN_Z4, SATURN_Z5]
);

impl_vsop87a!(
    Uranus,
    x: [URANUS_X0, URANUS_X1, URANUS_X2, URANUS_X3, URANUS_X4],
    y: [URANUS_Y0, URANUS_Y1, URANUS_Y2, URANUS_Y3, URANUS_Y4],
    z: [URANUS_Z0, URANUS_Z1, URANUS_Z2, URANUS_Z3]
);

impl_vsop87a!(
    Neptune,
    x: [NEPTUNE_X0, NEPTUNE_X1, NEPTUNE_X2, NEPTUNE_X3, NEPTUNE_X4],
    y: [NEPTUNE_Y0, NEPTUNE_Y1, NEPTUNE_Y2, NEPTUNE_Y3, NEPTUNE_Y4],
    z: [NEPTUNE_Z0, NEPTUNE_Z1, NEPTUNE_Z2, NEPTUNE_Z3]
);

impl_vsop87a!(
    Moon,
    x: [EMB_X0, EMB_X1, EMB_X2, EMB_X3, EMB_X4, EMB_X5],
    y: [EMB_Y0, EMB_Y1, EMB_Y2, EMB_Y3, EMB_Y4, EMB_Y5],
    z: [EMB_Z0, EMB_Z1, EMB_Z2, EMB_Z3, EMB_Z4, EMB_Z5]
);

#[cfg(test)]
mod tests {
    use super::*;
    use crate::coordinates::cartesian::Position;
    use crate::macros::assert_cartesian_eq;
    use crate::qtty::AU;
    use crate::time::JulianDate;

    const PRECISION: f64 = 1e-6;

    /// Mercury heliocentric (ecliptic J2000) at epoch J2000.0 (JD_TDB = 2451545.0)
    #[test]
    fn test_mercury_at_epoch() {
        let coord = Mercury::vsop87a(JulianDate::J2000);
        assert_cartesian_eq!(
            coord,
            Position::new(-0.1300934115 * AU, -0.4472876716 * AU, -0.0245983802 * AU),
            PRECISION
        );
    }

    /// Venus heliocentric (ecliptic J2000) at epoch J2000.0
    #[test]
    fn test_venus_at_epoch() {
        let coord = Venus::vsop87a(JulianDate::J2000);
        assert_cartesian_eq!(
            coord,
            Position::new(-0.7183022797 * AU, -0.0326546017 * AU, 0.0410142975 * AU),
            PRECISION
        );
    }

    /// Test Earth's heliocentric coordinates at epoch J2000.0
    #[test]
    fn test_earth_at_epoch() {
        let coord = Earth::vsop87a(JulianDate::J2000);
        assert_cartesian_eq!(
            coord,
            Position::new(-0.1771354586 * AU, 0.9672416237 * AU, -0.0000039000 * AU),
            PRECISION
        );
    }

    /// Mars heliocentric (ecliptic J2000) at epoch J2000.0
    #[test]
    fn test_mars_at_epoch() {
        let coord = Mars::vsop87a(JulianDate::J2000);
        assert_cartesian_eq!(
            coord,
            Position::new(1.3907159264 * AU, -0.0134157043 * AU, -0.0344677967 * AU),
            PRECISION
        );
    }

    /// Jupiter heliocentric (ecliptic J2000) at epoch J2000.0
    #[test]
    fn test_jupiter_at_epoch() {
        let coord = Jupiter::vsop87a(JulianDate::J2000);
        assert_cartesian_eq!(
            coord,
            Position::new(4.0011740268 * AU, 2.9385810077 * AU, -0.1017837501 * AU),
            PRECISION
        );
    }

    /// Saturn heliocentric (ecliptic J2000) at epoch J2000.0
    #[test]
    fn test_saturn_at_epoch() {
        let coord = Saturn::vsop87a(JulianDate::J2000);
        assert_cartesian_eq!(
            coord,
            Position::new(6.4064068573 * AU, 6.5699929449 * AU, -0.3690768029 * AU),
            PRECISION
        );
    }

    /// Uranus heliocentric (ecliptic J2000) at epoch J2000.0
    #[test]
    fn test_uranus_at_epoch() {
        let coord = Uranus::vsop87a(JulianDate::J2000);
        assert_cartesian_eq!(
            coord,
            Position::new(14.4318934159 * AU, -13.7343162527 * AU, -0.2381421963 * AU),
            PRECISION
        );
    }

    /// Neptune heliocentric (ecliptic J2000) at epoch J2000.0
    #[test]
    fn test_neptune_at_epoch() {
        let coord = Neptune::vsop87a(JulianDate::J2000);
        assert_cartesian_eq!(
            coord,
            Position::new(16.8121116576 * AU, -24.9916630908 * AU, 0.1272190171 * AU),
            PRECISION
        );
    }

    macro_rules! test_vel_and_pos_vel {
        ($body:ident) => {{
            let jd = JulianDate::J2000;
            let pos = $body::vsop87a(jd);
            let vel = $body::vsop87a_vel(jd);
            let (pos2, vel2) = $body::vsop87a_pos_vel(jd);

            assert_cartesian_eq!(pos, pos2, PRECISION);
            assert!(
                (vel.x() - vel2.x()).abs()
                    < crate::qtty::velocity::Velocity::<AstronomicalUnit, Day>::new(PRECISION)
            );
            assert!(
                (vel.y() - vel2.y()).abs()
                    < crate::qtty::velocity::Velocity::<AstronomicalUnit, Day>::new(PRECISION)
            );
            assert!(
                (vel.z() - vel2.z()).abs()
                    < crate::qtty::velocity::Velocity::<AstronomicalUnit, Day>::new(PRECISION)
            );
        }};
    }

    #[test]
    fn test_vsop87a_velocity_and_combined() {
        use crate::qtty::*;
        test_vel_and_pos_vel!(Mercury);
        test_vel_and_pos_vel!(Venus);
        test_vel_and_pos_vel!(Earth);
        test_vel_and_pos_vel!(Mars);
        test_vel_and_pos_vel!(Jupiter);
        test_vel_and_pos_vel!(Saturn);
        test_vel_and_pos_vel!(Uranus);
        test_vel_and_pos_vel!(Neptune);
        test_vel_and_pos_vel!(Moon);
    }
}