stat_bench::param Namespace Reference

Namespace of parameters of benchmarks. More...

Classes
class	IParameterValueVector
	Interface of vectors of parameter values. More...
class	ParameterConfig
	Class of configurations of parameters. More...
class	ParameterDict
	Class of dictionaries of parameters. More...
class	ParameterGenerator
	Class of generators of parameter dictionaries. More...
class	ParameterName
	Class of names of parameters. More...
class	ParameterValue
	Class of values of parameters. More...
struct	ParameterValueTraits
	Class of traits of parameter values. More...
class	ParameterValueVector
	Class of vectors of parameter values. More...

Typedefs
using	ParameterValueVariant
	Type of variant of parameter values.

Functions
auto	num_threads_parameter_name () -> const ParameterName &
	Get the parameter name for the number of threads.
auto	operator!= (const ParameterName &lhs, const ParameterName &rhs) noexcept -> bool
	Compare two ParameterName objects.
auto	operator< (const ParameterName &lhs, const ParameterName &rhs) noexcept -> bool
	Compare two ParameterName objects.
auto	operator<< (std::ostream &stream, const ParameterName &val) -> std::ostream &
	Format to a stream.
auto	operator<= (const ParameterName &lhs, const ParameterName &rhs) noexcept -> bool
	Compare two ParameterName objects.
auto	operator== (const ParameterName &lhs, const ParameterName &rhs) noexcept -> bool
	Compare two ParameterName objects.
auto	operator> (const ParameterName &lhs, const ParameterName &rhs) noexcept -> bool
	Compare two ParameterName objects.
auto	operator>= (const ParameterName &lhs, const ParameterName &rhs) noexcept -> bool
	Compare two ParameterName objects.

Detailed Description

Namespace of parameters of benchmarks.

Typedef Documentation

ParameterValueVariant

using stat_bench::param::ParameterValueVariant

Initial value:

 
    std::variant<bool, std::intmax_t, std::uintmax_t, long double, std::string>

Type of variant of parameter values.

Definition at line 44 of file parameter_value.h.

Function Documentation

num_threads_parameter_name()

auto stat_bench::param::num_threads_parameter_name ( ) -> const ParameterName&

inline

Get the parameter name for the number of threads.

Returns

Parameter name.

Definition at line 34 of file num_threads_parameter_name.h.

operator!=()

auto stat_bench::param::operator!= ( const ParameterName & lhs, const ParameterName & rhs ) -> bool

inlinenodiscardnoexcept

Compare two ParameterName objects.

Parameters

[in]	lhs	Left-hand side object.
[in]	rhs	Right-hand side object.

Return values

true	The two objects are not equal.
false	The two objects are equal.

Definition at line 88 of file parameter_name.h.

operator<()

auto stat_bench::param::operator< ( const ParameterName & lhs, const ParameterName & rhs ) -> bool

inlinenodiscardnoexcept

Compare two ParameterName objects.

Parameters

[in]	lhs	Left-hand side object.
[in]	rhs	Right-hand side object.

Return values

true	The left-hand side object is less than the right-hand side object.
false	The left-hand side object is not less than the right-hand side object.

Definition at line 103 of file parameter_name.h.

operator<<()

auto stat_bench::param::operator<< ( std::ostream & stream, const ParameterName & val ) -> std::ostream&

inline

Format to a stream.

Parameters

[in,out]	stream	Stream.
[in]	val	Value.

Returns

Stream.

Definition at line 190 of file parameter_name.h.

operator<=()

auto stat_bench::param::operator<= ( const ParameterName & lhs, const ParameterName & rhs ) -> bool

inlinenodiscardnoexcept

Compare two ParameterName objects.

Parameters

[in]	lhs	Left-hand side object.
[in]	rhs	Right-hand side object.

Return values

true	The left-hand side object is less than or equal to the right-hand side object.
false	The left-hand side object is greater than the right-hand side object.

Definition at line 133 of file parameter_name.h.

operator==()

auto stat_bench::param::operator== ( const ParameterName & lhs, const ParameterName & rhs ) -> bool

inlinenodiscardnoexcept

Compare two ParameterName objects.

Parameters

[in]	lhs	Left-hand side object.
[in]	rhs	Right-hand side object.

Return values

true	The two objects are equal.
false	The two objects are not equal.

Definition at line 75 of file parameter_name.h.

operator>()

auto stat_bench::param::operator> ( const ParameterName & lhs, const ParameterName & rhs ) -> bool

inlinenodiscardnoexcept

Compare two ParameterName objects.

Parameters

[in]	lhs	Left-hand side object.
[in]	rhs	Right-hand side object.

Return values

true	The left-hand side object is greater than the right-hand side object.
false	The left-hand side object is not greater than the right-hand side object.

Definition at line 118 of file parameter_name.h.

operator>=()

auto stat_bench::param::operator>= ( const ParameterName & lhs, const ParameterName & rhs ) -> bool

inlinenodiscardnoexcept

Compare two ParameterName objects.

Parameters

[in]	lhs	Left-hand side object.
[in]	rhs	Right-hand side object.

Return values

true	The left-hand side object is greater than or equal to the right-hand side object.
false	The left-hand side object is less than the right-hand side object.

Definition at line 148 of file parameter_name.h.