IMP  2.1.1
The Integrative Modeling Platform
IMP::benchmark Namespace Reference

See IMP.benchmark for more information.

Classes

class  Profiler
 

Functions

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...
 
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 methods

All IMP modules have a set of standard methods to help get information about the module and about files associated with the module.

std::string get_module_version ()
 
std::string get_module_name ()
 

Function Documentation

std::string IMP::benchmark::get_data_path ( std::string  file_name)

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

std::ifstream in(IMP::mymodule::get_data_path("data_library"));

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)

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

model));

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 
)
Parameters
[in]benchmarkthe name of the benchmark being run
[in]algorithmthe name of the particular algorithm used to solve the problem
[in]timethe time it took (perhaps normalized)
[in]checka check value to print out to see if the calc was ok