This is the trivial-benchmark Reference Manual, version 2.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon May 15 06:39:18 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
trivial-benchmarkAn easy to use benchmarking system.
Nicolas Hafner <shinmera@tymoon.eu>
Nicolas Hafner <shinmera@tymoon.eu>
(GIT https://github.com/Shinmera/trivial-benchmark.git)
zlib
2.0.0
alexandria (system).
package.lisp (file).
toolkit.lisp (file).
timer.lisp (file).
samples.lisp (file).
suite.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
trivial-benchmark/trivial-benchmark.asdtrivial-benchmark/package.lisptrivial-benchmark/toolkit.lisptrivial-benchmark/timer.lisptrivial-benchmark/samples.lisptrivial-benchmark/suite.lisptrivial-benchmark/trivial-benchmark.asdtrivial-benchmark (system).
trivial-benchmark/toolkit.lisppackage.lisp (file).
trivial-benchmark (system).
print-table (function).
round-to (function).
type= (function).
trivial-benchmark/timer.lisptoolkit.lisp (file).
trivial-benchmark (system).
*default-computations* (special variable).
*default-metrics* (special variable).
commit (generic function).
compute (generic function).
condense (generic function).
describe-object (method).
discard (generic function).
do-metrics (macro).
initialize-instance (method).
make-timer (function).
map-metrics (function).
metric (generic function).
(setf metric) (generic function).
metric (class).
metric-types (generic function).
metrics (generic reader).
(setf metrics) (writer method).
print-object (method).
print-object (method).
reduce-samples (generic function).
report (generic function).
reset (generic function).
running (generic reader).
(setf running) (writer method).
sample-size (generic function).
samples (generic reader).
start (generic function).
take-sample (generic function).
timer (class).
with-sampling (macro).
with-timing (macro).
format-timer-stats (function).
report-to (generic function).
stop (generic function).
trivial-benchmark/samples.lisptimer.lisp (file).
trivial-benchmark (system).
bytes-consed (class).
commit (method).
commit (method).
cpu-cycles (class).
define-delta-metric (macro).
delta-metric (class).
discard (method).
discard (method).
eval-calls (class).
gc-run-time (class).
page-faults (class).
real-time (class).
reset (method).
reset (method).
run-time (class).
samples (reader method).
(setf samples) (writer method).
start (method).
start (method).
starting-value (generic reader).
(setf starting-value) (writer method).
system-run-time (class).
take-sample (method).
take-sample (method).
take-sample (method).
take-sample (method).
take-sample (method).
take-sample (method).
take-sample (method).
take-sample (method).
user-run-time (class).
vector-metric (class).
cpu-cycles-h0 (reader method).
(setf cpu-cycles-h0) (writer method).
cpu-cycles-h1 (reader method).
(setf cpu-cycles-h1) (writer method).
cpu-cycles-l0 (reader method).
(setf cpu-cycles-l0) (writer method).
cpu-cycles-l1 (reader method).
(setf cpu-cycles-l1) (writer method).
stop (method).
stop (method).
stopping-value (reader method).
(setf stopping-value) (writer method).
units (reader method).
units (reader method).
units (reader method).
units (reader method).
units (reader method).
units (reader method).
units (reader method).
units (reader method).
units (reader method).
(setf units) (writer method).
(setf units) (writer method).
(setf units) (writer method).
(setf units) (writer method).
(setf units) (writer method).
(setf units) (writer method).
(setf units) (writer method).
(setf units) (writer method).
(setf units) (writer method).
trivial-benchmark/suite.lispsamples.lisp (file).
trivial-benchmark (system).
define-benchmark (macro).
define-benchmark-package (macro).
find-benchmark-package (function).
run-package-benchmarks (function).
with-benchmark-sampling (macro).
with-suite-report (macro).
*benchmark-packages* (special variable).
*current-benchmark* (special variable).
*current-suite-report* (special variable).
*current-timer* (special variable).
make-suite-report-table (function).
metrics-alist (function).
print-verbose-after-message (function).
print-verbose-before-message (function).
report-to (method).
run-one-benchmark (function).
Packages are listed by definition order.
trivial-benchmarkbenchmark
org.shirakumo.trivial-benchmark
common-lisp.
*default-computations* (special variable).
*default-metrics* (special variable).
bytes-consed (class).
commit (generic function).
compute (generic function).
condense (generic function).
cpu-cycles (class).
define-benchmark (macro).
define-benchmark-package (macro).
define-delta-metric (macro).
delta-metric (class).
discard (generic function).
do-metrics (macro).
eval-calls (class).
find-benchmark-package (function).
gc-run-time (class).
make-timer (function).
map-metrics (function).
metric (generic function).
(setf metric) (generic function).
metric (class).
metric-types (generic function).
metrics (generic reader).
(setf metrics) (generic writer).
page-faults (class).
print-table (function).
real-time (class).
reduce-samples (generic function).
report (generic function).
reset (generic function).
round-to (function).
run-package-benchmarks (function).
run-time (class).
running (generic reader).
(setf running) (generic writer).
sample-size (generic function).
samples (generic reader).
(setf samples) (generic writer).
start (generic function).
starting-value (generic reader).
(setf starting-value) (generic writer).
system-run-time (class).
take-sample (generic function).
timer (class).
type= (function).
user-run-time (class).
vector-metric (class).
with-benchmark-sampling (macro).
with-sampling (macro).
with-suite-report (macro).
with-timing (macro).
*benchmark-packages* (special variable).
*current-benchmark* (special variable).
*current-suite-report* (special variable).
*current-timer* (special variable).
cpu-cycles-h0 (generic reader).
(setf cpu-cycles-h0) (generic writer).
cpu-cycles-h1 (generic reader).
(setf cpu-cycles-h1) (generic writer).
cpu-cycles-l0 (generic reader).
(setf cpu-cycles-l0) (generic writer).
cpu-cycles-l1 (generic reader).
(setf cpu-cycles-l1) (generic writer).
format-timer-stats (function).
make-suite-report-table (function).
metrics-alist (function).
print-verbose-after-message (function).
print-verbose-before-message (function).
report-to (generic function).
run-one-benchmark (function).
stop (generic function).
stopping-value (generic reader).
(setf stopping-value) (generic writer).
units (generic reader).
(setf units) (generic writer).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The list of computation-names used to print the REPORT table.
The list of class-names used to populate a TIMER by default.
Define a benchmark named NAME. The structure of this macro is that of DEFUN, except that WITH-BENCHMARK-SAMPLING can be called to collect metrics on the enclosed forms.
ARGS must be a lambda list that does not require arguments present at the call site.
Define a package as if by DEFPACKAGE, except that both the COMMON-LISP and TRIVIAL-BENCHMARK packages are used, and that this package is designated as one containing benchmarks.
Shortcut to define a DELTA-METRIC.
The SAMPLE-POINT-FORMS should return a number to use to calculate a delta.
NAME can be either just a NAME or a list of the form (NAME UNITS) where
UNITS is the number the sample points are divided by when saving them.
For example, if you sample a function of milliseconds, but want to report
in seconds, set UNITS to 1000. Doing this instead of dividing directly in
the form avoids potential consing when running into bignums.
See DELTA-METRIC
Binds METRIC-VAR to each metric of TIMER and then evaluates FORMS. Returns the value of RESULT-FORM after the loop.
Benchmark the execution of the forms FORMS within the context of a DEFINE-BENCH macro. Acts like PROGN.
Takes a sample for the evaluation time of FORMS and stores it in the timer given by TIMER-FORM.
Acts like a PROGN.
Specifically, START is called, then FORMS are evaluated. If an error occurs within the body,
DISCARD is called on the timer, otherwise COMMIT is called once the body exits.
See START
See DISCARD
See COMMIT
Evaluates FORMS N times, using WITH-SAMPLING on the value of TIMER-FORM each iteration.
At the end, runs REPORT on the timer with STREAM and COMPUTATIONS.
See WITH-SAMPLING
Find the benchmark package designated by PACKAGE-DESIGNATOR and return it, otherwise return NIL if it doesn’t exist.
Creates a TIMER object using the given METRIC-TYPES
Maps the metrics in TIMER, calling FUNCTION with each.
Prints a table (each list in TABLE being a row) with proper spacing.
Rounds NUM to N digits after the dot.
Run all of the benchmarks associated with the benchmark package PACKAGE, the current one by default.
Return a hash table mapping benchmark names to their metrics represented as lists. In particular, it will be an alist whose CARs are metrics and whose CDRs are plists of computations.
VERBOSE is a generalized boolean that controls output verbosity while testing.
Returns T if A and B denote the same type (are subtypes of one another)
If one of the arguments does not denote a type, the result of TYPE-OF is used in their place.
Commit the current sample of METRIC. If the metric is running, call STOP first.
cpu-cycles)) ¶delta-metric)) ¶Compute a value of the statistical computation THING for METRIC based on its current samples.
Turn the SAMPLE value into a usable number.
Discard the current sample of METRIC. If the metric is running, call STOP first.
cpu-cycles)) ¶delta-metric)) ¶Returns the metric of TYPE in TIMER if any. The metric must match the type by TYPE=
Sets the METRIC in TIMER.
The metric is replaced if it is found in the timer by TYPE= comparison.
Returns the types of metrics in TIMER.
Returns a list of metrics stored in TIMER.
Apply FUNCTION to the samples stored in METRIC in a REDUCE fashion.
Print a report of all COMPUTATIONS for THING to STREAM
STREAM can be one of the following:
T — Print to *standard-output*
NIL — Print to a string and return it.
STREAM — Print to the stream
Reset the METRIC and remove all its samples.
vector-metric)) ¶vector-metric)) ¶Returns T if the metric is currently sampling.
See START
See STOP
Return the number of samples stored in METRIC.
Return a sequence of committed samples stored in METRIC.
vector-metric)) ¶automatically generated reader method
vector-metric)) ¶automatically generated writer method
Begin a sample for METRIC. Sets RUNNING to T.
cpu-cycles)) ¶delta-metric)) ¶Returns the value stored when START was called on the DELTA-METRIC.
delta-metric)) ¶automatically generated reader method
delta-metric)) ¶automatically generated writer method
Return a current sampling value for METRIC.
Note that not all metrics must implement a method for this function. It is perfectly plausible for a metric to skip this method if it cannot provide a sample value at any point in time.
eval-calls)) ¶Samples SB-IMPL::*EVAL-CALLS*.
bytes-consed)) ¶Samples SB-IMPL::GET-BYTES-CONSED.
gc-run-time)) ¶Samples SB-IMPL::*GC-RUN-TIME* in seconds.
page-faults)) ¶Samples the third value (page-faults) of SB-SYS:GET-SYSTEM-INFO in seconds.
system-run-time)) ¶Samples the second value (system-run-time) of SB-SYS:GET-SYSTEM-INFO in seconds.
user-run-time)) ¶Samples the first value (user-run-time) of SB-SYS:GET-SYSTEM-INFO in seconds.
run-time)) ¶Samples the results of GET-INTERNAL-RUN-TIME in seconds.
Samples SB-IMPL::GET-BYTES-CONSED.
1
Samples SB-IMPL::ELAPSED-CYCLES.
A LISTED-METRIC that calculates a sample point according to the delta between the START and COMMIT.
Sub-classes of this must implement the TAKE-SAMPLE method.
See LISTED-METRIC
Samples SB-IMPL::*EVAL-CALLS*.
1
Samples SB-IMPL::*GC-RUN-TIME* in seconds.
1000
A class container for sampling information.
:running
Samples the third value (page-faults) of SB-SYS:GET-SYSTEM-INFO in seconds.
1
Samples the results of GET-INTERNAL-REAL-TIME in seconds.
internal-time-units-per-second
Samples the results of GET-INTERNAL-RUN-TIME in seconds.
internal-time-units-per-second
Samples the second value (system-run-time) of SB-SYS:GET-SYSTEM-INFO in seconds.
1000000
Class container for a set of METRICS.
:metrics
Samples the first value (user-run-time) of SB-SYS:GET-SYSTEM-INFO in seconds.
1000000
A METRIC that implements its sample storage as a vector.
SAMPLES is SETF-able for this class.
See METRIC
(make-array 1000 :adjustable t :fill-pointer 0)
:samples
A table mapping package objects (which are benchmark packages) to a list of fbound symbols.
cpu-cycles)) ¶automatically generated reader method
h0.
cpu-cycles)) ¶automatically generated writer method
h0.
cpu-cycles)) ¶automatically generated reader method
h1.
cpu-cycles)) ¶automatically generated writer method
h1.
cpu-cycles)) ¶automatically generated reader method
l0.
cpu-cycles)) ¶automatically generated writer method
l0.
cpu-cycles)) ¶automatically generated reader method
l1.
cpu-cycles)) ¶automatically generated writer method
l1.
Stop the sample for METRIC. Sets RUNNING to NIL.
cpu-cycles)) ¶delta-metric)) ¶delta-metric)) ¶automatically generated reader method
delta-metric)) ¶automatically generated writer method
eval-calls)) ¶automatically generated reader method
bytes-consed)) ¶automatically generated reader method
gc-run-time)) ¶automatically generated reader method
page-faults)) ¶automatically generated reader method
system-run-time)) ¶automatically generated reader method
user-run-time)) ¶automatically generated reader method
run-time)) ¶automatically generated reader method
real-time)) ¶automatically generated reader method
delta-metric)) ¶automatically generated reader method
eval-calls)) ¶automatically generated writer method
bytes-consed)) ¶automatically generated writer method
gc-run-time)) ¶automatically generated writer method
page-faults)) ¶automatically generated writer method
system-run-time)) ¶automatically generated writer method
user-run-time)) ¶automatically generated writer method
run-time)) ¶automatically generated writer method
real-time)) ¶automatically generated writer method
delta-metric)) ¶automatically generated writer method
| Jump to: | (
C D F G I M P R S T U W |
|---|
| Jump to: | (
C D F G I M P R S T U W |
|---|
| Jump to: | *
H L M R S U |
|---|
| Jump to: | *
H L M R S U |
|---|
| Jump to: | B C D E F G M P R S T U V |
|---|
| Jump to: | B C D E F G M P R S T U V |
|---|