.. _f-cbenchmarkcpython-39-x8664-linux-gnu:

module ``numbers.cbenchmark``
=============================







Short summary
+++++++++++++

module ``cpyquickhelper.numbers.cbenchmark``

Commom classes to benchmark implementations in C.

:githublink:`%|py|0`




Classes
+++++++

+--------------------------------------------------------------------------+-------------------------------------------------------+
| class                                                                    | truncated documentation                               |
+==========================================================================+=======================================================+
| :class:`ExecutionStat <cpyquickhelper.numbers.cbenchmark.ExecutionStat>` | Holds results to compare execution time of functions. |
+--------------------------------------------------------------------------+-------------------------------------------------------+






Properties
++++++++++

+-------------------------------------------------------------------------------+--------------------------------------------+
| property                                                                      | truncated documentation                    |
+===============================================================================+============================================+
| :meth:`average <cpyquickhelper.numbers.cbenchmark.ExecutionStat.average>`     | average processing time                    |
+-------------------------------------------------------------------------------+--------------------------------------------+
| :meth:`deviation <cpyquickhelper.numbers.cbenchmark.ExecutionStat.deviation>` | standard deviation                         |
+-------------------------------------------------------------------------------+--------------------------------------------+
| :meth:`max_exec <cpyquickhelper.numbers.cbenchmark.ExecutionStat.max_exec>`   | maximum execution time                     |
+-------------------------------------------------------------------------------+--------------------------------------------+
| :meth:`min_exec <cpyquickhelper.numbers.cbenchmark.ExecutionStat.min_exec>`   | minimum execution time                     |
+-------------------------------------------------------------------------------+--------------------------------------------+
| :meth:`number <cpyquickhelper.numbers.cbenchmark.ExecutionStat.number>`       | number of executions being measured        |
+-------------------------------------------------------------------------------+--------------------------------------------+
| :meth:`repeat <cpyquickhelper.numbers.cbenchmark.ExecutionStat.repeat>`       | number of times the experiment is repeated |
+-------------------------------------------------------------------------------+--------------------------------------------+






Documentation
+++++++++++++

.. automodule:: cpyquickhelper.numbers.cbenchmark
    :members:
    :special-members: __init__
    :show-inheritance: