delaunay 0.8.0

D-dimensional Delaunay triangulations and convex hulls in Rust, with exact predicates, deterministic degeneracy handling, explicit topology validation, and bistellar flips for finite point sets.
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
//! Core trait for topological spaces and related error types.
//!
//! This module defines the fundamental abstraction for different topological
//! spaces (planar, spherical, toroidal) that triangulations can inhabit.
//! `GlobalTopology` metadata from this module is used by triangulation/build paths.
//! Topology-specific behavior is delegated through the internal
//! `global_topology_model` adapter layer.

use crate::core::{facet::FacetError, tds::TdsError};
use crate::topology::manifold::ManifoldError;
use thiserror::Error;

/// Errors that can occur during topology computation or validation.
///
/// These errors arise from simplex counting, classification, or
/// Euler characteristic validation failures.
///
/// # Examples
///
/// ```rust
/// use delaunay::prelude::topology::spaces::TopologyError;
/// use delaunay::prelude::tds::TdsError;
///
/// let error = TopologyError::FacetMapBuild {
///     source: TdsError::InconsistentDataStructure {
///         message: "facet map invariant failed".to_string(),
///     },
/// };
/// std::assert_matches!(error, TopologyError::FacetMapBuild { .. });
/// ```
#[derive(Clone, Debug, Error, PartialEq)]
#[non_exhaustive]
pub enum TopologyError {
    /// Failed to build the facet-to-simplices incidence map.
    #[error("Failed to build facet incidence map during topology analysis: {source}")]
    FacetMapBuild {
        /// Underlying TDS failure.
        #[source]
        source: TdsError,
    },

    /// Failed to enumerate boundary facets.
    #[error("Failed to enumerate boundary facets during topology analysis: {source}")]
    BoundaryFacetEnumeration {
        /// Underlying TDS failure.
        #[source]
        source: TdsError,
    },

    /// Failed to access the simplex for a boundary facet.
    #[error("Failed to access boundary facet simplex during topology analysis: {source}")]
    BoundaryFacetSimplexAccess {
        /// Underlying facet failure.
        #[source]
        source: FacetError,
    },

    /// Failed to count boundary facets while classifying topology.
    #[error("Failed to count boundary facets during topology classification: {source}")]
    BoundaryFacetCount {
        /// Underlying TDS failure.
        #[source]
        source: TdsError,
    },

    /// Failed to classify boundary facets under the declared global topology.
    #[error("Failed to classify boundary facets during topology analysis: {source}")]
    BoundaryClassification {
        /// Underlying manifold-boundary classification failure.
        #[source]
        source: Box<ManifoldError>,
    },
}

/// Classification of topological spaces for triangulations.
///
/// This enum categorizes the fundamental geometry of the space in which
/// a triangulation is realized. Different topologies have different
/// properties regarding boundary conditions and geometric constraints.
///
/// # Future Use
///
/// This is currently unused but provides the foundation for future support
/// of non-Euclidean triangulations (spherical, toroidal, hyperbolic).
///
/// # Examples
///
/// ```rust
/// use delaunay::prelude::topology::spaces::TopologyKind;
///
/// let kind = TopologyKind::Euclidean;
/// assert_eq!(format!("{:?}", kind), "Euclidean");
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TopologyKind {
    /// Euclidean (flat) space with standard distance metric.
    ///
    /// This is the default for most triangulations. Allows boundary facets
    /// (convex hull) and has no periodic wrapping.
    Euclidean,

    /// Toroidal space with periodic boundary conditions.
    ///
    /// Points wrap around at domain boundaries. No true boundary facets exist
    /// as opposite edges are identified.
    Toroidal,

    /// Spherical space realized on the surface of a sphere.
    ///
    /// All points lie on a sphere surface. No boundary facets as the space
    /// is closed and compact.
    Spherical,

    /// Hyperbolic space with negative curvature.
    ///
    /// Non-Euclidean geometry where parallel lines diverge. Distance and
    /// angle calculations differ from Euclidean space.
    Hyperbolic,
}

/// Construction mode metadata for toroidal triangulations.
///
/// This distinguishes between:
/// - image-point quotient construction, and
/// - explicit quotient connectivity supplied by a caller.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ToroidalConstructionMode {
    /// Periodic toroidal mode: 3^D image-point construction with periodic quotient
    /// neighbor rewiring.
    PeriodicImagePoint,
    /// Explicit quotient connectivity supplied directly by the caller.
    ///
    /// No coordinate canonicalization or image-point expansion is performed. The
    /// current Delaunay builder rejects non-Euclidean explicit connectivity
    /// because quotient realization validation is not implemented for that
    /// construction path.
    Explicit,
}

