IMP
2.3.1
The Integrative Modeling Platform
|
Support for developing and analyzing benchmarks of IMP code. More...
Support for developing and analyzing benchmarks of IMP code.
All benchmarks are automatically linked against this module.
Author(s): Daniel Russel
Maintainer: benmwebb
License: LGPL This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
Publications:
Classes | |
class | Profiler |
Functions | |
int | get_return_value () |
void | report (std::string benchmark, std::string algorithm, double time, double check) |
Report a benchmark result in a standard way. More... | |
Standard module functions | |
All | |
std::string | get_module_version () |
std::string | get_module_name () |
std::string | get_data_path (std::string file_name) |
Return the full path to installed data. More... | |
std::string | get_example_path (std::string file_name) |
Return the path to installed example data for this module. More... | |
std::string IMP::benchmark::get_data_path | ( | std::string | file_name | ) |
Return the full path to installed data.
Each module has its own data directory, so be sure to use the version of this function in the correct module. To read the data file "data_library" that was placed in the data
directory of module "mymodule", do something like
This will ensure that the code works when IMP
is installed or used via the setup_environment.sh
script.
std::string IMP::benchmark::get_example_path | ( | std::string | file_name | ) |
Return the path to installed example data for this module.
Each module has its own example directory, so be sure to use the version of this function in the correct module. For example to read the file example_protein.pdb
located in the examples
directory of the IMP::atom module, do
This will ensure that the code works when IMP
is installed or used via the setup_environment.sh
script.
void IMP::benchmark::report | ( | std::string | benchmark, |
std::string | algorithm, | ||
double | time, | ||
double | check | ||
) |
Report a benchmark result in a standard way.
[in] | benchmark | the name of the benchmark being run |
[in] | algorithm | the name of the particular algorithm used to solve the problem |
[in] | time | the time it took (perhaps normalized) |
[in] | check | a check value to print out to see if the calculation was OK |