tempoch-core 0.4.1

Core astronomical time primitives for tempoch.
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
// SPDX-License-Identifier: AGPL-3.0-only
// Copyright (C) 2026 Vallés Puig, Ramon

//! Time period / interval implementation.
//!
//! This module provides:
//! - [`Interval<T>`]: generic interval over any [`TimeInstant`]
//! - [`Period<S>`]: scale-based alias for `Interval<Time<S>>`

use super::{Time, TimeInstant, TimeScale};
use chrono::{DateTime, Utc};
use qtty::Days;
use std::fmt;

#[cfg(feature = "serde")]
use serde::{ser::SerializeStruct, Deserialize, Deserializer, Serialize, Serializer};

/// Error returned when a period time-scale conversion fails.
///
/// Currently the only failure mode is an out-of-range chrono conversion
/// (e.g. a Julian Date too far in the past/future for `DateTime<Utc>`).
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ConversionError {
    /// The time instant is outside the representable range of the target type.
    OutOfRange,
}

impl fmt::Display for ConversionError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ConversionError::OutOfRange => {
                write!(f, "time instant out of representable range for target type")
            }
        }
    }
}

impl std::error::Error for ConversionError {}

/// Error returned when constructing an [`Interval`] with invalid bounds.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum InvalidIntervalError {
    /// The start instant is after the end instant (`!(start <= end)`).
    ///
    /// This also triggers for `NaN` endpoints, since `NaN` comparisons
    /// always return `false`.
    StartAfterEnd,
}

impl fmt::Display for InvalidIntervalError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            InvalidIntervalError::StartAfterEnd => {
                write!(f, "interval start must not be after end")
            }
        }
    }
}

impl std::error::Error for InvalidIntervalError {}

/// Error indicating a period list violates sorted/non-overlapping invariants.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PeriodListError {
    /// An interval at the given index has `start > end`.
    InvalidInterval {
        /// Index of the malformed interval.
        index: usize,
    },
    /// The interval at the given index has a start time earlier than its predecessor.
    Unsorted {
        /// Index of the out-of-order interval.
        index: usize,
    },
    /// The interval at the given index overlaps with its predecessor.
    Overlapping {
        /// Index of the overlapping interval.
        index: usize,
    },
}

impl fmt::Display for PeriodListError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            PeriodListError::InvalidInterval { index } => {
                write!(f, "interval at index {index} has start > end")
            }
            PeriodListError::Unsorted { index } => {
                write!(f, "interval at index {index} is not sorted by start time")
            }
            PeriodListError::Overlapping { index } => {
                write!(f, "interval at index {index} overlaps with its predecessor")
            }
        }
    }
}

impl std::error::Error for PeriodListError {}

/// Target type adapter for [`Interval<Time<S>>::to`].
///
/// This allows converting a period of `Time<S>` either to another time scale
/// marker (`MJD`, `JD`, `UT`, ...) or directly to `chrono::DateTime<Utc>`.
pub trait PeriodTimeTarget<S: TimeScale> {
    type Instant: TimeInstant;

    fn convert(value: Time<S>) -> Result<Self::Instant, ConversionError>;
}

impl<S: TimeScale, T: TimeScale> PeriodTimeTarget<S> for T {
    type Instant = Time<T>;

    #[inline]
    fn convert(value: Time<S>) -> Result<Self::Instant, ConversionError> {
        Ok(value.to::<T>())
    }
}

impl<S: TimeScale, T: TimeScale> PeriodTimeTarget<S> for Time<T> {
    type Instant = Time<T>;

    #[inline]
    fn convert(value: Time<S>) -> Result<Self::Instant, ConversionError> {
        Ok(value.to::<T>())
    }
}

impl<S: TimeScale> PeriodTimeTarget<S> for DateTime<Utc> {
    type Instant = DateTime<Utc>;

    #[inline]
    fn convert(value: Time<S>) -> Result<Self::Instant, ConversionError> {
        value.to_utc().ok_or(ConversionError::OutOfRange)
    }
}

/// Target type adapter for [`Interval<DateTime<Utc>>::to`].
pub trait PeriodUtcTarget {
    type Instant: TimeInstant;

    fn convert(value: DateTime<Utc>) -> Self::Instant;
}

impl<S: TimeScale> PeriodUtcTarget for S {
    type Instant = Time<S>;

    #[inline]
    fn convert(value: DateTime<Utc>) -> Self::Instant {
        Time::<S>::from_utc(value)
    }
}

impl<S: TimeScale> PeriodUtcTarget for Time<S> {
    type Instant = Time<S>;

    #[inline]
    fn convert(value: DateTime<Utc>) -> Self::Instant {
        Time::<S>::from_utc(value)
    }
}

impl PeriodUtcTarget for DateTime<Utc> {
    type Instant = DateTime<Utc>;

    #[inline]
    fn convert(value: DateTime<Utc>) -> Self::Instant {
        value
    }
}

