hydro2-network-performance 0.1.0

Performance tracking for network execution in the hydro2 ecosystem.
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

// ---------------- [ File: src/stats.rs ]
crate::ix!();

/// Tracks performance statistics for network execution.
#[derive(Setters,Getters,Debug)]
#[getset(get="pub",set="pub")]
pub struct PerformanceStats {

    /// The instant when the network execution started.
    start_time: Instant,

    /// The instant when the network execution ended.
    end_time: Option<Instant>,

    /// The total number of operators executed.
    operators_executed: usize,

    /// Running measure of peak memory usage in bytes.
    peak_memory_bytes:  usize,
}

impl PerformanceStats {
    /// Initializes performance measurement.
    pub fn start() -> Self {
        Self {
            start_time: Instant::now(),
            end_time: None,
            operators_executed: 0,
            peak_memory_bytes: 0,
        }
    }

    /// Marks the end of measurement.
    pub fn end(&mut self) {
        self.end_time = Some(Instant::now());
    }

    /// Returns the total execution time, if ended.
    pub fn total_duration(&self) -> Option<Duration> {
        match self.end_time {
            Some(t) => Some(t.duration_since(self.start_time)),
            None => None,
        }
    }
}