lox_time/

offsets.rs

// SPDX-FileCopyrightText: 2024 Helge Eichhorn <git@helgeeichhorn.de>
//
// SPDX-License-Identifier: MPL-2.0

use std::convert::Infallible;

use crate::Time;
use crate::deltas::TimeDelta;
use crate::time_scales::{Tai, TimeScale};
use crate::utc::Utc;
use crate::utc::leap_seconds::{DefaultLeapSecondsProvider, LeapSecondsProvider};

mod impls;

/// Fallible time scale offset computation.
pub trait TryOffset<Origin, Target>
where
    Origin: TimeScale,
    Target: TimeScale,
{
    /// The error type returned when the offset cannot be computed.
    type Error: std::error::Error + Send + Sync + 'static;

    /// Computes the offset from `origin` to `target` at the given `delta` since J2000.
    fn try_offset(
        &self,
        origin: Origin,
        target: Target,
        delta: TimeDelta,
    ) -> Result<TimeDelta, Self::Error>;
}

/// Infallible time scale offset computation.
pub trait Offset<Origin, Target>
where
    Origin: TimeScale,
    Target: TimeScale,
{
    /// Computes the offset from `origin` to `target` at the given `delta` since J2000.
    fn offset(&self, origin: Origin, target: Target, delta: TimeDelta) -> TimeDelta;
}

impl<T, Origin, Target> Offset<Origin, Target> for T
where
    Origin: TimeScale,
    Target: TimeScale,
    T: TryOffset<Origin, Target, Error = Infallible>,
{
    fn offset(&self, origin: Origin, target: Target, delta: TimeDelta) -> TimeDelta {
        self.try_offset(origin, target, delta).unwrap()
    }
}

/// Provides time scale offset computations for all supported scale pairs.
pub trait OffsetProvider {
    /// The error type for fallible offset computations (e.g. UT1).
    type Error: std::error::Error + Send + Sync + 'static;

    /// Returns the TAI→UT1 offset at the given delta.
    fn tai_to_ut1(&self, delta: TimeDelta) -> Result<TimeDelta, Self::Error>;
    /// Returns the UT1→TAI offset at the given delta.
    fn ut1_to_tai(&self, delta: TimeDelta) -> Result<TimeDelta, Self::Error>;

    /// Returns the constant TAI→TT offset.
    fn tai_to_tt(&self) -> TimeDelta {
        D_TAI_TT
    }

    /// Returns the constant TT→TAI offset.
    fn tt_to_tai(&self) -> TimeDelta {
        -D_TAI_TT
    }

    /// Returns the constant TAI→GPS offset.
    fn tai_to_gps(&self) -> TimeDelta {
        D_TAI_GPS
    }

    /// Returns the constant GPS→TAI offset.
    fn gps_to_tai(&self) -> TimeDelta {
        -D_TAI_GPS
    }

    /// Returns the TT→TCG offset at the given delta.
    fn tt_to_tcg(&self, delta: TimeDelta) -> TimeDelta {
        tt_to_tcg(delta)
    }

    /// Returns the TCG→TT offset at the given delta.
    fn tcg_to_tt(&self, delta: TimeDelta) -> TimeDelta {
        tcg_to_tt(delta)
    }

    /// Returns the TDB→TCB offset at the given delta.
    fn tdb_to_tcb(&self, delta: TimeDelta) -> TimeDelta {
        tdb_to_tcb(delta)
    }

    /// Returns the TCB→TDB offset at the given delta.
    fn tcb_to_tdb(&self, delta: TimeDelta) -> TimeDelta {
        tcb_to_tdb(delta)
    }

    /// Returns the TT→TDB offset at the given delta.
    fn tt_to_tdb(&self, delta: TimeDelta) -> TimeDelta {
        tt_to_tdb(delta)
    }

    /// Returns the TDB→TT offset at the given delta.
    fn tdb_to_tt(&self, delta: TimeDelta) -> TimeDelta {
        tdb_to_tt(delta)
    }
}

/// Default offset provider using built-in leap second tables and standard algorithms.
#[derive(Debug, Clone, Copy, Default)]
pub struct DefaultOffsetProvider;

impl LeapSecondsProvider for DefaultOffsetProvider {}

impl OffsetProvider for DefaultOffsetProvider {
    type Error = Infallible;

    fn tai_to_ut1(&self, delta: TimeDelta) -> Result<TimeDelta, Self::Error> {
        let Some(_) = delta.seconds() else {
            return Ok(TimeDelta::ZERO);
        };
        let tai = Time::from_delta(Tai, delta);
        Ok(DefaultLeapSecondsProvider.delta_tai_utc(tai))
    }

    fn ut1_to_tai(&self, delta: TimeDelta) -> Result<TimeDelta, Self::Error> {
        let Ok(utc) = Utc::from_delta(delta) else {
            return Ok(TimeDelta::ZERO);
        };
        Ok(DefaultLeapSecondsProvider.delta_utc_tai(utc))
    }
}

