• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright 2016 Ismael Jimenez Martinez. All rights reserved.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 //     http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 // Source project : https://github.com/ismaelJimenez/cpp.leastsq
16 // Adapted to be used with google benchmark
17 
18 #ifndef COMPLEXITY_H_
19 #define COMPLEXITY_H_
20 
21 #include <string>
22 #include <vector>
23 
24 #include "benchmark/benchmark_api.h"
25 #include "benchmark/reporter.h"
26 
27 namespace benchmark {
28 
29 // Return a vector containing the mean and standard devation information for
30 // the specified list of reports. If 'reports' contains less than two
31 // non-errored runs an empty vector is returned
32 std::vector<BenchmarkReporter::Run> ComputeStats(
33     const std::vector<BenchmarkReporter::Run>& reports);
34 
35 // Return a vector containing the bigO and RMS information for the specified
36 // list of reports. If 'reports.size() < 2' an empty vector is returned.
37 std::vector<BenchmarkReporter::Run> ComputeBigO(
38     const std::vector<BenchmarkReporter::Run>& reports);
39 
40 // This data structure will contain the result returned by MinimalLeastSq
41 //   - coef        : Estimated coeficient for the high-order term as
42 //                   interpolated from data.
43 //   - rms         : Normalized Root Mean Squared Error.
44 //   - complexity  : Scalability form (e.g. oN, oNLogN). In case a scalability
45 //                   form has been provided to MinimalLeastSq this will return
46 //                   the same value. In case BigO::oAuto has been selected, this
47 //                   parameter will return the best fitting curve detected.
48 
49 struct LeastSq {
LeastSqLeastSq50   LeastSq() : coef(0.0), rms(0.0), complexity(oNone) {}
51 
52   double coef;
53   double rms;
54   BigO complexity;
55 };
56 
57 // Function to return an string for the calculated complexity
58 std::string GetBigOString(BigO complexity);
59 
60 }  // end namespace benchmark
61 #endif  // COMPLEXITY_H_
62