module numbers.cbenchmark

Short summary

module cpyquickhelper.numbers.cbenchmark

Commom classes to benchmark implementations in C.

source on GitHub

Classes

class	truncated documentation
ExecutionStat	Holds results to compare execution time of functions.

Properties

property	truncated documentation
average	average processing time
deviation	standard deviation
max_exec	maximum execution time
min_exec	minimum execution time
number	number of executions being measured
repeat	number of times the experiment is repeated

Documentation

Commom classes to benchmark implementations in C.

class cpyquickhelper.numbers.cbenchmark.ExecutionStat(self: cpyquickhelper.numbers.cbenchmark.ExecutionStat)

Bases: pybind11_object

Holds results to compare execution time of functions.

__init__(self: cpyquickhelper.numbers.cbenchmark.ExecutionStat) → None

__str__(self: cpyquickhelper.numbers.cbenchmark.ExecutionStat) → str

usual operator

property average

average processing time

property deviation

standard deviation

property max_exec

maximum execution time

property min_exec

minimum execution time

property number

number of executions being measured

property repeat

number of times the experiment is repeated

todict(self: cpyquickhelper.numbers.cbenchmark.ExecutionStat) → Dict[str, float]

Converts the structure into a dictionary.

cpyquickhelper.numbers.cbenchmark.get_simd_available_option() → str

Returns the available compilation options for SIMD. It can simply be called with the following example:

<<<

from cpyquickhelper.numbers.cbenchmark import get_simd_available_option
print(get_simd_available_option())

>>>

    Available options:  __SSE__ __SSE2__