The cl-performance-tuning-helper Reference Manual

This is the cl-performance-tuning-helper Reference Manual, version 0.3.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 20:32:16 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-performance-tuning-helper

A simple performance tuning helper tool box for Common Lisp

Maintainer

SUZUKI Shingo

Author

SUZUKI Shingo

License

MIT

Version

0.3.0

Source

cl-performance-tuning-helper.asd.

Child Component

cl-performance-tuning-helper.lisp (file).


3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 cl-performance-tuning-helper/cl-performance-tuning-helper.asd

Source

cl-performance-tuning-helper.asd.

Parent Component

cl-performance-tuning-helper (system).

ASDF Systems

cl-performance-tuning-helper.

Packages

cl-performance-tuning-helper-asd.


3.1.2 cl-performance-tuning-helper/cl-performance-tuning-helper.lisp

Source

cl-performance-tuning-helper.asd.

Parent Component

cl-performance-tuning-helper (system).

Packages

cl-performance-tuning-helper.

Public Interface

4 Packages

Packages are listed by definition order.


4.1 cl-performance-tuning-helper

Source

cl-performance-tuning-helper.lisp.

Nickname

pth

Use List

common-lisp.

Public Interface

4.2 cl-performance-tuning-helper-asd

Source

cl-performance-tuning-helper.asd.

Use List
  • asdf/interface.
  • common-lisp.

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Macros

Macro: performance (num-repeats debugger-p (func &rest args))

do performance test with specified arguments

usage: (performance num-repeats debugger-p (function &rest args))

num-repeats: designates a number of repeats in positive integer.
If you want to reference current repeat count from testing function, you should specify num-repeats as following format:
(count-variable positive-integer).

debugger-p: designate enable to call debugger for ANY conditions.

function: a symbol of function or a lambda expression.

e.g.
(let ((max 5))
(pth:performance (i max) nil (format t "SAMPLE: ~d of ~d~%" i max)) ) => t
—-
;;; performance test for FORMAT MAX times
;;; do (FORMAT T "SAMPLE: ~d of ~d~%" I MAX)
SAMPLE: 0 of 5
SAMPLE: 1 of 5
SAMPLE: 2 of 5
SAMPLE: 3 of 5
SAMPLE: 4 of 5

(and following platform dependant output of TIME function)

Package

cl-performance-tuning-helper.

Source

cl-performance-tuning-helper.lisp.

Macro: trash-outputs (&body body)

trash system stream outputs: *standard-output*, *error-output*,
and *trace-output*.

Package

cl-performance-tuning-helper.

Source

cl-performance-tuning-helper.lisp.


5.1.2 Ordinary functions

Function: asmout (fun &optional path)

output DISASSEMBLE result into a file

Package

cl-performance-tuning-helper.

Source

cl-performance-tuning-helper.lisp.

Function: cload (path)

load after compile a file

Package

cl-performance-tuning-helper.

Source

cl-performance-tuning-helper.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables