Changeset 39371 in project


Ignore:
Timestamp:
11/24/20 02:44:43 (2 months ago)
Author:
Kon Lovett
Message:

fix arg lists

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/5/micro-stats

    r39358 r39371  
    1717</enscript>
    1818
     19=== Types
     20
    1921==== seq
    2022==== binary-predicate
     
    3133<procedure>(generate-statistics SEQ [SET-ID]) -> statistics-alist</procedure>
    3234
    33 : {{SEQ}} ; {{(seq-of real)}} ; SEQ of all iterations, in microseconds
    34 : {{SET-ID}} ; {{symbol}} ; {{'normal}}
     35; {{SEQ}} : {{(seq-of real)}} ; SEQ of all iterations, in microseconds
     36; {{SET-ID}} : {{symbol}} ; {{'normal}}
    3537
    3638Returns an {{alist}} with the following:
    3739
    38 : size ; the count of the {{SEQ}}
    39 : min ; the minimum runtime of the {{SEQ}}
    40 : max ; the maximum runtime of the {{SEQ}}
    41 : mean ; arithmetic-mean alias
    42 : arithmetic-mean : the arithmetic average runtime of the {{SEQ}}
    43 : sd ; standard-deviation alias
    44 : sigma ; standard-deviation alias
    45 : standard-deviation ; the standard deviation for the {{SEQ}}
     40; {{size}} : the count of the {{SEQ}}
     41; {{min}} : the minimum runtime of the {{SEQ}}
     42; {{max}} : the maximum runtime of the {{SEQ}}
     43; {{mean}} : arithmetic-mean alias
     44; {{arithmetic-mean}} : the arithmetic average runtime of the {{SEQ}}
     45; {{sd}} : standard-deviation alias
     46; {{sigma}} : standard-deviation alias
     47; {{standard-deviation}} : the standard deviation for the {{SEQ}}
    4648
    4749When {{verbose}} adds the following:
    4850
    49 : 95th ; the 95th percentile runtime of the {{SEQ}}
    50 : harmonic-mean ; the harmonic average runtime of the {{SEQ}}
    51 : geometric-mean ; the geometric average runtime of the {{SEQ}}
    52 : median ; the median runtime of the {{SEQ}}
    53 : mode ; the mode runtime of the {{SEQ}}
    54 : var ; variance alias
    55 : sigma^2 ; variance alias
    56 : variance ; the variance for the {{SEQ}}
     51; {{95th}} : the 95th percentile runtime of the {{SEQ}}
     52; {{harmonic-mean}} : the harmonic average runtime of the {{SEQ}}
     53; {{geometric-mean}} : the geometric average runtime of the {{SEQ}}
     54; {{median}} : the median runtime of the {{SEQ}}
     55; {{mode}} : the mode runtime of the {{SEQ}}
     56; {{var}} : variance alias
     57; {{sigma^2}} : variance alias
     58; {{variance}} : the variance for the {{SEQ}}
    5759
    5860=== basic-statistics
     
    6870Returns an {{alist}} for a set of statistical functions results.
    6971
    70 : {{SEQ}} ; {{(seq-of real)}} ; the sample
    71 : {{FUNCS}} ; {{(list-of function-spec)}}; the report template
    72 : {{BASICS}} ; {{#(m h g s v)}} ; required statistics
     72; {{SEQ}} : {{(seq-of real)}} ; the sample
     73; {{FUNCS}} : {{(list-of function-spec)}}; the report template
     74; {{BASICS}} : {{#(m h g s v)}} ; required statistics
    7375
    7476A {{function-spec}} is:
    7577
    76 : size ; sample count
    77 : min ; sample minimum
    78 : max ; sample maximum
    79 : arithmetic-mean : sample arithmetic-average
    80 : standard-deviation ; sample standard-deviation
    81 : percentile [P] ; sample {{P}}th-percentile ; default is {{95}}
    82 : harmonic-mean ; sample harmonic-average
    83 : geometric-mean ; sample geometric-average
    84 : median ; sample median
    85 : mode ; sample mode
    86 : variance ; sample variance
    87 : (KEY . (F [PARAM ...])) ; sample parameterized {{(: F function-spec)}}
     78; {{size}} : sample count
     79; {{min}} : sample minimum
     80; {{max}} : sample maximum
     81; {{arithmetic-mean}} : sample arithmetic-average
     82; {{standard-deviation}} : sample standard-deviation
     83; {{percentile}} : sample {{P}}th-percentile ; default is {{95}}
     84; {{harmonic-mean}} : sample harmonic-average
     85; {{geometric-mean}} : sample geometric-average
     86; {{median}} : sample median
     87; {{mode}} : sample mode
     88; {{variance}} : sample variance
     89; {{(KEY . (F [PARAM ...]))}} : sample parameterized {{(: F function-spec)}}
    8890
    8991==== percentile
     
    9395Returns {{P}}th percentile of {{SEQ}}.
    9496
    95 : {{SEQ}} ; {{(seq-of real)}}
    96 : {{P}} ; {{[0 .. 100]}} ; defaults is {{95}}
     97; {{SEQ}} : {{(seq-of real)}}
     98; {{P}} : {{[0 .. 100]}} ; defaults is {{95}}
    9799
    98100==== mean
     
    102104Returns the ''arithmetic'', ''harmonic'', & ''geometric'' means for {{SEQ}}.
    103105
    104 : {{SEQ}} ; {{(seq-of real)}}
     106; {{SEQ}} : {{(seq-of real)}}
    105107
    106108==== median
     
    110112Returns the ''median'' of the {{SEQ}}.
    111113
    112 : {{SEQ}} ; {{(seq-of real)}}
    113 : {{<?}} ; {{binary-predicate}} ; ''less-than'' predicate, default {{<}}
     114; {{SEQ}} : {{(seq-of real)}}
     115; {{<?}} : {{binary-predicate}} ; ''less-than'' predicate, default {{<}}
    114116
    115117==== mode
     
    119121Returns the ''mode'' of the {{SEQ}}.
    120122
    121 : {{SEQ}} ; {{(seq-of real)}}
    122 : {{=?}} ; {{binary-predicate}} ; ''equality'' predicate, default {{=}}
     123; {{SEQ}} : {{(seq-of real)}}
     124; {{=?}} : {{binary-predicate}} ; ''equality'' predicate, default {{=}}
    123125
    124126==== standard-deviation
     
    129131{{MEAN}}. Calculates the {{MEAN}} when not given.
    130132
    131 : {{SEQ}} ; {{(seq-of real)}}
    132 : {{MEAN}} ; {{real}}
     133; {{SEQ}} : {{(seq-of real)}}
     134; {{MEAN}} : {{real}}
    133135
    134136
     
    146148== Version history
    147149
    148 : 0.0.1 ; C5 release.
     150; 0.0.1 : C5 release.
    149151
    150152
Note: See TracChangeset for help on using the changeset viewer.