Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

Benchmarking macros
[Concept]


Detailed Description

Macros used by the benchmark.


Defines

#define START_SECTION(name, weight)
#define END_SECTION
#define STATUS(a)
 Status output.
#define START_TIMER
 Start the timer.
#define STOP_TIMER
 Stop the timer.
#define START_BENCHMARK(class_name, overall_weight, version)
 Program body for the benchmark.
#define END_BENCHMARK
 End of the test program.


Define Documentation

#define END_BENCHMARK

End of the test program.

#define END_SECTION

End of a benchmark section.

#define START_BENCHMARK ( class_name,
overall_weight,
version   ) 

Program body for the benchmark.

The parameter weight determines the overall weight of this test in the accumulated benchmark (OpenMSStones).

#define START_SECTION ( name,
weight   ) 

Start a new benchmark section. The argument weight determines the weighting factor of the section.

#define START_TIMER

Start the timer.

This macro is used to determine the running time of a set of commands. It may be used in benchmarks and requires a prior invocation of the START_BENCHMARK() macro. All commands that are between the START_TIMER() and the STOP_TIMER() command contribute to the overall running time of the benchmark.

#define STATUS (  ) 

Value:

if (BENCHMARK::verbose > 0)\
  {\
    std::cout << "  status: " << a << std::endl;\
  }
Status output.

Print debugging information if called with -v.

#define STOP_TIMER

Stop the timer.

This macro is used to determine the running time of a set of commands. It may be used in benchmarks and requires a prior invocation of the START_BENCHMARK() and START_TIMER() macros. All commands that are between the START_TIMER() and the STOP_TIMER() command contribute to the overall running time of the benchmark.


Generated Tue Apr 1 15:36:40 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1