Next: C++ API Reference, Previous: Common API Concepts, Up: MicroBenchmark [Contents][Index]
The top level object is called a suite (see Suite Reference) which is composed by one or more tests.
Tests (see Test Reference) are defined by the struct
micro_benchmark_test_definition. These definitions can registered
onto the suite.
Each test execution is controlled through a state object (see State Reference), where statistics are collected.
A report with the results (see Report Reference) is available once the execution has finished.
In addition to these interfaces, utility macros and functions are provided (see Utilities Reference) to reduce the boilerplate. Also, compilers sometimes need hints to not optimize away code under test (see Optimization Utilities Reference.)
MicroBenchmark is on an early stage of development. The API might change in future versions.