lox-time 0.1.0-alpha.21

Time modelling tools for the Lox ecosystem
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

// SPDX-FileCopyrightText: 2024 Angus Morrison <github@angus-morrison.com>
// SPDX-FileCopyrightText: 2024 Helge Eichhorn <git@helgeeichhorn.de>
//
// SPDX-License-Identifier: MPL-2.0

//! Mod `pre1972` exposes functions for interpolating the UTC-TAI delta for dates between
//! 1960-01-01 and 1972-01-01, during which there are 10 leap seconds distributed by a linear
//! function.
//!
//! Data sourced from ftp://maia.usno.navy.mil/ser7/tai-utc.dat.

use lox_core::f64::consts::SECONDS_PER_DAY;
use lox_core::math::slices::Monotonic;

use crate::deltas::{TimeDelta, ToDelta};
use crate::julian_dates::Epoch::ModifiedJulianDate;
use crate::julian_dates::JulianDate;
use crate::julian_dates::Unit::Days;
use crate::time::Time;
use crate::time_scales::Tai;
use crate::utc::Utc;

const EPOCHS: [u64; 14] = [
    36934, 37300, 37512, 37665, 38334, 38395, 38486, 38639, 38761, 38820, 38942, 39004, 39126,
    39887,
];

const OFFSETS: [f64; 14] = [
    1.417818, 1.422818, 1.372818, 1.845858, 1.945858, 3.240130, 3.340130, 3.440130, 3.540130,
    3.640130, 3.740130, 3.840130, 4.313170, 4.213170,
];

const DRIFT_EPOCHS: [u64; 14] = [
    37300, 37300, 37300, 37665, 37665, 38761, 38761, 38761, 38761, 38761, 38761, 38761, 39126,
    39126,
];

const DRIFT_RATES: [f64; 14] = [
    0.0012960, 0.0012960, 0.0012960, 0.0011232, 0.0011232, 0.0012960, 0.0012960, 0.0012960,
    0.0012960, 0.0012960, 0.0012960, 0.0012960, 0.0025920, 0.0025920,
];

/// UTC minus TAI. Returns [TimeDelta::ZERO] for dates before the pre-1972 table (i.e. before 1960).
pub fn delta_utc_tai(utc: &Utc) -> TimeDelta {
    // Invariant: EPOCHS must be sorted for the search below to work
    debug_assert!(&EPOCHS.is_strictly_increasing());

    let mjd = utc.to_delta().days_since_modified_julian_epoch();
    if mjd < EPOCHS[0] as f64 {
        return TimeDelta::ZERO;
    }
    let threshold = mjd.floor() as u64;
    let position = EPOCHS
        .iter()
        .rposition(|item| item <= &threshold)
        .expect("threshold is >= EPOCHS[0]");
    let raw_delta =
        OFFSETS[position] + (mjd - DRIFT_EPOCHS[position] as f64) * DRIFT_RATES[position];
    let delta = TimeDelta::from_seconds_f64(raw_delta);

    -delta
}

/// TAI minus UTC. Returns [TimeDelta::ZERO] for dates before the pre-1972 table (i.e. before 1960).
pub fn delta_tai_utc(tai: &Time<Tai>) -> TimeDelta {
    // Invariant: EPOCHS must be sorted for the search below to work
    debug_assert!(&EPOCHS.is_strictly_increasing());

    let mjd = tai.julian_date(ModifiedJulianDate, Days);
    if mjd < EPOCHS[0] as f64 {
        return TimeDelta::ZERO;
    }
    let threshold = mjd.floor() as u64;
    let position = EPOCHS
        .iter()
        .rposition(|item| item <= &threshold)
        .expect("threshold is >= EPOCHS[0]");
    let rate_utc = DRIFT_RATES[position] / SECONDS_PER_DAY;
    let rate_tai = rate_utc / (1.0 + rate_utc) * SECONDS_PER_DAY;
    let offset = OFFSETS[position];
    let dt = mjd - DRIFT_EPOCHS[position] as f64 - offset / SECONDS_PER_DAY;
    let raw_delta = offset + dt * rate_tai;
    TimeDelta::from_seconds_f64(raw_delta)
}