/// Errors that can occur while parsing a toroidal fundamental domain.
///
/// Toroidal domains require every period to be finite and strictly positive.
///
/// # Examples
///
/// ```rust
/// use delaunay::prelude::topology::spaces::{ToroidalDomain, ToroidalDomainError};
///
/// std::assert_matches!(
///     ToroidalDomain::<2>::try_new([1.0, 0.0]),
///     Err(ToroidalDomainError::InvalidPeriod { axis: 1, period })
///         if period.abs() < f64::EPSILON
/// );
/// ```
#[derive(Clone, Copy, Debug, Error, PartialEq)]
#[non_exhaustive]
pub enum ToroidalDomainError {
    /// A domain period was not finite and strictly positive.
    #[error("Invalid toroidal period {period:?} on axis {axis}; expected finite value > 0")]
    InvalidPeriod {
        /// Axis index containing the invalid period.
        axis: usize,
        /// Invalid period value.
        period: f64,
    },
}

/// Validated toroidal fundamental-domain periods.
///
/// This type carries the invariant that every period is finite and strictly
/// positive, so stored topology metadata cannot represent invalid domains.
///
/// # Examples
///
/// ```rust
/// use delaunay::prelude::topology::spaces::ToroidalDomain;
///
/// # fn main() -> Result<(), delaunay::prelude::topology::spaces::ToroidalDomainError> {
/// let domain = ToroidalDomain::<2>::try_new([1.0, 2.0])?;
/// assert_eq!(domain.periods(), &[1.0, 2.0]);
/// # Ok(())
/// # }
/// ```
#[must_use]
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct ToroidalDomain<const D: usize> {
    periods: [f64; D],
}

impl<const D: usize> ToroidalDomain<D> {
    /// Creates a validated toroidal domain from raw periods.
    ///
    /// # Errors
    ///
    /// Returns [`ToroidalDomainError::InvalidPeriod`] when any period is
    /// non-finite, zero, or negative.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use delaunay::prelude::topology::spaces::{ToroidalDomain, ToroidalDomainError};
    ///
    /// # fn main() -> Result<(), ToroidalDomainError> {
    /// let domain = ToroidalDomain::<2>::try_new([1.0, 2.0])?;
    /// assert_eq!(domain.periods(), &[1.0, 2.0]);
    ///
    /// std::assert_matches!(
    ///     ToroidalDomain::<2>::try_new([0.0, 2.0]),
    ///     Err(ToroidalDomainError::InvalidPeriod { axis: 0, period })
    ///         if period.abs() < f64::EPSILON
    /// );
    /// # Ok(())
    /// # }
    /// ```
    pub fn try_new(periods: [f64; D]) -> Result<Self, ToroidalDomainError> {
        for (axis, period) in periods.iter().copied().enumerate() {
            if !period.is_finite() || period <= 0.0 {
                return Err(ToroidalDomainError::InvalidPeriod { axis, period });
            }
        }
        Ok(Self { periods })
    }

    /// Creates a unit toroidal domain with period `1.0` on every axis.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use delaunay::prelude::topology::spaces::ToroidalDomain;
    ///
    /// let domain = ToroidalDomain::<3>::unit();
    /// assert_eq!(domain.periods(), &[1.0, 1.0, 1.0]);
    /// ```
    pub const fn unit() -> Self {
        Self { periods: [1.0; D] }
    }

    /// Returns the validated periods.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use delaunay::prelude::topology::spaces::ToroidalDomain;
    ///
    /// # fn main() -> Result<(), delaunay::prelude::topology::spaces::ToroidalDomainError> {
    /// let domain = ToroidalDomain::<2>::try_new([2.0, 3.0])?;
    /// assert_eq!(domain.periods(), &[2.0, 3.0]);
    /// # Ok(())
    /// # }
    /// ```
    #[must_use]
    pub const fn periods(&self) -> &[f64; D] {
        &self.periods
    }