// TAI <-> TT

/// The constant offset between TAI and TT.
pub const D_TAI_TT: TimeDelta = TimeDelta::builder().seconds(32).milliseconds(184).build();

// TAI <-> GPS

/// Constant offset from TAI to GPS time: `GPS = TAI − 19s`.
///
/// This is the value added when converting TAI to GPS (negative 19
/// seconds, since GPS-time labels are 19 seconds less than the
/// corresponding TAI-time labels).
pub const D_TAI_GPS: TimeDelta = TimeDelta::builder().seconds(-19).build();

// TT <-> TCG

/// The difference between J2000 TT and 1977 January 1.0 TAI as TT.
const J77_TT: TimeDelta = TimeDelta::builder()
    .seconds(-725803167)
    .milliseconds(816)
    .build();

/// The rate of change of TCG with respect to TT.
const LG: f64 = 6.969290134e-10;

/// The rate of change of TT with respect to TCG.
const INV_LG: f64 = LG / (1.0 - LG);

fn tt_to_tcg(delta: TimeDelta) -> TimeDelta {
    INV_LG * (delta - J77_TT)
}

fn tcg_to_tt(delta: TimeDelta) -> TimeDelta {
    -LG * (delta - J77_TT)
}

// TDB <-> TCB

/// The rate of change of TDB with respect to TCB.
const LB: f64 = 1.550519768e-8;

/// The rate of change of TCB with respect to TDB.
const INV_LB: f64 = LB / (1.0 - LB);

/// Scale factor for TDB to TCB constant term: 1 / (1 - LB).
const ONE_MINUS_LB_INV: f64 = 1.0 / (1.0 - LB);

/// Constant term of TDB − TT formula of Fairhead & Bretagnon (1990).
// const TDB_0: f64 = -6.55e-5;
const TDB_0: TimeDelta = TimeDelta::builder()
    .seconds(0)
    .microseconds(65)
    .nanoseconds(500)
    .negative()
    .build();

const TCB_77: TimeDelta = TDB_0.add_const(J77_TT.mul_const(LB));

fn tdb_to_tcb(delta: TimeDelta) -> TimeDelta {
    INV_LB * delta - ONE_MINUS_LB_INV * TCB_77
}

fn tcb_to_tdb(delta: TimeDelta) -> TimeDelta {
    TCB_77 - LB * delta
}

// TT <-> TDB

const K: f64 = 1.657e-3;
const EB: f64 = 1.671e-2;
const M_0: f64 = 6.239996;
const M_1: f64 = 1.99096871e-7;

fn tt_to_tdb(delta: TimeDelta) -> TimeDelta {
    let tt = delta.to_seconds().to_f64();
    let g = M_0 + M_1 * tt;
    TimeDelta::from_seconds_f64(K * (g + EB * g.sin()).sin())
}

fn tdb_to_tt(delta: TimeDelta) -> TimeDelta {
    let tdb = delta.to_seconds().to_f64();
    let mut offset = 0.0;
    for _ in 1..3 {
        let g = M_0 + M_1 * (tdb + offset);
        offset = -K * (g + EB * g.sin()).sin();
    }
    TimeDelta::from_seconds_f64(offset)
}

// Two-step transformations

fn two_step_offset<P, T1, T2, T3>(
    provider: &P,
    origin: T1,
    via: T2,
    target: T3,
    delta: TimeDelta,
) -> TimeDelta
where
    T1: TimeScale,
    T2: TimeScale + Copy,
    T3: TimeScale,
    P: Offset<T1, T2> + Offset<T2, T3>,
{
    let mut offset = provider.offset(origin, via, delta);
    offset += provider.offset(via, target, delta + offset);
    offset
}

#[cfg(test)]
mod tests {
    use lox_test_utils::assert_approx_eq;
    use rstest::rstest;

    use super::*;
    use crate::offsets::TryOffset;
    use crate::time_scales::DynTimeScale;
    use crate::{DynTime, calendar_dates::Date, deltas::ToDelta, time_of_day::TimeOfDay};

    const DEFAULT_TOL: f64 = 1e-7;
    const TCB_TOL: f64 = 1e-4;

