IMP  2.0.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-2013 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 calc was ok
23 */
24 IMPBENCHMARKEXPORT void report(std::string benchmark,
25  std::string algorithm, double time,
26  double check);
27 
28 #ifndef IMP_DOXYGEN
29 IMPBENCHMARKEXPORT void report(std::string benchmark, double time,
30  double check);
31 #endif
32 
33 IMPBENCHMARKEXPORT int get_return_value();
34 
35 IMPBENCHMARK_END_NAMESPACE
36 
37 #endif /* IMPBENCHMARK_UTILITY_H */