    /// Returns the period for one axis.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use delaunay::prelude::topology::spaces::ToroidalDomain;
    ///
    /// # fn main() -> Result<(), delaunay::prelude::topology::spaces::ToroidalDomainError> {
    /// let domain = ToroidalDomain::<2>::try_new([2.0, 3.0])?;
    /// assert_eq!(domain.period(0), Some(2.0));
    /// assert_eq!(domain.period(2), None);
    /// # Ok(())
    /// # }
    /// ```
    #[must_use]
    pub fn period(&self, axis: usize) -> Option<f64> {
        self.periods.get(axis).copied()
    }

    /// Consumes the domain and returns the validated raw periods.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use delaunay::prelude::topology::spaces::ToroidalDomain;
    ///
    /// # fn main() -> Result<(), delaunay::prelude::topology::spaces::ToroidalDomainError> {
    /// let domain = ToroidalDomain::<2>::try_new([2.0, 3.0])?;
    /// assert_eq!(domain.into_periods(), [2.0, 3.0]);
    /// # Ok(())
    /// # }
    /// ```
    #[must_use]
    pub const fn into_periods(self) -> [f64; D] {
        self.periods
    }
}

impl<const D: usize> TryFrom<[f64; D]> for ToroidalDomain<D> {
    type Error = ToroidalDomainError;

    fn try_from(value: [f64; D]) -> Result<Self, Self::Error> {
        Self::try_new(value)
    }
}

/// Runtime metadata describing the global topological space associated with a triangulation.
///
/// This enum is stored on triangulations so boundary queries, Euler checks, and
/// topology validation interpret facet incidence under the construction path's
/// intended space. The metadata does not itself canonicalize coordinates or
/// rewire adjacency; construction APIs decide whether quotient connectivity
/// exists.
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum GlobalTopology<const D: usize> {
    /// Euclidean (flat) space.
    Euclidean,
    /// Toroidal (periodic) space with explicit domain and construction mode.
    Toroidal {
        /// Validated fundamental-domain periods `[L_0, ..., L_{D-1}]`.
        domain: ToroidalDomain<D>,
        /// How the toroidal triangulation was constructed.
        mode: ToroidalConstructionMode,
    },
    /// Spherical space.
    Spherical,
    /// Hyperbolic space.
    Hyperbolic,
}

impl<const D: usize> Default for GlobalTopology<D> {
    fn default() -> Self {
        Self::DEFAULT
    }
}

impl<const D: usize> GlobalTopology<D> {
    /// Default global-topology metadata for triangulations.
    pub const DEFAULT: Self = Self::Euclidean;

    /// Creates toroidal global-topology metadata from raw domain periods.
    ///
    /// # Errors
    ///
    /// Returns [`ToroidalDomainError::InvalidPeriod`] when any period is
    /// non-finite, zero, or negative.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use delaunay::prelude::topology::spaces::{
    ///     GlobalTopology, ToroidalConstructionMode, ToroidalDomainError,
    /// };
    ///
    /// # fn main() -> Result<(), ToroidalDomainError> {
    /// let topology = GlobalTopology::<2>::try_toroidal(
    ///     [1.0, 2.0],
    ///     ToroidalConstructionMode::PeriodicImagePoint,
    /// )?;
    ///
    /// assert!(topology.is_toroidal());
    /// assert!(topology.is_periodic());
    /// assert!(!topology.allows_boundary());
    ///
    /// std::assert_matches!(
    ///     GlobalTopology::<2>::try_toroidal(
    ///         [1.0, 0.0],
    ///         ToroidalConstructionMode::PeriodicImagePoint,
    ///     ),
    ///     Err(ToroidalDomainError::InvalidPeriod { axis: 1, period })
    ///         if period.abs() < f64::EPSILON
    /// );
    /// # Ok(())
    /// # }
    /// ```
    pub fn try_toroidal(
        domain: [f64; D],
        mode: ToroidalConstructionMode,
    ) -> Result<Self, ToroidalDomainError> {
        Ok(Self::Toroidal {
            domain: ToroidalDomain::try_new(domain)?,
            mode,
        })
    }

    /// Returns the corresponding high-level topology kind.
    #[must_use]
    pub const fn kind(self) -> TopologyKind {
        match self {
            Self::Euclidean => TopologyKind::Euclidean,
            Self::Toroidal { .. } => TopologyKind::Toroidal,
            Self::Spherical => TopologyKind::Spherical,
            Self::Hyperbolic => TopologyKind::Hyperbolic,
        }
    }