/// Represents an interval between two instants.
///
/// An `Interval` is defined by a start and end time instant of type `T`,
/// where `T` implements the `TimeInstant` trait. This allows for periods
/// defined in different time systems (Julian Date, Modified Julian Date, UTC, etc.).
///
/// # Examples
///
/// ```
/// # use tempoch_core as tempoch;
/// use tempoch::{Interval, ModifiedJulianDate};
///
/// let start = ModifiedJulianDate::new(59000.0);
/// let end = ModifiedJulianDate::new(59001.0);
/// let period = Interval::new(start, end);
///
/// // Duration in days
/// let duration = period.duration();
/// ```
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct Interval<T: TimeInstant> {
    pub start: T,
    pub end: T,
}

/// Time-scale period alias.
///
/// This follows the same marker pattern as [`Time<S>`], so callers can write:
/// `Period<MJD>`, `Period<JD>`, etc.
pub type Period<S> = Interval<Time<S>>;

/// UTC interval alias.
pub type UtcPeriod = Interval<DateTime<Utc>>;

impl<T: TimeInstant> Interval<T> {
    /// Creates a new period between two time instants.
    ///
    /// **Note:** this constructor does not validate that `start <= end`.
    /// Prefer [`try_new`](Self::try_new) when endpoints come from untrusted
    /// or computed input.
    ///
    /// # Arguments
    ///
    /// * `start` - The start time instant
    /// * `end` - The end time instant
    ///
    /// # Examples
    ///
    /// ```
    /// # use tempoch_core as tempoch;
    /// use tempoch::{Interval, JulianDate};
    ///
    /// let start = JulianDate::new(2451545.0);
    /// let end = JulianDate::new(2451546.0);
    /// let period = Interval::new(start, end);
    /// ```
    pub fn new(start: T, end: T) -> Self {
        Interval { start, end }
    }

    /// Creates a new interval, validating that `start <= end`.
    ///
    /// Returns [`InvalidIntervalError::StartAfterEnd`] if the start instant
    /// is after the end instant.  This also rejects `NaN`-based instants,
    /// since `NaN` comparisons always return `false`.
    ///
    /// # Examples
    ///
    /// ```
    /// # use tempoch_core as tempoch;
    /// use tempoch::{Interval, JulianDate};
    ///
    /// let ok = Interval::try_new(JulianDate::new(100.0), JulianDate::new(200.0));
    /// assert!(ok.is_ok());
    ///
    /// let err = Interval::try_new(JulianDate::new(200.0), JulianDate::new(100.0));
    /// assert!(err.is_err());
    /// ```
    pub fn try_new(start: T, end: T) -> Result<Self, InvalidIntervalError> {
        if start <= end {
            Ok(Interval { start, end })
        } else {
            Err(InvalidIntervalError::StartAfterEnd)
        }
    }

    /// Returns the duration of the period as the difference between end and start.
    ///
    /// # Examples
    ///
    /// ```
    /// # use tempoch_core as tempoch;
    /// use tempoch::{Interval, JulianDate};
    /// use qtty::Days;
    ///
    /// let start = JulianDate::new(2451545.0);
    /// let end = JulianDate::new(2451546.5);
    /// let period = Interval::new(start, end);
    ///
    /// let duration = period.duration();
    /// assert_eq!(duration, Days::new(1.5));
    /// ```
    pub fn duration(&self) -> T::Duration {
        self.end.difference(&self.start)
    }

    /// Returns the overlapping sub-period between `self` and `other`.
    ///
    /// Periods are treated as half-open ranges `[start, end)`: if one period
    /// ends exactly when the other starts, the intersection is empty and `None`
    /// is returned.
    pub fn intersection(&self, other: &Self) -> Option<Self> {
        let start = if self.start >= other.start {
            self.start
        } else {
            other.start
        };
        let end = if self.end <= other.end {
            self.end
        } else {
            other.end
        };

        if start < end {
            Some(Self::new(start, end))
        } else {
            None
        }
    }
}

// Display implementation
impl<T: TimeInstant + fmt::Display> fmt::Display for Interval<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{} to {}", self.start, self.end)
    }
}

impl<S: TimeScale> Interval<Time<S>> {
    /// Convert this period to another time scale.
    ///
    /// Each endpoint is converted preserving the represented absolute interval.
    ///
    /// Supported targets:
    /// - Any time-scale marker (`JD`, `MJD`, `UT`, ...)
    /// - `chrono::DateTime<Utc>`
    ///
    /// # Errors
    ///
    /// Returns [`ConversionError::OutOfRange`] if the endpoints fall outside
    /// the representable range of the target type (only possible when
    /// converting to `DateTime<Utc>`).
    ///
    /// # Examples
    ///
    /// ```
    /// use chrono::{DateTime, Utc};
    /// # use tempoch_core as tempoch;
    /// use tempoch::{Interval, JD, MJD, Period, Time};
    ///
    /// let period_jd = Period::new(Time::<JD>::new(2451545.0), Time::<JD>::new(2451546.0));
    /// let period_mjd = period_jd.to::<MJD>().unwrap();
    /// let _period_utc: Interval<DateTime<Utc>> = period_jd.to::<DateTime<Utc>>().unwrap();
    ///
    /// assert!((period_mjd.start.value() - 51544.5).abs() < 1e-12);
    /// assert!((period_mjd.end.value() - 51545.5).abs() < 1e-12);
    /// ```
    #[inline]
    pub fn to<Target>(
        &self,
    ) -> Result<Interval<<Target as PeriodTimeTarget<S>>::Instant>, ConversionError>
    where
        Target: PeriodTimeTarget<S>,
    {
        Ok(Interval::new(
            Target::convert(self.start)?,
            Target::convert(self.end)?,
        ))
    }
}

