stat_bench::bench_impl::BenchmarkGroup Class Reference

Class of groups of cases in benchmarks. More...

#include <stat_bench/bench_impl/benchmark_group.h>

Collaboration diagram for stat_bench::bench_impl::BenchmarkGroup:

Public Member Functions
	BenchmarkGroup (BenchmarkGroupName name)
	Constructor.
void	add (std::shared_ptr< IBenchmarkCase > bench_case)
	Add a case.
auto	cases () const noexcept -> const util::OrderedMap< BenchmarkCaseName, std::shared_ptr< IBenchmarkCase > > &
	Get cases.
auto	config () const noexcept -> const BenchmarkGroupConfig &
	Get the configuration.
auto	config () noexcept -> BenchmarkGroupConfig &
	Get the configuration.
void	filter_by (const filters::ComposedFilter &filter)
	Filter.
auto	name () const noexcept -> const BenchmarkGroupName &
	Get the group name.

Detailed Description

Class of groups of cases in benchmarks.

Definition at line 37 of file benchmark_group.h.

Constructor & Destructor Documentation

BenchmarkGroup()

stat_bench::bench_impl::BenchmarkGroup::BenchmarkGroup ( BenchmarkGroupName name )

explicit

Constructor.

Parameters

[in]

name

Name.

Definition at line 33 of file benchmark_group.cpp.

Member Function Documentation

add()

void stat_bench::bench_impl::BenchmarkGroup::add

(

std::shared_ptr< IBenchmarkCase >

bench_case

)

Add a case.

Parameters

[in]

bench_case

Case.

Definition at line 40 of file benchmark_group.cpp.

cases()

auto stat_bench::bench_impl::BenchmarkGroup::cases ( ) const -> const util::OrderedMap<BenchmarkCaseName, std::shared_ptr<IBenchmarkCase>>&

nodiscardnoexcept

Get cases.

Returns

Cases.

Definition at line 66 of file benchmark_group.cpp.

config() [1/2]

auto stat_bench::bench_impl::BenchmarkGroup::config ( ) const -> const BenchmarkGroupConfig&

nodiscardnoexcept

Get the configuration.

Returns

Configuration.

Definition at line 75 of file benchmark_group.cpp.

config() [2/2]

auto stat_bench::bench_impl::BenchmarkGroup::config ( ) -> BenchmarkGroupConfig&

nodiscardnoexcept

Get the configuration.

Returns

Configuration.

Definition at line 71 of file benchmark_group.cpp.

filter_by()

void stat_bench::bench_impl::BenchmarkGroup::filter_by

(

const filters::ComposedFilter &

filter

)

Filter.

Parameters

[in]

filter

Filter.

Definition at line 56 of file benchmark_group.cpp.

name()

auto stat_bench::bench_impl::BenchmarkGroup::name ( ) const -> const BenchmarkGroupName&

nodiscardnoexcept

Get the group name.

Returns

Group name.

Definition at line 36 of file benchmark_group.cpp.

---

The documentation for this class was generated from the following files:

• include/stat_bench/bench_impl/benchmark_group.h
• src/stat_bench/bench_impl/benchmark_group.cpp