    /// Returns whether boundary facets are allowed for this global topology.
    ///
    /// Euclidean triangulations may have convex-hull boundary facets. Closed
    /// global topologies such as toroidal, spherical, and hyperbolic metadata do
    /// not admit open boundary facets.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use delaunay::prelude::topology::spaces::{
    ///     GlobalTopology, ToroidalConstructionMode, ToroidalDomainError,
    /// };
    ///
    /// # fn main() -> Result<(), ToroidalDomainError> {
    /// let toroidal = GlobalTopology::<2>::try_toroidal(
    ///     [1.0, 1.0],
    ///     ToroidalConstructionMode::PeriodicImagePoint,
    /// )?;
    ///
    /// assert!(GlobalTopology::<2>::Euclidean.allows_boundary());
    /// assert!(!toroidal.allows_boundary());
    /// # Ok(())
    /// # }
    /// ```
    #[must_use]
    pub const fn allows_boundary(self) -> bool {
        match self {
            Self::Euclidean => true,
            Self::Toroidal { .. } | Self::Spherical | Self::Hyperbolic => false,
        }
    }

    /// Returns `true` for Euclidean global topology metadata.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use delaunay::prelude::topology::spaces::GlobalTopology;
    ///
    /// let topo = GlobalTopology::<3>::Euclidean;
    /// assert!(topo.is_euclidean());
    /// assert!(!topo.is_toroidal());
    /// ```
    #[must_use]
    pub const fn is_euclidean(self) -> bool {
        matches!(self, Self::Euclidean)
    }

    /// Returns `true` for toroidal global topology metadata.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use delaunay::prelude::topology::spaces::{
    ///     GlobalTopology, ToroidalConstructionMode, ToroidalDomainError,
    /// };
    ///
    /// # fn main() -> Result<(), ToroidalDomainError> {
    /// let toroidal = GlobalTopology::<2>::try_toroidal(
    ///     [1.0, 1.0],
    ///     ToroidalConstructionMode::PeriodicImagePoint,
    /// )?;
    ///
    /// assert!(toroidal.is_toroidal());
    /// # Ok(())
    /// # }
    /// ```
    #[must_use]
    pub const fn is_toroidal(self) -> bool {
        matches!(self, Self::Toroidal { .. })
    }

    /// Returns `true` when this represents a periodic image-point toroidal build.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use delaunay::prelude::topology::spaces::{
    ///     GlobalTopology, ToroidalConstructionMode, ToroidalDomainError,
    /// };
    ///
    /// # fn main() -> Result<(), ToroidalDomainError> {
    /// let periodic = GlobalTopology::<2>::try_toroidal(
    ///     [1.0, 1.0],
    ///     ToroidalConstructionMode::PeriodicImagePoint,
    /// )?;
    ///
    /// assert!(periodic.is_periodic());
    /// assert!(!GlobalTopology::<2>::Euclidean.is_periodic());
    /// # Ok(())
    /// # }
    /// ```
    #[must_use]
    pub const fn is_periodic(self) -> bool {
        matches!(
            self,
            Self::Toroidal {
                mode: ToroidalConstructionMode::PeriodicImagePoint,
                ..
            }
        )
    }
}

/// Trait for fixed-coordinate topology-space helpers.
///
/// This trait abstracts topology-specific operations whose coordinate arity
/// matches the triangulation dimension `D`. The current concrete helper
/// implementations are Euclidean and toroidal. Spherical Delaunay construction
/// uses [`crate::topology::spaces::spherical::SphericalPoint`] and
/// [`crate::topology::spaces::spherical::SphericalMetric`] instead because
/// points on `S^D` live in ambient `R^(D+1)`.
///
/// The dimension is specified via the associated constant `DIM`, which must
/// match the dimension of the associated `Tds<U, V, D>`. This ensures
/// type safety and prevents dimension mismatches.
///
/// # Examples
///
/// ```rust
/// use delaunay::prelude::topology::spaces::{
///     EuclideanSpace, TopologicalSpace, TopologyKind,
/// };
///
/// let space = EuclideanSpace::<3>::new();
/// assert_eq!(EuclideanSpace::<3>::DIM, 3);
/// assert_eq!(space.kind(), TopologyKind::Euclidean);
/// assert!(space.allows_boundary());
/// ```
pub trait TopologicalSpace {
    /// The dimension of this topological space.
    ///
    /// This must match the dimension `D` of the associated triangulation
    /// `Tds<U, V, D>` to ensure geometric consistency.
    const DIM: usize;