// Specific implementation for periods with Days duration (JD and MJD)
impl<T: TimeInstant<Duration = Days>> Interval<T> {
    /// Returns the duration of the period in days as a floating-point value.
    ///
    /// This method is available for time instants with `Days` as their duration type
    /// (e.g., `JulianDate` and `ModifiedJulianDate`).
    ///
    /// # Examples
    ///
    /// ```
    /// # use tempoch_core as tempoch;
    /// use tempoch::{Interval, ModifiedJulianDate};
    /// use qtty::Days;
    ///
    /// let start = ModifiedJulianDate::new(59000.0);
    /// let end = ModifiedJulianDate::new(59001.5);
    /// let period = Interval::new(start, end);
    ///
    /// assert_eq!(period.duration_days(), Days::new(1.5));
    /// ```
    pub fn duration_days(&self) -> Days {
        self.duration()
    }
}

// Specific implementation for UTC periods
impl Interval<DateTime<Utc>> {
    /// Convert this UTC interval to another target.
    ///
    /// Supported targets:
    /// - Any time-scale marker (`JD`, `MJD`, `UT`, ...)
    /// - Any `Time<...>` alias (`JulianDate`, `ModifiedJulianDate`, ...)
    /// - `chrono::DateTime<Utc>`
    #[inline]
    pub fn to<Target>(&self) -> Interval<<Target as PeriodUtcTarget>::Instant>
    where
        Target: PeriodUtcTarget,
    {
        Interval::new(Target::convert(self.start), Target::convert(self.end))
    }

    /// Returns the duration in days as a floating-point value.
    ///
    /// This converts the chrono::Duration to days.
    pub fn duration_days(&self) -> f64 {
        const NANOS_PER_DAY: f64 = 86_400_000_000_000.0;
        const SECONDS_PER_DAY: f64 = 86_400.0;

        let duration = self.duration();
        match duration.num_nanoseconds() {
            Some(ns) => ns as f64 / NANOS_PER_DAY,
            // Fallback for exceptionally large durations that do not fit in i64 nanoseconds.
            None => duration.num_seconds() as f64 / SECONDS_PER_DAY,
        }
    }

    /// Returns the duration in seconds.
    pub fn duration_seconds(&self) -> i64 {
        self.duration().num_seconds()
    }
}

// Serde support for Period<MJD> (= Interval<Time<MJD>>)
//
// Uses the historical field names `start_mjd` / `end_mjd` for backward
// compatibility with existing JSON reference data.
#[cfg(feature = "serde")]
impl Serialize for Interval<crate::ModifiedJulianDate> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let mut s = serializer.serialize_struct("Period", 2)?;
        s.serialize_field("start_mjd", &self.start.value())?;
        s.serialize_field("end_mjd", &self.end.value())?;
        s.end()
    }
}

#[cfg(feature = "serde")]
impl<'de> Deserialize<'de> for Interval<crate::ModifiedJulianDate> {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        #[derive(Deserialize)]
        struct Raw {
            start_mjd: f64,
            end_mjd: f64,
        }

        let raw = Raw::deserialize(deserializer)?;
        if !raw.start_mjd.is_finite() || !raw.end_mjd.is_finite() {
            return Err(serde::de::Error::custom(
                "period MJD values must be finite (not NaN or infinity)",
            ));
        }
        if raw.start_mjd > raw.end_mjd {
            return Err(serde::de::Error::custom(
                "period start must not be after end",
            ));
        }
        Ok(Interval::new(
            crate::ModifiedJulianDate::new(raw.start_mjd),
            crate::ModifiedJulianDate::new(raw.end_mjd),
        ))
    }
}

// Serde support for Period<JD> (= Interval<Time<JD>>)
#[cfg(feature = "serde")]
impl Serialize for Interval<crate::JulianDate> {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let mut s = serializer.serialize_struct("Period", 2)?;
        s.serialize_field("start_jd", &self.start.value())?;
        s.serialize_field("end_jd", &self.end.value())?;
        s.end()
    }
}

#[cfg(feature = "serde")]
impl<'de> Deserialize<'de> for Interval<crate::JulianDate> {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        #[derive(Deserialize)]
        struct Raw {
            start_jd: f64,
            end_jd: f64,
        }

        let raw = Raw::deserialize(deserializer)?;
        if !raw.start_jd.is_finite() || !raw.end_jd.is_finite() {
            return Err(serde::de::Error::custom(
                "period JD values must be finite (not NaN or infinity)",
            ));
        }
        if raw.start_jd > raw.end_jd {
            return Err(serde::de::Error::custom(
                "period start must not be after end",
            ));
        }
        Ok(Interval::new(
            crate::JulianDate::new(raw.start_jd),
            crate::JulianDate::new(raw.end_jd),
        ))
    }
}

