cpp-stat-bench 0.24.0
Benchmark library with statistics for C++.
Loading...
Searching...
No Matches
stat_bench::param::ParameterGenerator Class Reference

Class of generators of parameter dictionaries. More...

#include <stat_bench/param/parameter_generator.h>

+ Collaboration diagram for stat_bench::param::ParameterGenerator:

Public Member Functions

 ParameterGenerator (const std::vector< std::pair< ParameterName, std::shared_ptr< IParameterValueVector > > > &params)
 Constructor.
 
auto generate () const -> ParameterDict
 Generate the parameters.
 
auto iterate () -> bool
 Iterate once.
 

Detailed Description

Class of generators of parameter dictionaries.

Definition at line 37 of file parameter_generator.h.

Constructor & Destructor Documentation

◆ ParameterGenerator()

stat_bench::param::ParameterGenerator::ParameterGenerator ( const std::vector< std::pair< ParameterName, std::shared_ptr< IParameterValueVector > > > & params)
explicit

Constructor.

Parameters
[in]paramsParameters. (Pairs of names and vectors of values.)

Definition at line 29 of file parameter_generator.cpp.

Member Function Documentation

◆ generate()

auto stat_bench::param::ParameterGenerator::generate ( ) const -> ParameterDict
nodiscard

Generate the parameters.

Returns
Parameters.

Definition at line 52 of file parameter_generator.cpp.

◆ iterate()

auto stat_bench::param::ParameterGenerator::iterate ( ) -> bool
nodiscard

Iterate once.

Returns
Whether the next parameters exists.

Definition at line 41 of file parameter_generator.cpp.


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