    /// Returns the kind of topological space.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use delaunay::prelude::topology::spaces::{TopologicalSpace, TopologyKind};
    ///
    /// struct DummySpace;
    ///
    /// impl TopologicalSpace for DummySpace {
    ///     const DIM: usize = 3;
    ///
    ///     fn kind(&self) -> TopologyKind {
    ///         TopologyKind::Euclidean
    ///     }
    ///
    ///     fn allows_boundary(&self) -> bool {
    ///         true
    ///     }
    ///
    ///     fn canonicalize_point(&self, _coords: &mut [f64]) {}
    ///
    ///     fn fundamental_domain(&self) -> Option<&[f64]> {
    ///         None
    ///     }
    /// }
    ///
    /// let space = DummySpace;
    /// assert_eq!(space.kind(), TopologyKind::Euclidean);
    /// ```
    fn kind(&self) -> TopologyKind;

    /// Returns whether this topology allows boundary facets.
    ///
    /// # Returns
    ///
    /// - `true` for Euclidean spaces (convex hull boundary allowed)
    /// - `false` for closed spaces such as toroidal quotient models and
    ///   `GlobalTopology::Spherical`
    ///
    /// # Examples
    ///
    /// ```rust
    /// use delaunay::prelude::topology::spaces::{TopologicalSpace, TopologyKind};
    ///
    /// struct DummySpace {
    ///     allows: bool,
    /// }
    ///
    /// impl TopologicalSpace for DummySpace {
    ///     const DIM: usize = 2;
    ///
    ///     fn kind(&self) -> TopologyKind {
    ///         if self.allows {
    ///             TopologyKind::Euclidean
    ///         } else {
    ///             TopologyKind::Toroidal
    ///         }
    ///     }
    ///
    ///     fn allows_boundary(&self) -> bool {
    ///         self.allows
    ///     }
    ///
    ///     fn canonicalize_point(&self, _coords: &mut [f64]) {}
    ///
    ///     fn fundamental_domain(&self) -> Option<&[f64]> {
    ///         None
    ///     }
    /// }
    ///
    /// let euclidean = DummySpace { allows: true };
    /// let toroidal = DummySpace { allows: false };
    /// assert!(euclidean.allows_boundary());
    /// assert!(!toroidal.allows_boundary());
    /// ```
    fn allows_boundary(&self) -> bool;

    /// Canonicalizes a point to conform to the topology's constraints.
    ///
    /// Current helper implementations have these canonicalization rules:
    /// - **Euclidean**: No modification (identity operation)
    /// - **Toroidal**: Wraps coordinates into fundamental domain `[0, L)`
    ///
    /// The coordinate slice length must match `Self::DIM`.
    /// This helper is infallible; implementations without an error channel may
    /// leave inputs unchanged when no valid canonical representative exists.
    /// Fallible construction paths surface those cases through
    /// [`crate::topology::traits::GlobalTopologyModelError`].
    ///
    /// Spherical `GlobalTopology` metadata still has a separate behavior model
    /// for fixed-size coordinate arrays. For spherical Delaunay construction,
    /// use
    /// [`crate::topology::spaces::spherical::SphericalPoint`] and
    /// [`crate::topology::spaces::spherical::SphericalMetric`] instead. Those
    /// types treat `D` as the intrinsic dimension of `S^D` and require
    /// `D + 1` ambient coordinates, while this trait method only sees a
    /// `Self::DIM` coordinate slice.
    ///
    /// # Arguments
    ///
    /// * `coords` - Mutable slice of point coordinates to canonicalize
    ///
    /// # Panics
    ///
    /// May panic if `coords.len() != Self::DIM` (implementation-defined).
    ///
    /// # Examples
    ///
    /// ```rust
    /// use delaunay::prelude::topology::spaces::{TopologicalSpace, TopologyKind};
    ///
    /// struct ToroidalSpace {
    ///     domain: [f64; 2],
    /// }
    ///
    /// impl TopologicalSpace for ToroidalSpace {
    ///     const DIM: usize = 2;
    ///
    ///     fn kind(&self) -> TopologyKind {
    ///         TopologyKind::Toroidal
    ///     }
    ///
    ///     fn allows_boundary(&self) -> bool {
    ///         false
    ///     }
    ///
    ///     fn canonicalize_point(&self, coords: &mut [f64]) {
    ///         for (coord, domain) in coords.iter_mut().zip(self.domain) {
    ///             *coord = coord.rem_euclid(domain);
    ///         }
    ///     }
    ///
    ///     fn fundamental_domain(&self) -> Option<&[f64]> {
    ///         Some(&self.domain)
    ///     }
    /// }
    ///
    /// let space = ToroidalSpace { domain: [1.0, 1.0] };
    /// let mut point = [1.5, -0.3];
    /// space.canonicalize_point(&mut point);
    /// assert_eq!(point, [0.5, 0.7]); // Wrapped into [0, 1)
    /// ```
    fn canonicalize_point(&self, coords: &mut [f64]);