/// Returns the gaps (complement) of `periods` within the bounding `outer` period.
///
/// Given a sorted, non-overlapping list of sub-periods and a bounding period,
/// this returns the time intervals NOT covered by any sub-period.
///
/// Both `outer` and every element of `periods` must have `start <= end`.
/// The function runs in O(n) time with a single pass.
///
/// # Arguments
/// * `outer` - The bounding period
/// * `periods` - Sorted, non-overlapping sub-periods within `outer`
///
/// # Returns
/// The complement periods (gaps) in chronological order.
pub fn complement_within<T: TimeInstant>(
    outer: Interval<T>,
    periods: &[Interval<T>],
) -> Vec<Interval<T>> {
    let mut gaps = Vec::new();
    let mut cursor = outer.start;
    for p in periods {
        if p.start > cursor {
            gaps.push(Interval::new(cursor, p.start));
        }
        if p.end > cursor {
            cursor = p.end;
        }
    }
    if cursor < outer.end {
        gaps.push(Interval::new(cursor, outer.end));
    }
    gaps
}

/// Returns the intersection of two sorted, non-overlapping period lists.
///
/// Uses an O(n+m) merge algorithm to find all overlapping spans.
///
/// # Arguments
/// * `a` - First sorted, non-overlapping period list
/// * `b` - Second sorted, non-overlapping period list
///
/// # Returns
/// Periods where both `a` and `b` overlap, in chronological order.
pub fn intersect_periods<T: TimeInstant>(a: &[Interval<T>], b: &[Interval<T>]) -> Vec<Interval<T>> {
    let mut result = Vec::new();
    let (mut i, mut j) = (0, 0);
    while i < a.len() && j < b.len() {
        let start = if a[i].start >= b[j].start {
            a[i].start
        } else {
            b[j].start
        };
        let end = if a[i].end <= b[j].end {
            a[i].end
        } else {
            b[j].end
        };
        if start < end {
            result.push(Interval::new(start, end));
        }
        if a[i].end <= b[j].end {
            i += 1;
        } else {
            j += 1;
        }
    }
    result
}

/// Validate that a period list is sorted by start time and non-overlapping.
///
/// Checks three invariants on every element:
/// 1. Each interval has `start <= end`.
/// 2. Intervals are sorted by start time (monotonically non-decreasing).
/// 3. Adjacent intervals do not overlap (previous `end <= next start`).
///
/// Returns `Ok(())` if all invariants hold, or the first violation found.
///
/// # Examples
///
/// ```
/// # use tempoch_core as tempoch;
/// use tempoch::{validate_period_list, Interval, ModifiedJulianDate};
///
/// let sorted = vec![
///     Interval::new(ModifiedJulianDate::new(0.0), ModifiedJulianDate::new(3.0)),
///     Interval::new(ModifiedJulianDate::new(5.0), ModifiedJulianDate::new(8.0)),
/// ];
/// assert!(validate_period_list(&sorted).is_ok());
/// ```
pub fn validate_period_list<T: TimeInstant>(
    periods: &[Interval<T>],
) -> Result<(), PeriodListError> {
    for (i, p) in periods.iter().enumerate() {
        if p.start
            .partial_cmp(&p.end)
            .is_none_or(|o| o == std::cmp::Ordering::Greater)
        {
            return Err(PeriodListError::InvalidInterval { index: i });
        }
    }
    for i in 1..periods.len() {
        if periods[i - 1]
            .start
            .partial_cmp(&periods[i].start)
            .is_none_or(|o| o == std::cmp::Ordering::Greater)
        {
            return Err(PeriodListError::Unsorted { index: i });
        }
        if periods[i - 1].end > periods[i].start {
            return Err(PeriodListError::Overlapping { index: i });
        }
    }
    Ok(())
}

