The ALEXANDRIA+ Reference Manual

This is the ALEXANDRIA+ Reference Manual, version 1.1.0, generated automatically by Declt version 4.0b2.

Copyright © 2019-2022 Steven Nunez

Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.

Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided also that the section entitled “Copying” is included exactly as in the original.

Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be translated as well.

Copying

This program is distributed under the terms of the Microsoft Public License.

1 Systems

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

1.1 `alexandria+`

A conservative set of extensions to Alexandria utilities.

Author

Steven Nunez <steve@symbolics.tech>

Home Page

https://github.com/symbolics/alexandria+

License

MS-PL

Long Description

Utilities not in Alexandria, UIOP or OSICAT.

Version

1.1.0

Dependency

alexandria (system).

Source

alexandria+.asd.

Child Components

pkgdcl.lisp (file).
lists.lisp (file).
types.lisp (file).
numbers.lisp (file).
control-flow.lisp (file).

2 Files

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

2.1 Lisp

2.1.1 `alexandria+/alexandria+.asd`

Source: alexandria+.asd.
Parent Component: alexandria+ (system).
ASDF Systems: alexandria+.

2.1.2 `alexandria+/pkgdcl.lisp`

Source: alexandria+.asd.
Parent Component: alexandria+ (system).
Packages: alexandria+.

2.1.3 `alexandria+/lists.lisp`

Source

alexandria+.asd.

Parent Component

alexandria+ (system).

Public Interface

alist (type).
alist-keys (function).
alist-values (function).
alistp (function).
defprop (macro).
plist (type).
plist-keys (function).
plist-values (function).
plistp (function).

2.1.4 `alexandria+/types.lisp`

Source

alexandria+.asd.

Parent Component

alexandria+ (system).

Public Interface

percentage (type).
probability (type).

2.1.5 `alexandria+/numbers.lisp`

Source: alexandria+.asd.
Parent Component: alexandria+ (system).
Public Interface: multf (macro).

2.1.6 `alexandria+/control-flow.lisp`

Source: alexandria+.asd.
Parent Component: alexandria+ (system).
Public Interface: unlessf (macro).

3 Packages

Packages are listed by definition order.

3.1 `alexandria+`

Source

pkgdcl.lisp.

Use List

alexandria.
common-lisp.

Used By List

data-frame.
num-utils.arithmetic.
num-utils.quadrature.
special-functions.

Public Interface

alist (type).
alist-keys (function).
alist-values (function).
alistp (function).
defprop (macro).
multf (macro).
percentage (type).
plist (type).
plist-keys (function).
plist-values (function).
plistp (function).
probability (type).
unlessf (macro).

4 Definitions

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

4.1 Public Interface

4.1.1 Macros

Macro: defprop (symbol value indicator) ¶

Gives SYMBOL an INDICATOR property of VALUE.
After this is done (CL:GET symbol indicator) returns VALUE

Package: alexandria+.
Source: lists.lisp.

Macro: multf (place coefficient) ¶

Multiply place by COEFFICIENT.

Package: alexandria+.
Source: numbers.lisp.

Macro: unlessf (place value-form) ¶

When PLACE is NIL, evaluate VALUE-FORM and save it there.

Package: alexandria+.
Source: control-flow.lisp.

4.1.2 Ordinary functions

Function: alist-keys (alist) ¶

Returns a list of the keys in ALIST.

Package: alexandria+.
Source: lists.lisp.

Function: alist-values (alist) ¶

Returns a list of the values in ALIST.

Package: alexandria+.
Source: lists.lisp.

Function: alistp (value) ¶

Returns T if VALUE is an ALIST.

Package: alexandria+.
Source: lists.lisp.

Function: plist-keys (plist) ¶

Return the keys of PLIST

Package: alexandria+.
Source: lists.lisp.

Function: plist-values (plist) ¶

Return the values of PLIST

Package: alexandria+.
Source: lists.lisp.

Function: plistp (value &key allow-symbol-keys) ¶

Returns VALUE if it is a properly formed PLIST, NIL otherwise.
If ALLOW-SYMBOL-KEYS is not nil, keys may be either symbols or keywords

Package: alexandria+.
Source: lists.lisp.

4.1.3 Types

Type: alist () ¶

