use-hypersphere 0.0.6

Higher-dimensional sphere primitives for the RustUse geometry workspace
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

#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

/// An n-sphere represented by its topological dimension and radius.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct Hypersphere<const N: usize> {
    radius: f64,
}

impl<const N: usize> Hypersphere<N> {
    /// Creates an n-sphere with a positive finite radius.
    #[must_use]
    pub const fn new(radius: f64) -> Option<Self> {
        if radius.is_finite() && radius > 0.0 {
            Some(Self { radius })
        } else {
            None
        }
    }

    /// Returns the n-sphere dimension.
    #[must_use]
    pub const fn dimension(self) -> usize {
        N
    }

    /// Returns the ambient Euclidean dimension.
    #[must_use]
    pub const fn ambient_dimension(self) -> usize {
        N + 1
    }

    /// Returns the radius.
    #[must_use]
    pub const fn radius(self) -> f64 {
        self.radius
    }
}

/// A 3-sphere, the boundary of a four-dimensional ball.
pub type ThreeSphere = Hypersphere<3>;

#[cfg(test)]
mod tests {
    use super::{Hypersphere, ThreeSphere};

    #[test]
    fn stores_hypersphere_metadata() {
        let hypersphere = Hypersphere::<4>::new(2.0).expect("valid hypersphere");
        let three_sphere = ThreeSphere::new(1.5).expect("valid 3-sphere");

        assert_eq!(hypersphere.dimension(), 4);
        assert_eq!(hypersphere.ambient_dimension(), 5);
        assert_eq!(three_sphere.dimension(), 3);
        assert_eq!(three_sphere.radius(), 1.5);
        assert_eq!(Hypersphere::<2>::new(f64::NAN), None);
    }
}