    // Reference values from Orekit
    //
    // Since we use different algorithms for TCB and UT1 we need to
    // adjust the tolerances accordingly.
    //
    #[rstest]
    #[case::tai_tai("TAI", "TAI", 0.0, None)]
    #[case::tai_tcb("TAI", "TCB", 55.66851419888016, Some(TCB_TOL))]
    #[case::tai_tcg("TAI", "TCG", 33.239589335894145, None)]
    #[case::tai_tdb("TAI", "TDB", 32.183882324981056, None)]
    #[case::tai_tt("TAI", "TT", 32.184, None)]
    #[case::tcb_tai("TCB", "TAI", -55.668513317090046, Some(TCB_TOL))]
    #[case::tcb_tcb("TCB", "TCB", 0.0, Some(TCB_TOL))]
    #[case::tcb_tcg("TCB", "TCG", -22.4289240199929, Some(TCB_TOL))]
    #[case::tcb_tdb("TCB", "TDB", -23.484631010747805, Some(TCB_TOL))]
    #[case::tcb_tt("TCB", "TT", -23.484513317090048, Some(TCB_TOL))]
    #[case::tcg_tai("TCG", "TAI", -33.23958931272851, None)]
    #[case::tcg_tcb("TCG", "TCB", 22.428924359636042, Some(TCB_TOL))]
    #[case::tcg_tcg("TCG", "TCG", 0.0, None)]
    #[case::tcg_tdb("TCG", "TDB", -1.0557069988766656, None)]
    #[case::tcg_tt("TCG", "TT", -1.0555893127285145, None)]
    #[case::tdb_tai("TDB", "TAI", -32.18388231420531, None)]
    #[case::tdb_tcb("TDB", "TCB", 23.48463137488165, Some(TCB_TOL))]
    #[case::tdb_tcg("TDB", "TCG", 1.0557069992589518, None)]
    #[case::tdb_tdb("TDB", "TDB", 0.0, None)]
    #[case::tdb_tt("TDB", "TT", 1.176857946845189E-4, None)]
    #[case::tt_tai("TT", "TAI", -32.184, None)]
    #[case::tt_tcb("TT", "TCB", 23.484513689085105, Some(TCB_TOL))]
    #[case::tt_tcg("TT", "TCG", 1.055589313464182, None)]
    #[case::tt_tdb("TT", "TDB", -1.1768579472004603E-4, None)]
    #[case::tt_tt("TT", "TT", 0.0, None)]
    fn test_dyn_time_scale_offsets_new(
        #[case] scale1: &str,
        #[case] scale2: &str,
        #[case] exp: f64,
        #[case] tol: Option<f64>,
    ) {
        let provider = &DefaultOffsetProvider;
        let scale1: DynTimeScale = scale1.parse().unwrap();
        let scale2: DynTimeScale = scale2.parse().unwrap();
        let date = Date::new(2024, 12, 30).unwrap();
        let time = TimeOfDay::from_hms(10, 27, 13.145).unwrap();
        let dt = DynTime::from_date_and_time(scale1, date, time)
            .unwrap()
            .to_delta();
        let act = provider
            .try_offset(scale1, scale2, dt)
            .unwrap()
            .to_seconds()
            .to_f64();
        assert_approx_eq!(act, exp, atol <= tol.unwrap_or(DEFAULT_TOL));
    }

    // Test round-trip conversions for reversibility
    #[rstest]
    #[case::tt_tcg_tt("TT", "TCG", 1e-15)]
    #[case::tcg_tt_tcg("TCG", "TT", 1e-15)]
    #[case::tdb_tcb_tdb("TDB", "TCB", 1e-14)]
    #[case::tcb_tdb_tcb("TCB", "TDB", 1e-14)]
    fn test_time_scale_roundtrip(#[case] scale1: &str, #[case] scale2: &str, #[case] tol: f64) {
        let provider = &DefaultOffsetProvider;
        let scale1: DynTimeScale = scale1.parse().unwrap();
        let scale2: DynTimeScale = scale2.parse().unwrap();
        let date = Date::new(2024, 12, 30).unwrap();
        let time = TimeOfDay::from_hms(10, 27, 13.145).unwrap();
        let original_delta = DynTime::from_date_and_time(scale1, date, time)
            .unwrap()
            .to_delta();

        // Forward conversion
        let offset1 = provider.try_offset(scale1, scale2, original_delta).unwrap();
        let intermediate_delta = original_delta + offset1;

        // Reverse conversion
        let offset2 = provider
            .try_offset(scale2, scale1, intermediate_delta)
            .unwrap();
        let final_delta = intermediate_delta + offset2;

        let diff = (final_delta - original_delta).to_seconds().to_f64().abs();
        assert!(
            diff < tol,
            "Round-trip conversion {} -> {} -> {} failed: difference = {:.2e} seconds, tolerance = {:.2e} seconds",
            scale1,
            scale2,
            scale1,
            diff,
            tol
        );
    }

    #[test]
    fn test_offset_constants() {
        let tdb_0 = TDB_0.to_seconds();
        assert!((tdb_0.to_f64() - (-6.55e-5)).abs() < 1e-15);

        let j77 = J77_TT.to_seconds();
        // For negative times, internal representation stores one less second
        // and a positive subsecond fraction: -725803167.816 = -725803168 + 0.184
        assert_eq!(j77.hi, -725803168.0);
        assert!((j77.lo - 0.184).abs() < 1e-15);
        // But the total should be correct
        assert!((j77.to_f64() - (-725803167.816)).abs() < 1e-9);
    }
}