/// Sort periods by start time and merge overlapping/adjacent intervals.
///
/// Produces a sorted, non-overlapping list suitable for [`complement_within`]
/// and [`intersect_periods`].
///
/// # Examples
///
/// ```
/// # use tempoch_core as tempoch;
/// use tempoch::{normalize_periods, Interval, ModifiedJulianDate};
///
/// let periods = vec![
///     Interval::new(ModifiedJulianDate::new(5.0), ModifiedJulianDate::new(8.0)),
///     Interval::new(ModifiedJulianDate::new(0.0), ModifiedJulianDate::new(3.0)),
///     Interval::new(ModifiedJulianDate::new(2.0), ModifiedJulianDate::new(6.0)),
/// ];
/// let merged = normalize_periods(&periods);
/// assert_eq!(merged.len(), 1); // [0, 8)
/// ```
pub fn normalize_periods<T: TimeInstant>(periods: &[Interval<T>]) -> Vec<Interval<T>> {
    if periods.is_empty() {
        return Vec::new();
    }
    let mut sorted: Vec<_> = periods.to_vec();
    sorted.sort_by(|a, b| {
        a.start
            .partial_cmp(&b.start)
            .unwrap_or(std::cmp::Ordering::Equal)
    });
    let mut merged = vec![sorted[0]];
    for p in &sorted[1..] {
        let last = merged.last_mut().unwrap();
        if p.start <= last.end {
            // Overlapping or adjacent — extend
            if p.end > last.end {
                last.end = p.end;
            }
        } else {
            merged.push(*p);
        }
    }
    merged
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{JulianDate, ModifiedJulianDate, JD, MJD};

    #[test]
    fn test_try_new_valid() {
        let p = Interval::try_new(
            ModifiedJulianDate::new(59000.0),
            ModifiedJulianDate::new(59001.0),
        );
        assert!(p.is_ok());
    }

    #[test]
    fn test_try_new_equal_bounds() {
        let p = Interval::try_new(
            ModifiedJulianDate::new(59000.0),
            ModifiedJulianDate::new(59000.0),
        );
        assert!(p.is_ok()); // zero-length interval is valid
    }

    #[test]
    fn test_try_new_invalid() {
        let p = Interval::try_new(
            ModifiedJulianDate::new(59001.0),
            ModifiedJulianDate::new(59000.0),
        );
        assert_eq!(p, Err(InvalidIntervalError::StartAfterEnd));
    }

    #[test]
    fn test_try_new_nan_rejected() {
        let p = Interval::try_new(
            ModifiedJulianDate::new(f64::NAN),
            ModifiedJulianDate::new(59000.0),
        );
        assert!(p.is_err());
    }

    #[test]
    fn test_validate_period_list_ok() {
        let periods = vec![
            Period::new(ModifiedJulianDate::new(0.0), ModifiedJulianDate::new(3.0)),
            Period::new(ModifiedJulianDate::new(5.0), ModifiedJulianDate::new(8.0)),
        ];
        assert!(validate_period_list(&periods).is_ok());
    }

    #[test]
    fn test_validate_period_list_unsorted() {
        let periods = vec![
            Period::new(ModifiedJulianDate::new(5.0), ModifiedJulianDate::new(8.0)),
            Period::new(ModifiedJulianDate::new(0.0), ModifiedJulianDate::new(3.0)),
        ];
        assert_eq!(
            validate_period_list(&periods),
            Err(PeriodListError::Unsorted { index: 1 })
        );
    }

    #[test]
    fn test_validate_period_list_overlapping() {
        let periods = vec![
            Period::new(ModifiedJulianDate::new(0.0), ModifiedJulianDate::new(5.0)),
            Period::new(ModifiedJulianDate::new(3.0), ModifiedJulianDate::new(8.0)),
        ];
        assert_eq!(
            validate_period_list(&periods),
            Err(PeriodListError::Overlapping { index: 1 })
        );
    }

    #[test]
    fn test_validate_period_list_invalid_interval() {
        let periods = vec![Period::new(
            ModifiedJulianDate::new(5.0),
            ModifiedJulianDate::new(3.0),
        )];
        assert_eq!(
            validate_period_list(&periods),
            Err(PeriodListError::InvalidInterval { index: 0 })
        );
    }

    #[test]
    fn test_normalize_periods_empty() {
        let periods: Vec<Period<MJD>> = vec![];
        assert!(normalize_periods(&periods).is_empty());
    }

    #[test]
    fn test_normalize_periods_unsorted_and_overlapping() {
        let periods = vec![
            Period::new(ModifiedJulianDate::new(5.0), ModifiedJulianDate::new(8.0)),
            Period::new(ModifiedJulianDate::new(0.0), ModifiedJulianDate::new(3.0)),
            Period::new(ModifiedJulianDate::new(2.0), ModifiedJulianDate::new(6.0)),
        ];
        let merged = normalize_periods(&periods);
        assert_eq!(merged.len(), 1);
        assert_eq!(merged[0].start.quantity(), Days::new(0.0));
        assert_eq!(merged[0].end.quantity(), Days::new(8.0));
    }

    #[test]
    fn test_normalize_periods_disjoint() {
        let periods = vec![
            Period::new(ModifiedJulianDate::new(5.0), ModifiedJulianDate::new(6.0)),
            Period::new(ModifiedJulianDate::new(0.0), ModifiedJulianDate::new(2.0)),
        ];
        let merged = normalize_periods(&periods);
        assert_eq!(merged.len(), 2);
        assert_eq!(merged[0].start.quantity(), Days::new(0.0));
        assert_eq!(merged[1].start.quantity(), Days::new(5.0));
    }

    #[test]
    fn test_period_creation_jd() {
        let start = JulianDate::new(2451545.0);
        let end = JulianDate::new(2451546.0);
        let period = Period::new(start, end);

        assert_eq!(period.start, start);
        assert_eq!(period.end, end);
    }

    #[test]
    fn test_period_scale_conversion_jd_to_mjd() {
        let period_jd = Period::new(Time::<JD>::new(2_451_545.0), Time::<JD>::new(2_451_546.0));
        let period_mjd = period_jd.to::<MJD>().unwrap();

        assert!((period_mjd.start.value() - 51_544.5).abs() < 1e-12);
        assert!((period_mjd.end.value() - 51_545.5).abs() < 1e-12);
    }

    #[test]
    fn test_period_scale_conversion_roundtrip() {
        let original = Period::new(Time::<MJD>::new(59_000.125), Time::<MJD>::new(59_001.75));
        let roundtrip = original.to::<JD>().unwrap().to::<MJD>().unwrap();

        assert!((roundtrip.start.value() - original.start.value()).abs() < 1e-12);
        assert!((roundtrip.end.value() - original.end.value()).abs() < 1e-12);
    }

    #[test]
    fn test_period_scale_conversion_to_utc() {
        let start_utc = DateTime::from_timestamp(1_700_000_000, 0).unwrap();
        let end_utc = DateTime::from_timestamp(1_700_000_600, 0).unwrap();
        let period_jd = Period::new(
            Time::<JD>::from_utc(start_utc),
            Time::<JD>::from_utc(end_utc),
        );

        let period_utc = period_jd.to::<DateTime<Utc>>().unwrap();
        let start_delta_ns = period_utc.start.timestamp_nanos_opt().unwrap()
            - start_utc.timestamp_nanos_opt().unwrap();
        let end_delta_ns =
            period_utc.end.timestamp_nanos_opt().unwrap() - end_utc.timestamp_nanos_opt().unwrap();
        assert!(start_delta_ns.abs() < 10_000);
        assert!(end_delta_ns.abs() < 10_000);
    }

    #[test]
    fn test_period_creation_mjd() {
        let start = ModifiedJulianDate::new(59000.0);
        let end = ModifiedJulianDate::new(59001.0);
        let period = Period::new(start, end);

        assert_eq!(period.start, start);
        assert_eq!(period.end, end);
    }

    #[test]
    fn test_period_duration_jd() {
        let start = JulianDate::new(2451545.0);
        let end = JulianDate::new(2451546.5);
        let period = Period::new(start, end);

        assert_eq!(period.duration_days(), Days::new(1.5));
    }

    #[test]
    fn test_period_duration_mjd() {
        let start = ModifiedJulianDate::new(59000.0);
        let end = ModifiedJulianDate::new(59001.5);
        let period = Period::new(start, end);

        assert_eq!(period.duration_days(), Days::new(1.5));
    }

    #[test]
    fn test_period_duration_utc() {
        let start = DateTime::from_timestamp(0, 0).unwrap();
        let end = DateTime::from_timestamp(86400, 0).unwrap(); // 1 day later
        let period = Interval::new(start, end);

        assert_eq!(period.duration_days(), 1.0);
        assert_eq!(period.duration_seconds(), 86400);
    }

    #[test]
    fn test_period_duration_utc_subsecond_precision() {
        let start = DateTime::from_timestamp(0, 0).unwrap();
        let end = DateTime::from_timestamp(0, 500_000_000).unwrap();
        let period = Interval::new(start, end);

        let expected_days = 0.5 / 86_400.0;
        assert!((period.duration_days() - expected_days).abs() < 1e-15);
        assert_eq!(period.duration_seconds(), 0);
    }

    #[test]
    fn test_period_to_conversion() {
        let mjd_start = ModifiedJulianDate::new(59000.0);
        let mjd_end = ModifiedJulianDate::new(59001.0);
        let mjd_period = Period::new(mjd_start, mjd_end);

        let utc_period = mjd_period.to::<DateTime<Utc>>().unwrap();

        // The converted period should have approximately the same duration (within 1 second due to ΔT)
        let duration_secs = utc_period.duration().num_seconds();
        assert!(
            (duration_secs - 86400).abs() <= 1,
            "Duration was {} seconds",
            duration_secs
        );

        // Convert back and check that it's close (within small tolerance due to floating point)
        let back_to_mjd = utc_period.to::<ModifiedJulianDate>();
        let start_diff = (back_to_mjd.start.quantity() - mjd_start.quantity())
            .value()
            .abs();
        let end_diff = (back_to_mjd.end.quantity() - mjd_end.quantity())
            .value()
            .abs();
        assert!(start_diff < 1e-6, "Start difference: {}", start_diff);
        assert!(end_diff < 1e-6, "End difference: {}", end_diff);
    }

    #[test]
    fn test_period_display() {
        let start = ModifiedJulianDate::new(59000.0);
        let end = ModifiedJulianDate::new(59001.0);
        let period = Period::new(start, end);

        let display = format!("{}", period);
        assert!(display.contains("MJD 59000"));
        assert!(display.contains("MJD 59001"));
        assert!(display.contains("to"));
    }

    #[test]
    fn test_period_intersection_overlap() {
        let a = Period::new(ModifiedJulianDate::new(0.0), ModifiedJulianDate::new(5.0));
        let b = Period::new(ModifiedJulianDate::new(3.0), ModifiedJulianDate::new(8.0));

        let overlap = a.intersection(&b).expect("expected overlap");
        assert_eq!(overlap.start.quantity(), Days::new(3.0));
        assert_eq!(overlap.end.quantity(), Days::new(5.0));
    }

    #[test]
    fn test_period_intersection_disjoint() {
        let a = Period::new(ModifiedJulianDate::new(0.0), ModifiedJulianDate::new(3.0));
        let b = Period::new(ModifiedJulianDate::new(5.0), ModifiedJulianDate::new(8.0));

        assert_eq!(a.intersection(&b), None);
    }

    #[test]
    fn test_period_intersection_touching_edges() {
        let a = Period::new(ModifiedJulianDate::new(0.0), ModifiedJulianDate::new(3.0));
        let b = Period::new(ModifiedJulianDate::new(3.0), ModifiedJulianDate::new(8.0));

        assert_eq!(a.intersection(&b), None);
    }

    #[test]
    fn test_complement_within_gaps() {
        let outer = Period::new(ModifiedJulianDate::new(0.0), ModifiedJulianDate::new(10.0));
        let periods = vec![
            Period::new(ModifiedJulianDate::new(2.0), ModifiedJulianDate::new(4.0)),
            Period::new(ModifiedJulianDate::new(6.0), ModifiedJulianDate::new(8.0)),
        ];
        let gaps = complement_within(outer, &periods);
        assert_eq!(gaps.len(), 3);
        assert_eq!(gaps[0].start.quantity(), Days::new(0.0));
        assert_eq!(gaps[0].end.quantity(), Days::new(2.0));
        assert_eq!(gaps[1].start.quantity(), Days::new(4.0));
        assert_eq!(gaps[1].end.quantity(), Days::new(6.0));
        assert_eq!(gaps[2].start.quantity(), Days::new(8.0));
        assert_eq!(gaps[2].end.quantity(), Days::new(10.0));
    }

    #[test]
    fn test_complement_within_empty() {
        let outer = Period::new(ModifiedJulianDate::new(0.0), ModifiedJulianDate::new(10.0));
        let gaps = complement_within(outer, &[]);
        assert_eq!(gaps.len(), 1);
        assert_eq!(gaps[0].start.quantity(), Days::new(0.0));
        assert_eq!(gaps[0].end.quantity(), Days::new(10.0));
    }

    #[test]
    fn test_complement_within_full() {
        let outer = Period::new(ModifiedJulianDate::new(0.0), ModifiedJulianDate::new(10.0));
        let periods = vec![Period::new(
            ModifiedJulianDate::new(0.0),
            ModifiedJulianDate::new(10.0),
        )];
        let gaps = complement_within(outer, &periods);
        assert!(gaps.is_empty());
    }

    #[test]
    fn test_intersect_periods_overlap() {
        let a = vec![Period::new(
            ModifiedJulianDate::new(0.0),
            ModifiedJulianDate::new(5.0),
        )];
        let b = vec![Period::new(
            ModifiedJulianDate::new(3.0),
            ModifiedJulianDate::new(8.0),
        )];
        let overlap = intersect_periods(&a, &b);
        assert_eq!(overlap.len(), 1);
        assert_eq!(overlap[0].start.quantity(), Days::new(3.0));
        assert_eq!(overlap[0].end.quantity(), Days::new(5.0));
    }

    #[test]
    fn test_intersect_periods_no_overlap() {
        let a = vec![Period::new(
            ModifiedJulianDate::new(0.0),
            ModifiedJulianDate::new(3.0),
        )];
        let b = vec![Period::new(
            ModifiedJulianDate::new(5.0),
            ModifiedJulianDate::new(8.0),
        )];
        let overlap = intersect_periods(&a, &b);
        assert!(overlap.is_empty());
    }

    #[test]
    fn test_complement_intersect_roundtrip() {
        // above(min) ∩ complement(above(max)) = between(min, max)
        let outer = Period::new(ModifiedJulianDate::new(0.0), ModifiedJulianDate::new(10.0));
        let above_min = vec![
            Period::new(ModifiedJulianDate::new(1.0), ModifiedJulianDate::new(3.0)),
            Period::new(ModifiedJulianDate::new(5.0), ModifiedJulianDate::new(9.0)),
        ];
        let above_max = vec![
            Period::new(ModifiedJulianDate::new(2.0), ModifiedJulianDate::new(4.0)),
            Period::new(ModifiedJulianDate::new(7.0), ModifiedJulianDate::new(8.0)),
        ];
        let below_max = complement_within(outer, &above_max);
        let between = intersect_periods(&above_min, &below_max);
        // above_min: [1,3), [5,9)
        // above_max: [2,4), [7,8)
        // below_max (complement): [0,2), [4,7), [8,10)
        // intersection: [1,2), [5,7), [8,9)
        assert_eq!(between.len(), 3);
        assert_eq!(between[0].start.quantity(), Days::new(1.0));
        assert_eq!(between[0].end.quantity(), Days::new(2.0));
        assert_eq!(between[1].start.quantity(), Days::new(5.0));
        assert_eq!(between[1].end.quantity(), Days::new(7.0));
        assert_eq!(between[2].start.quantity(), Days::new(8.0));
        assert_eq!(between[2].end.quantity(), Days::new(9.0));
    }

    // ── New coverage tests ────────────────────────────────────────────

    #[test]
    fn test_conversion_error_display() {
        let err = ConversionError::OutOfRange;
        let msg = format!("{err}");
        assert!(msg.contains("out of representable range"), "got: {msg}");
    }

    #[test]
    fn test_conversion_error_is_error() {
        let err = ConversionError::OutOfRange;
        // Verify it satisfies std::error::Error
        let _: &dyn std::error::Error = &err;
    }

    #[test]
    fn test_invalid_interval_error_display() {
        let err = InvalidIntervalError::StartAfterEnd;
        let msg = format!("{err}");
        assert!(msg.contains("start must not be after end"), "got: {msg}");
    }

    #[test]
    fn test_invalid_interval_error_is_error() {
        let err = InvalidIntervalError::StartAfterEnd;
        let _: &dyn std::error::Error = &err;
    }

    #[test]
    fn test_period_list_error_invalid_interval_display() {
        let e = PeriodListError::InvalidInterval { index: 0 };
        let msg = format!("{e}");
        assert!(msg.contains("index 0"), "got: {msg}");
    }

    #[test]
    fn test_period_list_error_unsorted_display() {
        let e = PeriodListError::Unsorted { index: 2 };
        let msg = format!("{e}");
        assert!(msg.contains("index 2"), "got: {msg}");
    }

    #[test]
    fn test_period_list_error_overlapping_display() {
        let e = PeriodListError::Overlapping { index: 3 };
        let msg = format!("{e}");
        assert!(msg.contains("index 3"), "got: {msg}");
    }

    #[test]
    fn test_period_list_error_is_error() {
        let e = PeriodListError::InvalidInterval { index: 0 };
        let _: &dyn std::error::Error = &e;
    }

    #[test]
    fn test_intersection_self_larger_than_other() {
        // a.start > b.start  AND  a.end > b.end  → intersection picks a.start and b.end.
        // Exercises the `self.start` branch (line 284) and the `other.end` branch (line 291).
        let a = Period::new(ModifiedJulianDate::new(2.0), ModifiedJulianDate::new(8.0));
        let b = Period::new(ModifiedJulianDate::new(0.0), ModifiedJulianDate::new(5.0));
        let overlap = a.intersection(&b).expect("should overlap");
        assert_eq!(overlap.start.quantity(), Days::new(2.0));
        assert_eq!(overlap.end.quantity(), Days::new(5.0));
    }

    #[test]
    fn test_period_time_target_for_time_type() {
        // Use `ModifiedJulianDate` (= Time<MJD>) as the Target type parameter,
        // not the bare `MJD` marker, to exercise the PeriodTimeTarget impl for Time<T>.
        let period_jd = Period::new(Time::<JD>::new(2_451_545.0), Time::<JD>::new(2_451_546.0));
        let period_mjd: Interval<ModifiedJulianDate> =
            period_jd.to::<ModifiedJulianDate>().unwrap();
        assert!((period_mjd.start.value() - 51_544.5).abs() < 1e-12);
        assert!((period_mjd.end.value() - 51_545.5).abs() < 1e-12);
    }

    #[test]
    fn test_utc_period_to_datetime_utc_identity() {
        // Converting an Interval<DateTime<Utc>> to DateTime<Utc> again is a
        // no-op; exercises PeriodUtcTarget for DateTime<Utc>.
        let start = DateTime::from_timestamp(0, 0).unwrap();
        let end = DateTime::from_timestamp(86400, 0).unwrap();
        let utc_period = Interval::new(start, end);
        let same: Interval<DateTime<Utc>> = utc_period.to::<DateTime<Utc>>();
        assert_eq!(same.start, start);
        assert_eq!(same.end, end);
    }

    #[cfg(feature = "serde")]
    #[test]
    fn test_period_mjd_serde_roundtrip() {
        let p = Period::new(
            ModifiedJulianDate::new(59000.0),
            ModifiedJulianDate::new(59001.0),
        );
        let json = serde_json::to_string(&p).unwrap();
        assert!(json.contains("start_mjd"), "serialized: {json}");
        let back: Period<MJD> = serde_json::from_str(&json).unwrap();
        assert!((back.start.value() - 59000.0).abs() < 1e-12);
        assert!((back.end.value() - 59001.0).abs() < 1e-12);
    }

    #[cfg(feature = "serde")]
    #[test]
    fn test_period_mjd_deserialize_start_after_end_rejected() {
        let json = r#"{"start_mjd": 59001.0, "end_mjd": 59000.0}"#;
        let result: Result<Period<MJD>, _> = serde_json::from_str(json);
        assert!(result.is_err());
    }

    #[cfg(feature = "serde")]
    #[test]
    fn test_period_jd_serde_roundtrip() {
        let p = Period::new(JulianDate::new(2_451_545.0), JulianDate::new(2_451_546.0));
        let json = serde_json::to_string(&p).unwrap();
        assert!(json.contains("start_jd"), "serialized: {json}");
        let back: Period<JD> = serde_json::from_str(&json).unwrap();
        assert!((back.start.value() - 2_451_545.0).abs() < 1e-12);
        assert!((back.end.value() - 2_451_546.0).abs() < 1e-12);
    }

    #[cfg(feature = "serde")]
    #[test]
    fn test_period_jd_deserialize_start_after_end_rejected() {
        let json = r#"{"start_jd": 2451546.0, "end_jd": 2451545.0}"#;
        let result: Result<Period<JD>, _> = serde_json::from_str(json);
        assert!(result.is_err());
    }
}