rustyphoenixmicrobenchmark 1.4.0

Toolset for function micro-benchmarking. Rust equivalent of C++ [PhoenixMicroBenchmark](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS2/test-benchmark/PhoenixMicroBenchmark)
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

/***************************************
	Auteur : Pierre Aubert
	Mail : pierre.aubert@lapp.in2p3.fr
	Licence : CeCILL-C
****************************************/

///Ellapsed time of a computing
#[derive(Debug, Default, Clone)]
pub struct PEllapsedTime{
	///Number of elements used for these computing times
	p_nb_element: usize,
	///Minimum ellapsed time of the computing in nanoseconds
	p_min_ellapsed_time_ns: f64,
	///Maximum ellaped time of the computing in nanoseconds
	p_max_ellapsed_time_ns: f64,
	///Median ellaped time of the computing in nanoseconds
	p_median_ellapsed_time_ns: f64,
	///First quartile time in ns
	p_first_quartile_time_ns: f64,
	///Last quartile time in ns
	p_last_quartile_time_ns: f64,
}

impl PEllapsedTime{
	///Constructor of a PEllapsedTime
	/// # Parameters
	/// - `nb_element` : number of elements computed
	/// - `min_ellapsed_time_ns` : minimum ellapsed time of the computing in nanoseconds
	/// - `max_ellapsed_time_ns` : maximum ellapsed time of the computing in nanoseconds
	/// - `median_ellapsed_time_ns` : median ellaped time of the computing in nanoseconds
	/// - `first_quartile_time_ns` : first quartile ellaped time of the computing in nanoseconds
	/// - `last_quartile_time_ns` : last quartile time of the computing in nanoseconds
	pub fn new(nb_element: usize, min_ellapsed_time_ns: f64, max_ellapsed_time_ns: f64, median_ellapsed_time_ns: f64,
		first_quartile_time_ns: f64, last_quartile_time_ns: f64) -> Self{
		PEllapsedTime{
			p_nb_element: nb_element,
			p_min_ellapsed_time_ns: min_ellapsed_time_ns,
			p_max_ellapsed_time_ns: max_ellapsed_time_ns,
			p_median_ellapsed_time_ns: median_ellapsed_time_ns,
			p_first_quartile_time_ns: first_quartile_time_ns,
			p_last_quartile_time_ns: last_quartile_time_ns
		}
	}
	///Get the number of elements
	/// # Returns
	/// Number of elements
	pub fn get_nb_element(&self) -> usize{
		self.p_nb_element
	}
	///Get the minimum ellapsed time of the computing in nanoseconds
	/// # Returns
	/// Minimum ellapsed time of the computing in nanoseconds
	pub fn get_min_ellapsed_time_ns(&self) -> f64{
		self.p_min_ellapsed_time_ns
	}
	///Get the maximum ellapsed time of the computing in nanoseconds
	/// # Returns
	/// Maximum ellapsed time of the computing in nanoseconds
	pub fn get_max_ellapsed_time_ns(&self) -> f64{
		self.p_max_ellapsed_time_ns
	}
	///Get the median ellapsed time of the computing in nanoseconds
	/// # Returns
	/// Median ellapsed time of the computing in nanoseconds
	pub fn get_median_ellapsed_time_ns(&self) -> f64{
		self.p_median_ellapsed_time_ns
	}
	///Get the first quartile ellapsed time of the computing in nanoseconds
	/// # Returns
	/// First quartile ellapsed time of the computing in nanoseconds
	pub fn get_first_quartile_ellapsed_time_ns(&self) -> f64{
		self.p_first_quartile_time_ns
	}
	///Get the first quartile ellapsed time of the computing in nanoseconds
	/// # Returns
	/// First quartile ellapsed time of the computing in nanoseconds
	pub fn get_last_quartile_ellapsed_time_ns(&self) -> f64{
		self.p_last_quartile_time_ns
	}
}