sparse-ir 0.8.4

Rust implementation of SparseIR functionality
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

//! Common trait definitions for SparseIR

/// Statistics type enumeration
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Statistics {
    Fermionic,
    Bosonic,
}

/// Statistics type trait for compile-time type-level distinction
///
/// # Safety
/// Types implementing this trait must be zero-sized types (ZST) used only as
/// compile-time markers. The `Default` bound ensures safe instantiation.
pub trait StatisticsType: Copy + Default {
    const STATISTICS: Statistics;
}

/// Fermionic statistics marker type
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub struct Fermionic;

impl StatisticsType for Fermionic {
    const STATISTICS: Statistics = Statistics::Fermionic;
}

/// Bosonic statistics marker type
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub struct Bosonic;

impl StatisticsType for Bosonic {
    const STATISTICS: Statistics = Statistics::Bosonic;
}

/// Trait for types that can represent statistics at runtime
pub trait StatisticsMarker {
    fn statistics() -> Statistics;
}

impl StatisticsMarker for Fermionic {
    fn statistics() -> Statistics {
        Statistics::Fermionic
    }
}

impl StatisticsMarker for Bosonic {
    fn statistics() -> Statistics {
        Statistics::Bosonic
    }
}

/// Utility functions for statistics
impl Statistics {
    /// Check if this statistics type is fermionic
    pub fn is_fermionic(self) -> bool {
        matches!(self, Statistics::Fermionic)
    }

    /// Check if this statistics type is bosonic
    pub fn is_bosonic(self) -> bool {
        matches!(self, Statistics::Bosonic)
    }

    /// Get the string representation of the statistics
    pub fn as_str(self) -> &'static str {
        match self {
            Statistics::Fermionic => "fermionic",
            Statistics::Bosonic => "bosonic",
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_statistics_type_trait() {
        assert_eq!(Fermionic::STATISTICS, Statistics::Fermionic);
        assert_eq!(Bosonic::STATISTICS, Statistics::Bosonic);
    }

    #[test]
    fn test_statistics_marker_trait() {
        assert_eq!(Fermionic::statistics(), Statistics::Fermionic);
        assert_eq!(Bosonic::statistics(), Statistics::Bosonic);
    }

    #[test]
    fn test_statistics_utility_methods() {
        assert!(Statistics::Fermionic.is_fermionic());
        assert!(!Statistics::Fermionic.is_bosonic());
        assert!(!Statistics::Bosonic.is_fermionic());
        assert!(Statistics::Bosonic.is_bosonic());

        assert_eq!(Statistics::Fermionic.as_str(), "fermionic");
        assert_eq!(Statistics::Bosonic.as_str(), "bosonic");
    }
}