Type designator for ALIST. Implemented as a SATISFIES type, hence not recommended for performance intensive use. Main usefullness as a type designator of the expected type in a TYPE-ERROR.

Package: alexandria+.
Source: lists.lisp.

Type: percentage () ¶

A number between 0 and 100

Package: alexandria+.
Source: types.lisp.

Type: plist () ¶

Type designator for PLIST. Implemented as a SATISFIES type, hence not recommended for performance intensive use. Main usefullness as a type designator of the expected type in a TYPE-ERROR.

Package: alexandria+.
Source: lists.lisp.

Type: probability () ¶

A number between 0 and 1

Package: alexandria+.
Source: types.lisp.

Appendix A Indexes

A.1 Concepts

A.2 Functions

Jump to:	A D F M P U

	Index Entry	Section

A
	`alist-keys`:	Public ordinary functions
	`alist-values`:	Public ordinary functions
	`alistp`:	Public ordinary functions

D
	`defprop`:	Public macros

F
	`Function, alist-keys`:	Public ordinary functions
	`Function, alist-values`:	Public ordinary functions
	`Function, alistp`:	Public ordinary functions
	`Function, plist-keys`:	Public ordinary functions
	`Function, plist-values`:	Public ordinary functions
	`Function, plistp`:	Public ordinary functions

M
	`Macro, defprop`:	Public macros
	`Macro, multf`:	Public macros
	`Macro, unlessf`:	Public macros
	`multf`:	Public macros

P
	`plist-keys`:	Public ordinary functions
	`plist-values`:	Public ordinary functions
	`plistp`:	Public ordinary functions

U
	`unlessf`:	Public macros

Jump to:	A D F M P U

A.3 Variables

A.4 Data types

Jump to:	A C F L N P S T

	Index Entry	Section

A
	`alexandria+`:	The alexandria+ system
	`alexandria+`:	The alexandria+ package
	`alexandria+.asd`:	The alexandria+/alexandria+․asd file
	`alist`:	Public types

C
	`control-flow.lisp`:	The alexandria+/control-flow․lisp file

F
	`File, alexandria+.asd`:	The alexandria+/alexandria+․asd file
	`File, control-flow.lisp`:	The alexandria+/control-flow․lisp file
	`File, lists.lisp`:	The alexandria+/lists․lisp file
	`File, numbers.lisp`:	The alexandria+/numbers․lisp file
	`File, pkgdcl.lisp`:	The alexandria+/pkgdcl․lisp file
	`File, types.lisp`:	The alexandria+/types․lisp file

L
	`lists.lisp`:	The alexandria+/lists․lisp file

N
	`numbers.lisp`:	The alexandria+/numbers․lisp file

P
	`Package, alexandria+`:	The alexandria+ package
	`percentage`:	Public types
	`pkgdcl.lisp`:	The alexandria+/pkgdcl․lisp file
	`plist`:	Public types
	`probability`:	Public types

S
	`System, alexandria+`:	The alexandria+ system

T
	`Type, alist`:	Public types
	`Type, percentage`:	Public types
	`Type, plist`:	Public types
	`Type, probability`:	Public types
	`types.lisp`:	The alexandria+/types․lisp file

Jump to:	A C F L N P S T

The ALEXANDRIA+ Reference Manual

The ALEXANDRIA+ Reference Manual

Table of Contents

Copying

1 Systems

1.1 alexandria+

2 Files

2.1 Lisp

2.1.1 alexandria+/alexandria+.asd

2.1.2 alexandria+/pkgdcl.lisp

2.1.3 alexandria+/lists.lisp

2.1.4 alexandria+/types.lisp

2.1.5 alexandria+/numbers.lisp

2.1.6 alexandria+/control-flow.lisp

3 Packages

3.1 alexandria+

4 Definitions

4.1 Public Interface

4.1.1 Macros

4.1.2 Ordinary functions

4.1.3 Types

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

1.1 `alexandria+`

2.1.1 `alexandria+/alexandria+.asd`

2.1.2 `alexandria+/pkgdcl.lisp`

2.1.3 `alexandria+/lists.lisp`

2.1.4 `alexandria+/types.lisp`

2.1.5 `alexandria+/numbers.lisp`

2.1.6 `alexandria+/control-flow.lisp`

3.1 `alexandria+`