rpid 0.3.1

Rust Programmable Interface for Domain-Independent Dynamic Programming (RPID)
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

//! Provides [Timer] to measure elapsed time with an optional time limit.

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

/// Timer.
#[derive(Clone)]
pub struct Timer {
    start: Instant,
    elapsed_time: Duration,
    time_limit: Option<Duration>,
}

impl Default for Timer {
    fn default() -> Self {
        Self {
            start: Instant::now(),
            elapsed_time: Duration::from_secs(0),
            time_limit: None,
        }
    }
}

impl Timer {
    /// Returns a time keeper with the given time limit.
    pub fn with_time_limit(time_limit: f64) -> Self {
        Self {
            start: Instant::now(),
            elapsed_time: Duration::from_secs(0),
            time_limit: Some(Duration::from_secs_f64(time_limit)),
        }
    }

    /// Starts the time keeper.
    pub fn start(&mut self) {
        self.start = Instant::now()
    }

    /// Stops the time keeper.
    pub fn stop(&mut self) {
        self.elapsed_time += Instant::now() - self.start;
    }

    /// Returns the elapsed time.
    pub fn get_elapsed_time(&self) -> f64 {
        (self.elapsed_time + (Instant::now() - self.start)).as_secs_f64()
    }

    /// Returns the remaining time.
    pub fn get_remaining_time_limit(&self) -> Option<f64> {
        let elapsed_time = self.elapsed_time + (Instant::now() - self.start);
        self.time_limit.map(|time_limit| {
            if elapsed_time > time_limit {
                0.0
            } else {
                (time_limit - elapsed_time).as_secs_f64()
            }
        })
    }

    /// Returns whether the time limit is reached.
    pub fn check_time_limit(&self) -> bool {
        if let Some(remaining) = self.get_remaining_time_limit() {
            remaining <= 0.0
        } else {
            false
        }
    }
}