Next: , Previous: , Up: Guile Report Reference   [Contents][Index]


6.3.2 Guile Exec Report Reference

Guile Internal Record: <exec-report>

This type represents a suite report.

It encapsulates micro_benchmark_exec_report underneath and a reference to the suite to controls its lifetime. Note that this name is not exported by the module, but objects of this type can be accessed through a <report>.


Guile Predicate: exec-report? object

Preconditions:

  1. None.

Effects:

  1. Check if object type is <exec-report>.

Postconditions:

  1. The value returned is #t if object obtained from a <report> object.

Guile Function: exec-report-name report

Preconditions:

  1. report was obtained through a valid call to for-each-report or fold-reports.

Effects:

  1. None.

Postconditions:

  1. The returned value is the name of the test execution associated to report.

Guile Function: exec-report-test-name report

Preconditions:

  1. report was obtained through a valid call to for-each-report or fold-reports.

Effects:

  1. None.

Postconditions:

  1. The returned value is the name used to register the test case associated to report.

Guile Function: exec-report-sizes report

Preconditions:

  1. report was obtained through a valid call to for-each-report or fold-reports.

Effects:

  1. None.

Postconditions:

  1. The returned value is the combination of dimensions used for the test execution associated to report.

Guile Function: exec-report-iterations report

Preconditions:

  1. report was obtained through a valid call to for-each-report or fold-reports.

Effects:

  1. None.

Postconditions:

  1. The returned value is the measured iterations performed by the test execution associated to report.

Guile Function: exec-report-total-iterations report

Preconditions:

  1. report was obtained through a valid call to for-each-report or fold-reports.

Effects:

  1. None.

Postconditions:

  1. The returned value is the total number of iterations performed by the test execution associated to report.

Guile Function: exec-report-total-samples report

Preconditions:

  1. report was obtained through a valid call to for-each-report or fold-reports.

Effects:

  1. None.

Postconditions:

  1. The returned value is the total number of samples gathered during the test execution associated to report.

Guile Function: exec-report-used-samples report

Preconditions:

  1. report was obtained through a valid call to for-each-report or fold-reports.

Effects:

  1. None.

Postconditions:

  1. The returned value is the number of samples used for the aggregated data calculation of the test execution associated to report.

Guile Function: exec-report-iteration-time report

Preconditions:

  1. report was obtained through a valid call to for-each-report or fold-reports.

Effects:

  1. None.

Postconditions:

  1. The returned value is the calculated aggregated data (see Guile Stats Utilities Reference) of the test execution associated to report regarding its iteration time.

Guile Function: exec-report-sample-time report

Preconditions:

  1. report was obtained through a valid call to for-each-report or fold-reports.

Effects:

  1. None.

Postconditions:

  1. The returned value is the calculated aggregated data (see Guile Stats Utilities Reference) of the test execution associated to report regarding its time per sample.

Guile Function: exec-report-sample-iterations report

Preconditions:

  1. report was obtained through a valid call to for-each-report or fold-reports.

Effects:

  1. None.

Postconditions:

  1. The returned value is the calculated aggregated data (see Guile Stats Utilities Reference) of the test execution associated to report regarding its iterations per sample.

Guile Function: exec-report-total-time report

Preconditions:

  1. report was obtained through a valid call to for-each-report or fold-reports.

Effects:

  1. None.

Postconditions:

  1. The returned value is the total time (see Guile Time Utilities Reference) of the test execution associated to report.

Guile Function: exec-report-time-samples report

Preconditions:

  1. report was obtained through a valid call to for-each-report or fold-reports.

Effects:

  1. None.

Postconditions:

  1. The returned value is the list of <time-sample> objects (see Guile Time Utilities Reference) which contain the data gathered during the test execution associated to report.


Next: Guile Report Output Reference, Previous: Guile Suite Report Reference, Up: Guile Report Reference   [Contents][Index]