benchmark_macros.h File Reference

Definition of macros for benchmarks. More...

#include "stat_bench/bench_impl/benchmark_case_register.h"
#include "stat_bench/bench_impl/benchmark_group_register.h"
#include "stat_bench/bench_impl/case_impl.h"
#include "stat_bench/bench_impl/default_main.h"
#include "stat_bench/bench_impl/group_impl.h"
#include "stat_bench/bench_impl/measure_impl.h"
#include "stat_bench/bench_impl/unique_name.h"
#include "stat_bench/fixture_base.h"

Include dependency graph for benchmark_macros.h:

Go to the source code of this file.

Macros
#define	STAT_BENCH_CASE(GROUP_NAME, CASE_NAME)
	Macro to define a case.
#define	STAT_BENCH_CASE_F(FIXTURE_NAME, GROUP_NAME, CASE_NAME)
	Macro to define a case using a fixture.
#define	STAT_BENCH_GROUP(GROUP_NAME)
	Macro to define and configure a group.
#define	STAT_BENCH_MAIN   STAT_BENCH_IMPL_DEFAULT_MAIN
	Macro of default main function.
#define	STAT_BENCH_MEASURE()
	Macro to measure a function.
#define	STAT_BENCH_MEASURE_INDEXED( THREAD_INDEX_VAR, SAMPLE_INDEX_VAR, ITERATION_INDEX_VAR)
	Macro to measure a function.

Detailed Description

Definition of macros for benchmarks.

Definition in file benchmark_macros.h.

Macro Definition Documentation

STAT_BENCH_CASE

#define STAT_BENCH_CASE	(		GROUP_NAME,
			CASE_NAME )

Value:

    STAT_BENCH_IMPL_CASE_IMPL(STAT_BENCH_IMPL_UNIQUE_NAME(StatBenchCase),   \
        STAT_BENCH_IMPL_UNIQUE_NAME(stat_bench_case_register_), GROUP_NAME, \
        CASE_NAME)

Macro to define a case.

Parameters

[in]	GROUP_NAME	Group name.
[in]	CASE_NAME	Case name.

Examples

simple_benchmark.cpp.

Definition at line 55 of file benchmark_macros.h.

STAT_BENCH_CASE_F

#define STAT_BENCH_CASE_F	(		FIXTURE_NAME,
			GROUP_NAME,
			CASE_NAME )

Value:

    STAT_BENCH_IMPL_CASE_WITH_FIXTURE_IMPL(                                   \
        STAT_BENCH_IMPL_UNIQUE_NAME(StatBenchCase),                           \
        STAT_BENCH_IMPL_UNIQUE_NAME(stat_bench_case_register_), FIXTURE_NAME, \
        GROUP_NAME, CASE_NAME)

Macro to define a case using a fixture.

Parameters

[in]	FIXTURE_NAME	Fixture name.
[in]	GROUP_NAME	Group name.
[in]	CASE_NAME	Case name.

Examples

configure_plotting.cpp, custom_output_with_stat.cpp, custom_output_without_stat.cpp, and parameterized_benchmark.cpp.

Definition at line 67 of file benchmark_macros.h.

STAT_BENCH_GROUP

#define STAT_BENCH_GROUP

(

GROUP_NAME

)

Value:

    STAT_BENCH_IMPL_GROUP_IMPL(      \
        GROUP_NAME, STAT_BENCH_IMPL_UNIQUE_NAME(stat_bench_group_register_))

Macro to define and configure a group.

Parameters

[in]

GROUP_NAME

Group name.

This macro returns stat_bench::bench_impl::BenchmarkGroupRegister object. You can use this macro to configure a group like following:

STAT_BENCH_GROUP("group_name")
    .add_parameter_to_time_line_plot("parameter_name")
    .add_parameter_to_time_line_plot_log("another_parameter_name");

Examples

configure_plotting.cpp.

Definition at line 45 of file benchmark_macros.h.

STAT_BENCH_MAIN

#define STAT_BENCH_MAIN   STAT_BENCH_IMPL_DEFAULT_MAIN

Macro of default main function.

Definition at line 95 of file benchmark_macros.h.

STAT_BENCH_MEASURE

#define STAT_BENCH_MEASURE

(

)

Value:

    STAT_BENCH_MEASURE_INDEXED( \
        /*THREAD_INDEX_VAR*/, /*SAMPLE_INDEX_VAR*/, /*ITERATION_INDEX_VAR*/)

Macro to measure a function.

Examples

configure_plotting.cpp, custom_output_without_stat.cpp, parameterized_benchmark.cpp, and simple_benchmark.cpp.

Definition at line 88 of file benchmark_macros.h.

STAT_BENCH_MEASURE_INDEXED

#define STAT_BENCH_MEASURE_INDEXED	(		THREAD_INDEX_VAR,
			SAMPLE_INDEX_VAR,
			ITERATION_INDEX_VAR )

Value:

    STAT_BENCH_IMPL_MEASURE_IMPL(                            \
        THREAD_INDEX_VAR, SAMPLE_INDEX_VAR, ITERATION_INDEX_VAR)

Macro to measure a function.

Parameters

[in]	THREAD_INDEX_VAR	Variable name of the index of the thread.
[in]	SAMPLE_INDEX_VAR	Variable name of the index of the sample.
[in]	ITERATION_INDEX_VAR	Variable name of the index of the iteration.

Examples

custom_output_with_stat.cpp.

Definition at line 80 of file benchmark_macros.h.