This is the cl-pcg Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:33:52 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-pcgA bare-bones Permuted Congruential Generator implementation in pure Common Lisp.
Steve Losh <steve@stevelosh.com>
MIT
1.0.0
sb-rotate-byte (system).
vendor (module).
package.lisp (file).
src (module).
Modules are listed depth-first from the system components tree.
cl-pcg/vendorcl-pcg (system).
quickutils-package.lisp (file).
quickutils.lisp (file).
cl-pcg/srcpackage.lisp (file).
cl-pcg (system).
pcg.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-pcg/cl-pcg.asdcl-pcg/vendor/quickutils-package.lispcl-pcg/vendor/quickutils.lispcl-pcg/package.lispcl-pcg/src/pcg.lispcl-pcg/vendor/quickutils-package.lispvendor (module).
*utilities* (special variable).
cl-pcg/vendor/quickutils.lispquickutils-package.lisp (file).
vendor (module).
symb (function).
with-gensyms (macro).
with-unique-names (macro).
mkstr (function).
string-designator (type).
cl-pcg/package.lispcl-pcg/src/pcg.lispsrc (module).
make-pcg (function).
make-pcg% (function).
pcg (structure).
pcg-advance (function).
pcg-advance% (function).
pcg-random (function).
pcg-random% (function).
pcg-random-bounded% (function).
pcg-random-float% (function).
pcg-rewind (function).
pcg-rewind% (function).
% (function).
*+ (function).
*global-generator* (special variable).
+limit+ (constant).
+modulus+ (constant).
+multiplier+ (constant).
actually-make-pcg (function).
advance-state (function).
check-types (macro).
compute-increment (function).
copy-pcg (function).
defun-inline (macro).
pcg-designator (type).
pcg-increment (reader).
(setf pcg-increment) (writer).
pcg-p (function).
pcg-random-float (function).
pcg-random-integer (function).
pcg-random-range% (function).
pcg-state (reader).
(setf pcg-state) (writer).
permute-rotate (function).
permute-xor-shift (function).
resolve-pcg (function).
resolve-seed (function).
rotate-byte (function).
u32 (type).
u64 (type).
Packages are listed by definition order.
pcg.quickutilsPackage that contains Quickutil utility functions.
common-lisp.
pcg.
symb (function).
with-gensyms (macro).
with-unique-names (macro).
*utilities* (special variable).
mkstr (function).
string-designator (type).
pcgcommon-lisp.
pcg.quickutils.
make-pcg (function).
make-pcg% (function).
pcg (structure).
pcg-advance (function).
pcg-advance% (function).
pcg-random (function).
pcg-random% (function).
pcg-random-bounded% (function).
pcg-random-float% (function).
pcg-rewind (function).
pcg-rewind% (function).
% (function).
*+ (function).
*global-generator* (special variable).
+limit+ (constant).
+modulus+ (constant).
+multiplier+ (constant).
actually-make-pcg (function).
advance-state (function).
check-types (macro).
compute-increment (function).
copy-pcg (function).
defun-inline (macro).
pcg-designator (type).
pcg-increment (reader).
(setf pcg-increment) (writer).
pcg-p (function).
pcg-random-float (function).
pcg-random-integer (function).
pcg-random-range% (function).
pcg-state (reader).
(setf pcg-state) (writer).
permute-rotate (function).
permute-xor-shift (function).
resolve-pcg (function).
resolve-seed (function).
rotate-byte (function).
u32 (type).
u64 (type).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Binds each variable named by a symbol in ‘names‘ to a unique symbol around
‘forms‘. Each of ‘names‘ must either be either a symbol, or of the form:
(symbol string-designator)
Bare symbols appearing in ‘names‘ are equivalent to:
(symbol symbol)
The string-designator is used as the argument to ‘gensym‘ when constructing the unique symbol the named variable will be bound to.
Binds each variable named by a symbol in ‘names‘ to a unique symbol around
‘forms‘. Each of ‘names‘ must either be either a symbol, or of the form:
(symbol string-designator)
Bare symbols appearing in ‘names‘ are equivalent to:
(symbol symbol)
The string-designator is used as the argument to ‘gensym‘ when constructing the unique symbol the named variable will be bound to.
Create and return a new PCG.
If ‘seed‘ is ‘nil‘, a fresh random seed will be generated with the
implementation’s ‘cl:random‘ function, as if by:
(random ... (make-random-state t))
Create and return a new ‘pcg‘ for the given ‘seed‘ and ‘stream-id‘.
This is a low-level function that assumes you are passing in the correct types.
Advance the state of ‘pcg‘ by ‘steps‘ steps.
This function returns ‘nil‘ and is only useful for its side effects.
Advance the state of ‘pcg‘ by ‘steps‘ steps.
This function returns ‘nil‘ and is only useful for its side effects.
This is a low-level function that assumes you are passing in the correct types.
Generate and return a random number in the specified interval.
If ‘max‘ is omitted the interval will be ‘[0, bound)‘.
If ‘max‘ is given the interval will be ‘[bound, max)‘.
If ‘inclusive?‘ is given the interval will be ‘[bound, max]‘.
If either of ‘bound‘ or ‘max‘ are floats, the result will be a float.
Otherwise the result will be an integer.
As a side effect, the state of ‘pcg‘ will be advanced.
Return a random ‘(unsigned-byte 32)‘.
As a side effect, the state of ‘pcg‘ will be advanced.
This is a low-level function that assumes you are passing in the correct types.
Return a random integer between ‘0‘ (inclusive) and ‘bound‘ (exclusive).
As a side effect, the state of ‘pcg‘ will be advanced.
This is a low-level function that assumes you are passing in the correct types.
Return a random ‘single-float‘ between ‘0.0‘ and ‘1.0‘.
As a side effect, the state of ‘pcg‘ will be advanced.
This is a low-level function that assumes you are passing in the correct types.
Rewind the state of ‘pcg‘ by ‘steps‘ steps.
This function returns ‘nil‘ and is only useful for its side effects.
Rewind the state of ‘pcg‘ by ‘steps‘ steps.
This function returns ‘nil‘ and is only useful for its side effects.
This is a low-level function that assumes you are passing in the correct types.
Receives any number of objects, concatenates all into one string with ‘#’mkstr‘ and converts them to symbol.
Extracted from _On Lisp_, chapter 4.
See also: ‘symbolicate‘
Like ‘defun‘, but declaims ‘name‘ to be ‘inline‘.
Receives any number of objects (string, symbol, keyword, char, number), extracts all printed representations, and concatenates them all into one string.
Extracted from _On Lisp_, chapter 4.
Return a random ‘single-float‘.
As a side effect, the state of ‘pcg‘ will be advanced.
Return a random integer.
As a side effect, the state of ‘pcg‘ will be advanced.
Rotates a field of bits within INTEGER; specifically, returns an integer that contains the bits of INTEGER rotated COUNT times leftwards within the byte specified by BYTESPEC, and elsewhere contains the bits of INTEGER. See http://www.cliki.net/ROTATE-BYTE
A string designator type. A string designator is either a string, a symbol, or a character.
| Jump to: | %
(
*
A C D F M P R S W |
|---|
| Jump to: | %
(
*
A C D F M P R S W |
|---|
| Jump to: | *
+
C I S |
|---|
| Jump to: | *
+
C I S |
|---|
| Jump to: | C F M P Q S T U V |
|---|
| Jump to: | C F M P Q S T U V |
|---|