---

4.4.4 Output Reference

This section documents the output of the reported data.

C Data Type: micro_benchmark_output_type { MICRO_BENCHMARK_CONSOLE_OUTPUT, MICRO_BENCHMARK_TEXT_OUTPUT, MICRO_BENCHMARK_LISP_OUTPUT } ¶

Predefined output formats:

• See Console Output for a more detailed description of the format produced by MICRO_BENCHMARK_CONSOLE_OUTPUT.
• See Text Output for a more detailed description of the format produced by MICRO_BENCHMARK_TEXT_OUTPUT.
• See Lisp Output for a more detailed description of the format produced by MICRO_BENCHMARK_LISP_OUTPUT.

C Data Type: micro_benchmark_output_stat { MICRO_BENCHMARK_STAT_NONE, MICRO_BENCHMARK_STAT_MEAN, MICRO_BENCHMARK_STAT_VARIANCE, MICRO_BENCHMARK_STAT_STD_DEVIATION, MICRO_BENCHMARK_STAT_BASIC, MICRO_BENCHMARK_STAT_ALL } ¶

Provided statistical values.

• The values can be joined with | to select both values.
• The value BASIC is equivalent to MEAN | STD_DEVIATION.
• The value ALL is is equivalent to MEAN | VARIANCE | STD_DEVIATION.

C Data Type: micro_benchmark_output_values { bool self_test, bool size_constraints, bool total_time, bool total_iterations, bool iterations, bool total_samples, bool samples, bool extra_data, micro_benchmark_output_stat iteration_times, micro_benchmark_output_stat sample_times, micro_benchmark_output_stat batch_stats } ¶

Each field determines the output of a value of the report.

C Report Function: micro_benchmark_output_values micro_benchmark_get_default_output_values () ¶

Preconditions:

1. No additional precondition.

Effects:

1. None.

Postconditions:

1. If micro_benchmark_set_default_output_values was called, the returned value is equivalent to the parameter provided to the last call in effect of micro_benchmark_set_default_output_values.

C Output Function: void micro_benchmark_set_default_output_values (micro_benchmark_output_values new_values) ¶

Preconditions:

1. No additional precondition.

Effects:

1. Change default output values.

Postconditions:

1. The output functions that do not accept a parameter of type micro_benchmark_output_values will use the values provided by new_values to the last call of this function.

C Output Function: void micro_benchmark_write_report (micro_benchmark_report report, FILE *out, micro_benchmark_output_type type) ¶

Preconditions:

1. report must have been obtained as the return value of a call to micro_benchmark_test_report_get_exec_report.
2. out is ready to receive an indeterminate number of characters.

Effects:

1. Write the values from report determined by micro_benchmark_get_default_output_values on out with output format type.

Postconditions:

1. out has successfully received the formatted data stored on report.

C Output Function: void micro_benchmark_write_custom_report (micro_benchmark_report report, FILE *out, micro_benchmark_output_type type, const micro_benchmark_output_values *values) ¶

Preconditions:

1. report must have been obtained as the return value of a call to micro_benchmark_test_report_get_exec_report.
2. out is ready to receive an indeterminate number of characters.

Effects:

1. Write the values from report determined by values on out with the output format type.

Postconditions:

1. out has successfully received the formatted data stored on report.

C Report Function: void micro_benchmark_print_report (micro_benchmark_report report) ¶

Preconditions:

1. report must have been obtained as the return value of a call to micro_benchmark_test_report_get_exec_report.
2. The standard output is ready to receive an indeterminate number of characters.

Effects:

1. Write the values from report determined by micro_benchmark_get_default_output_values on the standard output with the console format.

Postconditions:

1. The standard output has successfully received the formatted data stored on report.

C Output Function: void micro_benchmark_print_custom_report (micro_benchmark_report report, const micro_benchmark_output_values *values) ¶

Preconditions:

1. report must have been obtained as the return value of a call to micro_benchmark_test_report_get_exec_report.
2. The standard output is ready to receive an indeterminate number of characters.

Effects:

1. Write the values from report determined by values on out with the console output format.

Postconditions:

1. The standard output has successfully received the formatted data stored on report.