ankerl::nanobench::templates Namespace Reference

Functions
char const *	csv () noexcept
	CSV data for the benchmark results.
char const *	htmlBoxplot () noexcept
	HTML output that uses plotly to generate an interactive boxplot chart. See the tutorial for an example output.
char const *	pyperf () noexcept
	Output in pyperf compatible JSON format, which can be used for more analyzations.
char const *	json () noexcept
	Template to generate JSON data.

Function Documentation

csv()

char const * ankerl::nanobench::templates::csv ( )

noexcept

CSV data for the benchmark results.

Generates a comma-separated values dataset. First line is the header, each following line is a summary of each benchmark run.

embed:rst
See the tutorial at :ref:`tutorial-template-csv` for an example.

htmlBoxplot()

char const * ankerl::nanobench::templates::htmlBoxplot ( )

noexcept

HTML output that uses plotly to generate an interactive boxplot chart. See the tutorial for an example output.

The output uses only the elapsed wall clock time, and displays each epoch as a single dot.

embed:rst
See the tutorial at :ref:`tutorial-template-html` for an example.

See also

ankerl::nanobench::render()

json()

char const * ankerl::nanobench::templates::json ( )

noexcept

Template to generate JSON data.

The generated JSON data contains all data that has been generated. All times are as double values, in seconds. The output can get quite large.

embed:rst
See the tutorial at :ref:`tutorial-template-json` for an example.

Here is the caller graph for this function:

pyperf()

char const * ankerl::nanobench::templates::pyperf ( )

noexcept

Output in pyperf compatible JSON format, which can be used for more analyzations.

embed:rst
See the tutorial at :ref:`tutorial-template-pyperf` for an example how to further analyze the output.