    /// Returns the fundamental domain for periodic topologies.
    ///
    /// For periodic spaces (toroidal), this returns a slice view of the fundamental
    /// domain. For non-periodic spaces, returns `None`.
    ///
    /// The returned slice length equals `Self::DIM`.
    ///
    /// # Returns
    ///
    /// - `Some(&[L₀, L₁, ..., L_D])` for periodic spaces (domain size per dimension)
    /// - `None` for non-periodic spaces (Euclidean, spherical, hyperbolic)
    ///
    /// # Examples
    ///
    /// ```rust
    /// use delaunay::prelude::topology::spaces::{TopologicalSpace, TopologyKind};
    ///
    /// struct DummySpace {
    ///     domain: Option<[f64; 2]>,
    /// }
    ///
    /// impl TopologicalSpace for DummySpace {
    ///     const DIM: usize = 2;
    ///
    ///     fn kind(&self) -> TopologyKind {
    ///         if self.domain.is_some() {
    ///             TopologyKind::Toroidal
    ///         } else {
    ///             TopologyKind::Euclidean
    ///         }
    ///     }
    ///
    ///     fn allows_boundary(&self) -> bool {
    ///         self.domain.is_none()
    ///     }
    ///
    ///     fn canonicalize_point(&self, _coords: &mut [f64]) {}
    ///
    ///     fn fundamental_domain(&self) -> Option<&[f64]> {
    ///         self.domain.as_ref().map(|domain| &domain[..])
    ///     }
    /// }
    ///
    /// let toroidal = DummySpace {
    ///     domain: Some([2.0, 3.0]),
    /// };
    /// assert_eq!(toroidal.fundamental_domain(), Some(&[2.0, 3.0][..]));
    ///
    /// let euclidean = DummySpace { domain: None };
    /// assert_eq!(euclidean.fundamental_domain(), None);
    /// ```
    fn fundamental_domain(&self) -> Option<&[f64]>;
}

#[cfg(test)]
mod tests {
    use super::*;
    use approx::assert_relative_eq;
    use std::assert_matches;

    #[test]
    fn test_topology_error_display() {
        let counting = TopologyError::FacetMapBuild {
            source: TdsError::InconsistentDataStructure {
                message: "test message".to_string(),
            },
        };
        assert_eq!(
            counting.to_string(),
            "Failed to build facet incidence map during topology analysis: Internal data structure inconsistency: test message"
        );

        let classification = TopologyError::BoundaryFacetCount {
            source: TdsError::InconsistentDataStructure {
                message: "another test".to_string(),
            },
        };
        assert_eq!(
            classification.to_string(),
            "Failed to count boundary facets during topology classification: Internal data structure inconsistency: another test"
        );
    }

    #[test]
    fn test_topology_error_equality() {
        let err1 = TopologyError::FacetMapBuild {
            source: TdsError::InconsistentDataStructure {
                message: "msg".to_string(),
            },
        };
        let err2 = TopologyError::FacetMapBuild {
            source: TdsError::InconsistentDataStructure {
                message: "msg".to_string(),
            },
        };
        let err3 = TopologyError::FacetMapBuild {
            source: TdsError::InconsistentDataStructure {
                message: "different".to_string(),
            },
        };

        assert_eq!(err1, err2);
        assert_ne!(err1, err3);
        assert_ne!(
            err1,
            TopologyError::BoundaryFacetCount {
                source: TdsError::InconsistentDataStructure {
                    message: "msg".to_string(),
                },
            }
        );
    }

