xref: /aosp_15_r20/external/ComputeLibrary/tests/framework/instruments/InstrumentsStats.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1*c217d954SCole Faust /*
2*c217d954SCole Faust  * Copyright (c) 2018 Arm Limited.
3*c217d954SCole Faust  *
4*c217d954SCole Faust  * SPDX-License-Identifier: MIT
5*c217d954SCole Faust  *
6*c217d954SCole Faust  * Permission is hereby granted, free of charge, to any person obtaining a copy
7*c217d954SCole Faust  * of this software and associated documentation files (the "Software"), to
8*c217d954SCole Faust  * deal in the Software without restriction, including without limitation the
9*c217d954SCole Faust  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10*c217d954SCole Faust  * sell copies of the Software, and to permit persons to whom the Software is
11*c217d954SCole Faust  * furnished to do so, subject to the following conditions:
12*c217d954SCole Faust  *
13*c217d954SCole Faust  * The above copyright notice and this permission notice shall be included in all
14*c217d954SCole Faust  * copies or substantial portions of the Software.
15*c217d954SCole Faust  *
16*c217d954SCole Faust  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17*c217d954SCole Faust  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18*c217d954SCole Faust  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19*c217d954SCole Faust  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20*c217d954SCole Faust  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21*c217d954SCole Faust  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22*c217d954SCole Faust  * SOFTWARE.
23*c217d954SCole Faust  */
24*c217d954SCole Faust #ifndef ARM_COMPUTE_TEST_INSTRUMENTSMAP
25*c217d954SCole Faust #define ARM_COMPUTE_TEST_INSTRUMENTSMAP
26*c217d954SCole Faust 
27*c217d954SCole Faust #include "Measurement.h"
28*c217d954SCole Faust 
29*c217d954SCole Faust #include <vector>
30*c217d954SCole Faust 
31*c217d954SCole Faust namespace arm_compute
32*c217d954SCole Faust {
33*c217d954SCole Faust namespace test
34*c217d954SCole Faust {
35*c217d954SCole Faust namespace framework
36*c217d954SCole Faust {
37*c217d954SCole Faust /** Generate common statistics for a set of measurements
38*c217d954SCole Faust      */
39*c217d954SCole Faust class InstrumentsStats
40*c217d954SCole Faust {
41*c217d954SCole Faust public:
42*c217d954SCole Faust     /** Compute statistics for the passed set of measurements
43*c217d954SCole Faust      *
44*c217d954SCole Faust      * @param[in] measurements The measurements to process
45*c217d954SCole Faust      */
46*c217d954SCole Faust     InstrumentsStats(const std::vector<Measurement> &measurements);
47*c217d954SCole Faust     /** The measurement with the minimum value
48*c217d954SCole Faust              */
min()49*c217d954SCole Faust     const Measurement &min() const
50*c217d954SCole Faust     {
51*c217d954SCole Faust         return *_min;
52*c217d954SCole Faust     }
53*c217d954SCole Faust     /** The measurement with the maximum value
54*c217d954SCole Faust              */
max()55*c217d954SCole Faust     const Measurement &max() const
56*c217d954SCole Faust     {
57*c217d954SCole Faust         return *_max;
58*c217d954SCole Faust     }
59*c217d954SCole Faust     /** The median measurement
60*c217d954SCole Faust              */
median()61*c217d954SCole Faust     const Measurement &median() const
62*c217d954SCole Faust     {
63*c217d954SCole Faust         return *_median;
64*c217d954SCole Faust     }
65*c217d954SCole Faust     /** The average of all the measurements
66*c217d954SCole Faust              */
mean()67*c217d954SCole Faust     const Measurement::Value &mean() const
68*c217d954SCole Faust     {
69*c217d954SCole Faust         return _mean;
70*c217d954SCole Faust     }
71*c217d954SCole Faust     /** The relative standard deviation of the measurements
72*c217d954SCole Faust              */
relative_standard_deviation()73*c217d954SCole Faust     double relative_standard_deviation() const
74*c217d954SCole Faust     {
75*c217d954SCole Faust         return _stddev;
76*c217d954SCole Faust     }
77*c217d954SCole Faust 
78*c217d954SCole Faust private:
79*c217d954SCole Faust     const Measurement *_min;
80*c217d954SCole Faust     const Measurement *_max;
81*c217d954SCole Faust     const Measurement *_median;
82*c217d954SCole Faust     Measurement::Value _mean;
83*c217d954SCole Faust     double             _stddev;
84*c217d954SCole Faust };
85*c217d954SCole Faust 
86*c217d954SCole Faust } // namespace framework
87*c217d954SCole Faust } // namespace test
88*c217d954SCole Faust } // namespace arm_compute
89*c217d954SCole Faust #endif /* ARM_COMPUTE_TEST_INSTRUMENTSMAP */
90