utils_box_stopwatch/
lib.rs

1//! # Summary
2//! A toolbox library that holds a useful collection of small unitilies written in Rust that make our life easier when writting Rust applications.
3//!
4//! # Utilities provided:
5//!
6//! ## Mathematics
7//! A collection of useful methematic methods used in various DSP and other applications
8//!
9//! ## Stopwatch and Timekeper
10//! Keep track of execution times in various points in binaries. Print records.
11//!
12//! Minimal Example:
13//! ```ignore
14//!    let mut s = TimeKeeper::init();
15//!    let mut t = TimeKeeper::init();
16//!
17//!    s.totals();
18//!
19//!    s.lap("init");
20//!
21//!    for _ in 0..5 {
22//!        std::thread::sleep(Duration::from_millis(5));
23//!        s.lap("loop");
24//!        t.lap("loop");
25//!    }
26//!    s.lap_totals("loop");
27//!    std::thread::sleep(Duration::from_millis(1234));
28//!    s.lap("after");
29//!
30//!    s.totals();
31//!    t.totals();
32//!
33//!    s.merge(t);
34//!
35//!    s.totals();
36//!
37//! ```
38//!
39
40pub mod stopwatch;