    #[test]
    fn test_topology_kind_debug() {
        assert_eq!(format!("{:?}", TopologyKind::Euclidean), "Euclidean");
        assert_eq!(format!("{:?}", TopologyKind::Toroidal), "Toroidal");
        assert_eq!(format!("{:?}", TopologyKind::Spherical), "Spherical");
        assert_eq!(format!("{:?}", TopologyKind::Hyperbolic), "Hyperbolic");
    }

    #[test]
    fn test_toroidal_construction_mode_debug() {
        assert_eq!(
            format!("{:?}", ToroidalConstructionMode::PeriodicImagePoint),
            "PeriodicImagePoint"
        );
        assert_eq!(
            format!("{:?}", ToroidalConstructionMode::Explicit),
            "Explicit"
        );
    }

    #[test]
    fn test_global_topology_default() {
        let default_topo: GlobalTopology<3> = GlobalTopology::default();
        assert_eq!(default_topo, GlobalTopology::Euclidean);
        assert_eq!(GlobalTopology::<3>::DEFAULT, GlobalTopology::Euclidean);
    }

    #[test]
    fn test_global_topology_kind() {
        assert_eq!(
            GlobalTopology::<2>::Euclidean.kind(),
            TopologyKind::Euclidean
        );
        assert_eq!(
            GlobalTopology::<3>::Spherical.kind(),
            TopologyKind::Spherical
        );
        assert_eq!(
            GlobalTopology::<4>::Hyperbolic.kind(),
            TopologyKind::Hyperbolic
        );

        let toroidal = GlobalTopology::<2>::Toroidal {
            domain: ToroidalDomain::try_new([1.0, 2.0]).unwrap(),
            mode: ToroidalConstructionMode::PeriodicImagePoint,
        };
        assert_eq!(toroidal.kind(), TopologyKind::Toroidal);
    }

    #[test]
    fn test_global_topology_allows_boundary() {
        assert!(GlobalTopology::<3>::Euclidean.allows_boundary());
        assert!(!GlobalTopology::<3>::Spherical.allows_boundary());
        assert!(!GlobalTopology::<3>::Hyperbolic.allows_boundary());

        let toroidal = GlobalTopology::<2>::Toroidal {
            domain: ToroidalDomain::try_new([1.0, 1.0]).unwrap(),
            mode: ToroidalConstructionMode::PeriodicImagePoint,
        };
        assert!(!toroidal.allows_boundary());
    }

    #[test]
    fn test_global_topology_is_euclidean() {
        assert!(GlobalTopology::<3>::Euclidean.is_euclidean());
        assert!(!GlobalTopology::<3>::Spherical.is_euclidean());
        assert!(!GlobalTopology::<3>::Hyperbolic.is_euclidean());

        let toroidal = GlobalTopology::<2>::Toroidal {
            domain: ToroidalDomain::try_new([1.0, 1.0]).unwrap(),
            mode: ToroidalConstructionMode::PeriodicImagePoint,
        };
        assert!(!toroidal.is_euclidean());
    }

    #[test]
    fn test_global_topology_is_toroidal() {
        assert!(!GlobalTopology::<3>::Euclidean.is_toroidal());
        assert!(!GlobalTopology::<3>::Spherical.is_toroidal());
        assert!(!GlobalTopology::<3>::Hyperbolic.is_toroidal());

        let toroidal = GlobalTopology::<2>::Toroidal {
            domain: ToroidalDomain::try_new([1.0, 1.0]).unwrap(),
            mode: ToroidalConstructionMode::PeriodicImagePoint,
        };
        assert!(toroidal.is_toroidal());
    }

    #[test]
    fn test_global_topology_is_periodic() {
        assert!(!GlobalTopology::<3>::Euclidean.is_periodic());
        assert!(!GlobalTopology::<3>::Spherical.is_periodic());
        assert!(!GlobalTopology::<3>::Hyperbolic.is_periodic());

        let periodic = GlobalTopology::<2>::Toroidal {
            domain: ToroidalDomain::try_new([1.0, 1.0]).unwrap(),
            mode: ToroidalConstructionMode::PeriodicImagePoint,
        };
        assert!(periodic.is_periodic());

        let explicit = GlobalTopology::<2>::Toroidal {
            domain: ToroidalDomain::try_new([1.0, 1.0]).unwrap(),
            mode: ToroidalConstructionMode::Explicit,
        };
        assert!(!explicit.is_periodic());
    }

