Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The random-sample Reference Manual

This is the random-sample Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:32:46 2024 GMT+0.

Table of Contents

Next: Systems, Previous: The random-sample Reference Manual, Up: The random-sample Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The random-sample Reference Manual [Contents][Index]

2 Systems

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

random-sample

Previous: Systems, Up: Systems [Contents][Index]

2.1 `random-sample`

Random sample of a sequence with uniform distribution.

Author

Paul M. Rodriguez <pmr@ruricolist.com>

License

MIT

Dependencies

alexandria (system).
serapeum (system).
infix-math (system).
named-readtables (system).

Source

random-sample.asd.

Child Components

package.lisp (file).
readtable.lisp (file).
random-sample.lisp (file).

Next: Packages, Previous: Systems, Up: The random-sample Reference Manual [Contents][Index]

3 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

3.1 Lisp

random-sample/random-sample.asd
random-sample/package.lisp
random-sample/readtable.lisp
random-sample/random-sample.lisp

Next: random-sample/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `random-sample/random-sample.asd`

Source: random-sample.asd.
Parent Component: random-sample (system).
ASDF Systems: random-sample.

Next: random-sample/readtable.lisp, Previous: random-sample/random-sample.asd, Up: Lisp [Contents][Index]

3.1.2 `random-sample/package.lisp`

Source: random-sample.asd.
Parent Component: random-sample (system).
Packages: random-sample.

Next: random-sample/random-sample.lisp, Previous: random-sample/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `random-sample/readtable.lisp`

Dependency: package.lisp (file).
Source: random-sample.asd.
Parent Component: random-sample (system).

Previous: random-sample/readtable.lisp, Up: Lisp [Contents][Index]

3.1.4 `random-sample/random-sample.lisp`

Dependency

readtable.lisp (file).

Source

random-sample.asd.

Parent Component

random-sample (system).

Public Interface

generate-index-array (function).
map-random-below (function).
random-sample (function).

Internals

+storage-for-deflex-var-alpha+ (constant).
alpha (symbol macro).
collect-sample (function).
generate-index-array/replacement (function).
uniformrv (function).
vitter-method-a (function).
vitter-method-d (function).

Next: Definitions, Previous: Files, Up: The random-sample Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

random-sample

Previous: Packages, Up: Packages [Contents][Index]

4.1 `random-sample`

Source

package.lisp.

Use List

alexandria.
common-lisp.
editor-hints.named-readtables.
serapeum.

Public Interface

generate-index-array (function).
map-random-below (function).
random-sample (function).

Internals

+storage-for-deflex-var-alpha+ (constant).
alpha (symbol macro).
collect-sample (function).
generate-index-array/replacement (function).
uniformrv (function).
vitter-method-a (function).
vitter-method-d (function).

Next: Indexes, Previous: Packages, Up: The random-sample Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Function: generate-index-array (n len) ¶

Package: random-sample.
Source: random-sample.lisp.

Function: map-random-below (fn n len) ¶

Generate N random indices for a sequence of length LEN, in ascending order, calling FN on each index as it is generated.

Package: random-sample.
Source: random-sample.lisp.

Function: random-sample (seq n &key with-replacement) ¶

Return a random sample of SEQ of size N.

If WITH-REPLACEMENT is true, return a random sample with replacement (a "draw").

If WITH-REPLACEMENT is false, return a random sample without replacement (a "deal").

Package: random-sample.
Source: random-sample.lisp.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Constants
Symbol macros
Ordinary functions

Next: Symbol macros, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Constants

Constant: +storage-for-deflex-var-alpha+ ¶

The parameter that decides whether to use method A or method D.

Package: random-sample.
Source: random-sample.lisp.

Next: Ordinary functions, Previous: Constants, Up: Internals [Contents][Index]

5.2.2 Symbol macros

Symbol Macro: alpha ¶

Package: random-sample.
Source: random-sample.lisp.

Previous: Symbol macros, Up: Internals [Contents][Index]

5.2.3 Ordinary functions

Function: collect-sample (seq index-array) ¶

Package: random-sample.
Source: random-sample.lisp.

Function: generate-index-array/replacement (n len) ¶

Package: random-sample.
Source: random-sample.lisp.

Function: uniformrv () ¶

Package: random-sample.
Source: random-sample.lisp.

Function: vitter-method-a (fn n n) ¶

Vitter’s Method A.

Mostly faithful to Vitter’s Pascal code, but uses advanced Common Lisp features like exponents and subtraction.

Package: random-sample.
Source: random-sample.lisp.

Function: vitter-method-d (fn n n) ¶

Vitter’s Method D.

Package: random-sample.
Source: random-sample.lisp.

Previous: Definitions, Up: The random-sample Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	C F G M R U V

	Index Entry		Section

C
	`collect-sample`:		Private ordinary functions

F
	`Function, collect-sample`:		Private ordinary functions
	`Function, generate-index-array`:		Public ordinary functions
	`Function, generate-index-array/replacement`:		Private ordinary functions
	`Function, map-random-below`:		Public ordinary functions
	`Function, random-sample`:		Public ordinary functions
	`Function, uniformrv`:		Private ordinary functions
	`Function, vitter-method-a`:		Private ordinary functions
	`Function, vitter-method-d`:		Private ordinary functions

G
	`generate-index-array`:		Public ordinary functions
	`generate-index-array/replacement`:		Private ordinary functions

M
	`map-random-below`:		Public ordinary functions

R
	`random-sample`:		Public ordinary functions

U
	`uniformrv`:		Private ordinary functions

V
	`vitter-method-a`:		Private ordinary functions
	`vitter-method-d`:		Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	+ A C S

	Index Entry		Section

+
	`+storage-for-deflex-var-alpha+`:		Private constants

A
	`alpha`:		Private symbol macros

C
	`Constant, +storage-for-deflex-var-alpha+`:		Private constants

S
	`Symbol Macro, alpha`:		Private symbol macros

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	F P R S

	Index Entry		Section

F
	`File, package.lisp`:		The random-sample/package․lisp file
	`File, random-sample.asd`:		The random-sample/random-sample․asd file
	`File, random-sample.lisp`:		The random-sample/random-sample․lisp file
	`File, readtable.lisp`:		The random-sample/readtable․lisp file

P
	`Package, random-sample`:		The random-sample package
	`package.lisp`:		The random-sample/package․lisp file

R
	`random-sample`:		The random-sample system
	`random-sample`:		The random-sample package
	`random-sample.asd`:		The random-sample/random-sample․asd file
	`random-sample.lisp`:		The random-sample/random-sample․lisp file
	`readtable.lisp`:		The random-sample/readtable․lisp file

S
	`System, random-sample`:		The random-sample system