The alexandria+ Reference Manual

This is the alexandria+ Reference Manual, version 1.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 04:11:40 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 alexandria+

A conservative set of extensions to Alexandria utilities.

Author

Steven Nunez <>

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

3 Files

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


3.1 Lisp


3.1.1 alexandria+/alexandria+.asd

Source

alexandria+.asd.

Parent Component

alexandria+ (system).

ASDF Systems

alexandria+.


3.1.2 alexandria+/pkgdcl.lisp

Source

alexandria+.asd.

Parent Component

alexandria+ (system).

Packages

alexandria+.


3.1.3 alexandria+/lists.lisp

Source

alexandria+.asd.

Parent Component

alexandria+ (system).

Public Interface

3.1.4 alexandria+/types.lisp

Source

alexandria+.asd.

Parent Component

alexandria+ (system).

Public Interface

3.1.5 alexandria+/numbers.lisp

Source

alexandria+.asd.

Parent Component

alexandria+ (system).

Public Interface

multf (macro).


3.1.6 alexandria+/control-flow.lisp

Source

alexandria+.asd.

Parent Component

alexandria+ (system).

Public Interface

unlessf (macro).


4 Packages

Packages are listed by definition order.


4.1 alexandria+

Source

pkgdcl.lisp.

Use List
  • alexandria.
  • common-lisp.
Public Interface

5 Definitions

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


5.1 Public Interface


5.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.


5.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.


5.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.3 Variables