IMP logo
IMP Reference Guide  2.14.0
The Integrative Modeling Platform
benchmark/utility.h
Go to the documentation of this file.
1 /**
2  * \file IMP/benchmark/utility.h
3  * \brief Various utilities for benchmarking
4  *
5  * Copyright 2007-2020 IMP Inventors. All rights reserved.
6  *
7  */
8 
9 #ifndef IMPBENCHMARK_UTILITY_H
10 #define IMPBENCHMARK_UTILITY_H
11 
12 #include <IMP/benchmark/benchmark_config.h>
13 #include <string>
14 
15 IMPBENCHMARK_BEGIN_NAMESPACE
16 
17 //! Report a benchmark result in a standard way.
18 /** \param[in] benchmark the name of the benchmark being run
19  \param[in] algorithm the name of the particular algorithm
20  used to solve the problem
21  \param[in] time the time it took (perhaps normalized)
22  \param[in] check a check value to print out to see if the calculation was OK
23 */
24 IMPBENCHMARKEXPORT void report(std::string benchmark, std::string algorithm,
25  double time, double check);
26 
27 #ifndef IMP_DOXYGEN
28 IMPBENCHMARKEXPORT void report(std::string benchmark, double time,
29  double check);
30 #endif
31 
32 IMPBENCHMARKEXPORT int get_return_value();
33 
34 IMPBENCHMARK_END_NAMESPACE
35 
36 #endif /* IMPBENCHMARK_UTILITY_H */
void report(std::string benchmark, std::string algorithm, double time, double check)
Report a benchmark result in a standard way.