    #[test]
    fn test_global_topology_equality() {
        let topo1 = GlobalTopology::<3>::Euclidean;
        let topo2 = GlobalTopology::<3>::Euclidean;
        let topo3 = GlobalTopology::<3>::Spherical;

        assert_eq!(topo1, topo2);
        assert_ne!(topo1, topo3);

        let toroidal1 = GlobalTopology::<2>::Toroidal {
            domain: ToroidalDomain::try_new([1.0, 2.0]).unwrap(),
            mode: ToroidalConstructionMode::PeriodicImagePoint,
        };
        let toroidal2 = GlobalTopology::<2>::Toroidal {
            domain: ToroidalDomain::try_new([1.0, 2.0]).unwrap(),
            mode: ToroidalConstructionMode::PeriodicImagePoint,
        };
        let toroidal3 = GlobalTopology::<2>::Toroidal {
            domain: ToroidalDomain::try_new([1.0, 2.0]).unwrap(),
            mode: ToroidalConstructionMode::Explicit,
        };

        assert_eq!(toroidal1, toroidal2);
        assert_ne!(toroidal1, toroidal3);
    }

    #[test]
    fn test_global_topology_debug() {
        assert_eq!(format!("{:?}", GlobalTopology::<3>::Euclidean), "Euclidean");

        let toroidal = GlobalTopology::<2>::Toroidal {
            domain: ToroidalDomain::try_new([1.5, 2.5]).unwrap(),
            mode: ToroidalConstructionMode::PeriodicImagePoint,
        };
        let debug_str = format!("{toroidal:?}");
        assert!(debug_str.contains("Toroidal"));
        assert!(debug_str.contains("domain"));
        assert!(debug_str.contains("mode"));
    }

    #[test]
    fn test_toroidal_domain_try_new_rejects_invalid_periods() {
        let zero = ToroidalDomain::<2>::try_new([1.0, 0.0]).unwrap_err();
        assert_matches!(
            zero,
            ToroidalDomainError::InvalidPeriod { axis: 1, period }
                if period.abs() < f64::EPSILON
        );

        let negative = ToroidalDomain::<2>::try_new([-1.0, 1.0]).unwrap_err();
        assert_matches!(
            negative,
            ToroidalDomainError::InvalidPeriod { axis: 0, period }
                if period < 0.0
        );

        let nan = ToroidalDomain::<2>::try_new([f64::NAN, 1.0]).unwrap_err();
        assert_matches!(
            nan,
            ToroidalDomainError::InvalidPeriod { axis: 0, period }
                if period.is_nan()
        );

        let infinite = ToroidalDomain::<2>::try_new([1.0, f64::INFINITY]).unwrap_err();
        assert_matches!(
            infinite,
            ToroidalDomainError::InvalidPeriod { axis: 1, period }
                if period.is_infinite()
        );
    }

    #[test]
    fn test_toroidal_domain_try_from_and_into_periods_preserve_validation() {
        let domain = ToroidalDomain::<3>::try_from([1.0, 2.0, 4.0]).unwrap();
        assert_relative_eq!(domain.periods()[0], 1.0);
        assert_relative_eq!(domain.periods()[1], 2.0);
        assert_relative_eq!(domain.periods()[2], 4.0);

        let periods = domain.into_periods();
        assert_relative_eq!(periods[0], 1.0);
        assert_relative_eq!(periods[1], 2.0);
        assert_relative_eq!(periods[2], 4.0);

        let invalid = ToroidalDomain::<3>::try_from([1.0, f64::NEG_INFINITY, 4.0]).unwrap_err();
        assert_matches!(
            invalid,
            ToroidalDomainError::InvalidPeriod { axis: 1, period }
                if period.is_infinite() && period.is_sign_negative()
        );
    }

    #[test]
    fn test_global_topology_try_toroidal_parses_domain() {
        let topology =
            GlobalTopology::try_toroidal([1.0, 2.0], ToroidalConstructionMode::PeriodicImagePoint)
                .unwrap();
        assert_eq!(topology.kind(), TopologyKind::Toroidal);
        assert!(topology.is_periodic());

        let err = GlobalTopology::<2>::try_toroidal(
            [0.0, 2.0],
            ToroidalConstructionMode::PeriodicImagePoint,
        )
        .unwrap_err();
        assert_matches!(
            err,
            ToroidalDomainError::InvalidPeriod { axis: 0, period }
                if period.abs() < f64::EPSILON
        );
    }
}