map2fig 0.7.7

Fast, publication-quality HEALPix sky map visualization in Rust
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

//! Performance diagnostics and profiling module.
//!
//! Provides instrumentation for measuring:
//! - Cache hit/miss rates
//! - I/O time vs. computation time
//! - Bottleneck identification

use std::time::{Duration, Instant};

/// Global profiling state - tracks cache hits/misses and timing
pub struct ProfileStats {
    /// Number of successful cache lookups
    pub cache_hits: usize,
    /// Number of cache misses (required FITS parsing)
    pub cache_misses: usize,
    /// Total time spent in FITS parsing
    pub fits_parse_time: Duration,
    /// Total time spent in column extraction
    pub column_extract_time: Duration,
    /// Number of FITS files processed
    pub files_processed: usize,
}

impl Default for ProfileStats {
    fn default() -> Self {
        Self {
            cache_hits: 0,
            cache_misses: 0,
            fits_parse_time: Duration::ZERO,
            column_extract_time: Duration::ZERO,
            files_processed: 0,
        }
    }
}

impl ProfileStats {
    pub fn print_summary(&self) {
        let total_cache_ops = self.cache_hits + self.cache_misses;
        let hit_rate = if total_cache_ops > 0 {
            100.0 * self.cache_hits as f64 / total_cache_ops as f64
        } else {
            0.0
        };

        eprintln!("\n=== I/O Profiling Summary ===");
        eprintln!("Files processed:      {}", self.files_processed);
        eprintln!(
            "Cache operations:     {} ({} hits, {} misses)",
            total_cache_ops, self.cache_hits, self.cache_misses
        );
        eprintln!("Cache hit rate:       {:.1}%", hit_rate);
        eprintln!(
            "FITS parse time:      {:.3}s ({:.1}% of total)",
            self.fits_parse_time.as_secs_f64(),
            100.0 * self.fits_parse_time.as_secs_f64()
                / (self.fits_parse_time.as_secs_f64() + self.column_extract_time.as_secs_f64())
        );
        eprintln!(
            "Column extract time:  {:.3}s",
            self.column_extract_time.as_secs_f64()
        );
        eprintln!(
            "Total I/O time:       {:.3}s",
            (self.fits_parse_time + self.column_extract_time).as_secs_f64()
        );
    }
}

/// Thread-local profiling state
pub struct ScopedTimer {
    start: Instant,
    recorded_time: Option<Duration>,
}

impl ScopedTimer {
    /// Create a new timer starting now
    pub fn new() -> Self {
        Self {
            start: Instant::now(),
            recorded_time: None,
        }
    }

    /// Stop the timer and return the elapsed duration
    pub fn elapsed(&mut self) -> Duration {
        let elapsed = self.start.elapsed();
        self.recorded_time = Some(elapsed);
        elapsed
    }

    /// Get the recorded time without stopping
    pub fn get_elapsed(&self) -> Duration {
        self.start.elapsed()
    }
}

impl Default for ScopedTimer {
    fn default() -> Self {
        Self::new()
    }
}

impl Drop for ScopedTimer {
    fn drop(&mut self) {
        if let Some(elapsed) = self.recorded_time {
            // Optional: log on drop if desired
            let _ = elapsed;
        }
    }
}

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

    #[test]
    fn test_timer() {
        let mut timer = ScopedTimer::new();
        std::thread::sleep(Duration::from_millis(10));
        let elapsed = timer.elapsed();
        assert!(elapsed >= Duration::from_millis(10));
    }

    #[test]
    fn test_profile_stats() {
        let stats = ProfileStats {
            cache_hits: 5,
            cache_misses: 1,
            fits_parse_time: Duration::from_millis(100),
            column_extract_time: Duration::from_millis(200),
            ..Default::default()
        };

        let total = stats.cache_hits + stats.cache_misses;
        assert_eq!(total, 6);

        // Hit rate should be 5/6 ≈ 83.3%
        let hit_rate = 100.0 * stats.cache_hits as f64 / total as f64;
        assert!(hit_rate > 83.0 && hit_rate < 84.0);
    }
}