Changeset 30886 in project


Ignore:
Timestamp:
05/17/14 08:07:52 (6 years ago)
Author:
certainty
Message:

micro-benchmark: documented API changes

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/micro-benchmark

    r30584 r30886  
    3636
    3737<parameter>current-benchmark-iterations</parameter>
    38 The amount of iterations that are used in '''benchmark-run'''.
     38The amount of iterations that are used in '''benchmark-run'''. This defaults to 100.
    3939
    4040<syntax>(benchmark-measure ?code ...)</syntax>
    41 Runs the '''?code''' once and returns a pair.
    42 
    43 * car - the runtime in microseconds
    44 * cdr - the result of '''?code'''
     41Runs the '''?code''' once and returns the runtime in microseconds.
    4542
    4643<syntax>(benchmark-run [iterations] ?code ...)</syntax>
     
    4946* min - the minimum runtime of all iterations in microseconds
    5047* max - the maximum runtime of all iterations in microseconds
    51 * avg - the average runtime of all iterations in microseconds
    52 * runtimes - the list of all runtimes in microseconds
    53 * values  - the list of results
     48* mean - the average runtime of all iterations in microseconds
     49* standard-deviation - the sample standard deviation for the given runtimes
    5450
    5551If '''iterations''' is not given then '''curren-benchmark-iterations''' is used.
    56 
    57 === See also
    58 To work with the data and derive information you might find [[/egg/statistics|statistics]] useful
    59 
    6052
    6153=== License
Note: See TracChangeset for help on using the changeset viewer.