The alexandria Reference Manual

4.1.1 alexandria/alexandria.asd

Source

alexandria.asd.

Parent Component

alexandria (system).

ASDF Systems

alexandria.

---

4.1.2 alexandria/alexandria-1/package.lisp

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Packages

alexandria.

---

4.1.3 alexandria/alexandria-1/definitions.lisp

Dependency

package.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Public Interface

define-constant (macro).

Internals

%reevaluate-constant (function).

---

4.1.4 alexandria/alexandria-1/binding.lisp

Dependency

package.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Public Interface

• if-let (macro).
• when-let (macro).
• when-let* (macro).

---

4.1.5 alexandria/alexandria-1/strings.lisp

Dependency

package.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Public Interface

string-designator (type).

---

4.1.6 alexandria/alexandria-1/conditions.lisp

Dependency

package.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Public Interface

• ignore-some-conditions (macro).
• required-argument (function).
• simple-parse-error (function).
• simple-parse-error (condition).
• simple-program-error (function).
• simple-program-error (condition).
• simple-reader-error (function).
• simple-reader-error (condition).
• simple-style-warning (function).
• simple-style-warning (condition).
• unwind-protect-case (macro).

---

4.1.7 alexandria/alexandria-1/io.lisp

Dependencies

• package.lisp (file).
• macros.lisp (file).
• lists.lisp (file).
• types.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Public Interface

• copy-file (function).
• copy-stream (function).
• read-file-into-byte-vector (function).
• read-file-into-string (function).
• read-stream-content-into-byte-vector (function).
• read-stream-content-into-string (function).
• with-input-from-file (macro).
• with-output-to-file (macro).
• write-byte-vector-into-file (function).
• write-string-into-file (function).

Internals

• default-element-type (function).
• with-open-file* (macro).

---

4.1.8 alexandria/alexandria-1/macros.lisp

Dependencies

• package.lisp (file).
• strings.lisp (file).
• symbols.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Public Interface

• destructuring-case (macro).
• destructuring-ccase (macro).
• destructuring-ecase (macro).
• once-only (macro).
• parse-body (function).
• parse-ordinary-lambda-list (function).
• with-gensyms (macro).
• with-unique-names (macro).

Internals

expand-destructuring-case (function).

---

4.1.9 alexandria/alexandria-1/hash-tables.lisp

Dependencies

• package.lisp (file).
• macros.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Public Interface

• alist-hash-table (function).
• copy-hash-table (function).
• ensure-gethash (macro).
• hash-table-alist (function).
• hash-table-keys (function).
• hash-table-plist (function).
• hash-table-values (function).
• maphash-keys (function).
• maphash-values (function).
• plist-hash-table (function).

---

4.1.10 alexandria/alexandria-1/control-flow.lisp

Dependencies

• package.lisp (file).
• definitions.lisp (file).
• macros.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Public Interface

• cswitch (macro).
• eswitch (macro).
• multiple-value-prog2 (macro).
• nth-value-or (macro).
• switch (macro).
• whichever (macro).
• xor (macro).

Internals

• extract-function-name (function).
• generate-switch-body (function).

---

4.1.11 alexandria/alexandria-1/symbols.lisp

Dependency

package.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Public Interface

• ensure-symbol (function).
• format-symbol (function).
• make-gensym (function).
• make-gensym-list (function).
• make-keyword (function).
• symbolicate (function).

Internals

maybe-intern (function).

---

4.1.12 alexandria/alexandria-1/functions.lisp

Dependencies

• package.lisp (file).
• symbols.lisp (file).
• macros.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Public Interface

• compose (compiler macro).
• compose (function).
• conjoin (function).
• curry (compiler macro).
• curry (function).
• disjoin (function).
• ensure-function (function).
• ensure-functionf (macro).
• multiple-value-compose (compiler macro).
• multiple-value-compose (function).
• named-lambda (macro).
• rcurry (compiler macro).
• rcurry (function).

Internals

ensure-functionf/1 (macro).

---

4.1.13 alexandria/alexandria-1/lists.lisp

Dependencies

• package.lisp (file).
• functions.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Public Interface

• alist-plist (function).
• appendf (macro).
• (setf assoc-value) (setf expander).
• assoc-value (function).
• circular-list (function).
• circular-list (type).
• circular-list-p (function).
• circular-tree-p (function).
• delete-from-plist (function).
• delete-from-plistf (macro).
• doplist (macro).
• ensure-car (function).
• ensure-cons (function).
• ensure-list (function).
• flatten (function).
• lastcar (function).
• (setf lastcar) (function).
• make-circular-list (function).
• map-product (function).
• mappend (function).
• nconcf (macro).
• nreversef (macro).
• nunionf (macro).
• plist-alist (function).
• proper-list (type).
• proper-list-length (function).
• proper-list-p (function).
• (setf rassoc-value) (setf expander).
• rassoc-value (function).
• remove-from-plist (function).
• remove-from-plistf (macro).
• reversef (macro).
• set-equal (function).
• setp (function).
• unionf (macro).

Internals

• circular-list-error (function).
• malformed-plist (function).
• racons (function).
• safe-endp (function).
• sans (function).

---

4.1.14 alexandria/alexandria-1/types.lisp

Dependencies

• package.lisp (file).
• symbols.lisp (file).
• lists.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Public Interface

• array-index (type).
• array-length (type).
• coercef (macro).
• negative-double-float (type).
• negative-double-float-p (function).
• negative-fixnum (type).
• negative-fixnum-p (function).
• negative-float (type).
• negative-float-p (function).
• negative-integer (type).
• negative-integer-p (function).
• negative-long-float (type).
• negative-long-float-p (function).
• negative-rational (type).
• negative-rational-p (function).
• negative-real (type).
• negative-real-p (function).
• negative-short-float (type).
• negative-short-float-p (function).
• negative-single-float (type).
• negative-single-float-p (function).
• non-negative-double-float (type).
• non-negative-double-float-p (function).
• non-negative-fixnum (type).
• non-negative-fixnum-p (function).
• non-negative-float (type).
• non-negative-float-p (function).
• non-negative-integer (type).
• non-negative-integer-p (function).
• non-negative-long-float (type).
• non-negative-long-float-p (function).
• non-negative-rational (type).
• non-negative-rational-p (function).
• non-negative-real (type).
• non-negative-real-p (function).
• non-negative-short-float (type).
• non-negative-short-float-p (function).
• non-negative-single-float (type).
• non-negative-single-float-p (function).
• non-positive-double-float (type).
• non-positive-double-float-p (function).
• non-positive-fixnum (type).
• non-positive-fixnum-p (function).
• non-positive-float (type).
• non-positive-float-p (function).
• non-positive-integer (type).
• non-positive-integer-p (function).
• non-positive-long-float (type).
• non-positive-long-float-p (function).
• non-positive-rational (type).
• non-positive-rational-p (function).
• non-positive-real (type).
• non-positive-real-p (function).
• non-positive-short-float (type).
• non-positive-short-float-p (function).
• non-positive-single-float (type).
• non-positive-single-float-p (function).
• of-type (compiler macro).
• of-type (function).
• positive-double-float (type).
• positive-double-float-p (function).
• positive-fixnum (type).
• positive-fixnum-p (function).
• positive-float (type).
• positive-float-p (function).
• positive-integer (type).
• positive-integer-p (function).
• positive-long-float (type).
• positive-long-float-p (function).
• positive-rational (type).
• positive-rational-p (function).
• positive-real (type).
• positive-real-p (function).
• positive-short-float (type).
• positive-short-float-p (function).
• positive-single-float (type).
• positive-single-float-p (function).
• type= (function).

---

4.1.15 alexandria/alexandria-1/arrays.lisp

Dependencies

• package.lisp (file).
• types.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Public Interface

copy-array (function).

---

4.1.16 alexandria/alexandria-1/sequences.lisp

Dependencies

• package.lisp (file).
• lists.lisp (file).
• types.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Public Interface

• copy-sequence (function).
• deletef (macro).
• emptyp (compiler macro).
• ends-with (function).
• ends-with-subseq (function).
• extremum (function).
• first-elt (function).
• (setf first-elt) (function).
• last-elt (function).
• (setf last-elt) (function).
• length= (compiler macro).
• length= (function).
• map-combinations (function).
• map-derangements (function).
• map-permutations (function).
• proper-sequence (type).
• random-elt (function).
• removef (macro).
• rotate (function).
• sequence-of-length-p (function).
• shuffle (function).
• starts-with (function).
• starts-with-subseq (function).

Internals

• delete/swapped-arguments (function).
• remove/swapped-arguments (function).
• rotate-head-to-tail (function).
• rotate-tail-to-head (function).

---

4.1.17 alexandria/alexandria-1/numbers.lisp

Dependencies

• package.lisp (file).
• sequences.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Public Interface

• binomial-coefficient (function).
• clamp (function).
• count-permutations (function).
• factorial (function).
• gaussian-random (function).
• iota (function).
• lerp (function).
• map-iota (function).
• maxf (macro).
• mean (function).
• median (function).
• minf (macro).
• standard-deviation (function).
• subfactorial (function).
• variance (function).

Internals

• %factorial (function).
• %multiply-range (function).
• +factorial-bisection-range-limit+ (constant).
• +factorial-direct-multiplication-limit+ (constant).

---

4.1.18 alexandria/alexandria-1/features.lisp

Dependencies

• package.lisp (file).
• control-flow.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

Public Interface

featurep (function).

---

4.1.19 alexandria/alexandria-2/package.lisp

Source

alexandria.asd.

Parent Component

alexandria-2 (module).

Packages

alexandria-2.

---

4.1.20 alexandria/alexandria-2/arrays.lisp

Dependency

package.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-2 (module).

Public Interface

• dim-in-bounds-p (function).
• rmajor-to-indices (function).
• row-major-index (function).

---

4.1.21 alexandria/alexandria-2/control-flow.lisp

Dependency

package.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-2 (module).

Public Interface

• line-up-first (macro).
• line-up-last (macro).

Internals

line-up-iter (function).

---

4.1.22 alexandria/alexandria-2/sequences.lisp

Dependency

package.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-2 (module).

Public Interface

subseq* (function).

---

4.1.23 alexandria/alexandria-2/lists.lisp

Dependency

package.lisp (file).

Source

alexandria.asd.

Parent Component

alexandria-2 (module).

Public Interface

delete-from-plist* (function).

---

4.2.1 alexandria/LICENCE

Source

alexandria.asd.

Parent Component

alexandria (system).

---

4.2.2 alexandria/alexandria-1/tests.lisp

Source

alexandria.asd.

Parent Component

alexandria-1 (module).

---

4.2.3 alexandria/alexandria-2/tests.lisp

Source

alexandria.asd.

Parent Component

alexandria-2 (module).

---

6.1.1 Macros

Macro: appendf (place &rest lists) ¶

Modify-macro for APPEND. Appends LISTS to the place designated by the first argument.

Package

alexandria.

Source

lists.lisp.

Macro: coercef (place type-spec) ¶

Modify-macro for COERCE.

Package

alexandria.

Source

types.lisp.

Macro: cswitch ((object &key test key) &body clauses) ¶

Like SWITCH, but signals a continuable error if no key matches.

Package

alexandria.

Source

control-flow.lisp.

Macro: define-constant (name initial-value &key test documentation) ¶

Ensures that the global variable named by NAME is a constant with a value that is equal under TEST to the result of evaluating INITIAL-VALUE. TEST is a /function designator/ that defaults to EQL. If DOCUMENTATION is given, it becomes the documentation string of the constant.

Signals an error if NAME is already a bound non-constant variable.

Signals an error if NAME is already a constant variable whose value is not equal under TEST to result of evaluating INITIAL-VALUE.

Package

alexandria.

Source

definitions.lisp.

Macro: delete-from-plistf (place &rest keys) ¶

Modify macro for DELETE-FROM-PLIST.

Package

alexandria.

Source

lists.lisp.

Macro: deletef (place item &rest keyword-arguments) ¶

Modify-macro for DELETE. Sets place designated by the first argument to the result of calling DELETE with ITEM, place, and the KEYWORD-ARGUMENTS.

Package

alexandria.

Source

sequences.lisp.

Macro: destructuring-case (keyform &body clauses) ¶

DESTRUCTURING-CASE, -CCASE, and -ECASE are a combination of CASE and DESTRUCTURING-BIND. KEYFORM must evaluate to a CONS.

Clauses are of the form:

((CASE-KEYS . DESTRUCTURING-LAMBDA-LIST) FORM*)

The clause whose CASE-KEYS matches CAR of KEY, as if by CASE, CCASE, or ECASE,
is selected, and FORMs are then executed with CDR of KEY is destructured and
bound by the DESTRUCTURING-LAMBDA-LIST.

Example:

(defun dcase (x)
(destructuring-case x
((:foo a b)
(format nil "foo: ~S, ~S" a b))
((:bar &key a b)
(format nil "bar: ~S, ~S" a b))
(((:alt1 :alt2) a)
(format nil "alt: ~S" a))
((t &rest rest)
(format nil "unknown: ~S" rest))))

(dcase (list :foo 1 2)) ; => "foo: 1, 2"
(dcase (list :bar :a 1 :b 2)) ; => "bar: 1, 2"
(dcase (list :alt1 1)) ; => "alt: 1"
(dcase (list :alt2 2)) ; => "alt: 2"
(dcase (list :quux 1 2 3)) ; => "unknown: 1, 2, 3"

(defun decase (x)
(destructuring-case x
((:foo a b)
(format nil "foo: ~S, ~S" a b))
((:bar &key a b)
(format nil "bar: ~S, ~S" a b))
(((:alt1 :alt2) a)
(format nil "alt: ~S" a))))

(decase (list :foo 1 2)) ; => "foo: 1, 2"
(decase (list :bar :a 1 :b 2)) ; => "bar: 1, 2"
(decase (list :alt1 1)) ; => "alt: 1"
(decase (list :alt2 2)) ; => "alt: 2"
(decase (list :quux 1 2 3)) ; =| error

Package

alexandria.

Source

macros.lisp.

Macro: destructuring-ccase (keyform &body clauses) ¶

DESTRUCTURING-CASE, -CCASE, and -ECASE are a combination of CASE and DESTRUCTURING-BIND. KEYFORM must evaluate to a CONS.

Clauses are of the form:

((CASE-KEYS . DESTRUCTURING-LAMBDA-LIST) FORM*)

The clause whose CASE-KEYS matches CAR of KEY, as if by CASE, CCASE, or ECASE,
is selected, and FORMs are then executed with CDR of KEY is destructured and
bound by the DESTRUCTURING-LAMBDA-LIST.

Example:

(defun dcase (x)
(destructuring-case x
((:foo a b)
(format nil "foo: ~S, ~S" a b))
((:bar &key a b)
(format nil "bar: ~S, ~S" a b))
(((:alt1 :alt2) a)
(format nil "alt: ~S" a))
((t &rest rest)
(format nil "unknown: ~S" rest))))

(dcase (list :foo 1 2)) ; => "foo: 1, 2"
(dcase (list :bar :a 1 :b 2)) ; => "bar: 1, 2"
(dcase (list :alt1 1)) ; => "alt: 1"
(dcase (list :alt2 2)) ; => "alt: 2"
(dcase (list :quux 1 2 3)) ; => "unknown: 1, 2, 3"

(defun decase (x)
(destructuring-case x
((:foo a b)
(format nil "foo: ~S, ~S" a b))
((:bar &key a b)
(format nil "bar: ~S, ~S" a b))
(((:alt1 :alt2) a)
(format nil "alt: ~S" a))))

(decase (list :foo 1 2)) ; => "foo: 1, 2"
(decase (list :bar :a 1 :b 2)) ; => "bar: 1, 2"
(decase (list :alt1 1)) ; => "alt: 1"
(decase (list :alt2 2)) ; => "alt: 2"
(decase (list :quux 1 2 3)) ; =| error

Package

alexandria.

Source

macros.lisp.

Macro: destructuring-ecase (keyform &body clauses) ¶

DESTRUCTURING-CASE, -CCASE, and -ECASE are a combination of CASE and DESTRUCTURING-BIND. KEYFORM must evaluate to a CONS.

Clauses are of the form:

((CASE-KEYS . DESTRUCTURING-LAMBDA-LIST) FORM*)

The clause whose CASE-KEYS matches CAR of KEY, as if by CASE, CCASE, or ECASE,
is selected, and FORMs are then executed with CDR of KEY is destructured and
bound by the DESTRUCTURING-LAMBDA-LIST.

Example:

(defun dcase (x)
(destructuring-case x
((:foo a b)
(format nil "foo: ~S, ~S" a b))
((:bar &key a b)
(format nil "bar: ~S, ~S" a b))
(((:alt1 :alt2) a)
(format nil "alt: ~S" a))
((t &rest rest)
(format nil "unknown: ~S" rest))))

(dcase (list :foo 1 2)) ; => "foo: 1, 2"
(dcase (list :bar :a 1 :b 2)) ; => "bar: 1, 2"
(dcase (list :alt1 1)) ; => "alt: 1"
(dcase (list :alt2 2)) ; => "alt: 2"
(dcase (list :quux 1 2 3)) ; => "unknown: 1, 2, 3"

(defun decase (x)
(destructuring-case x
((:foo a b)
(format nil "foo: ~S, ~S" a b))
((:bar &key a b)
(format nil "bar: ~S, ~S" a b))
(((:alt1 :alt2) a)
(format nil "alt: ~S" a))))

(decase (list :foo 1 2)) ; => "foo: 1, 2"
(decase (list :bar :a 1 :b 2)) ; => "bar: 1, 2"
(decase (list :alt1 1)) ; => "alt: 1"
(decase (list :alt2 2)) ; => "alt: 2"
(decase (list :quux 1 2 3)) ; =| error

Package

alexandria.

Source

macros.lisp.

Macro: doplist ((key val plist &optional values) &body body) ¶

Iterates over elements of PLIST. BODY can be preceded by declarations, and is like a TAGBODY. RETURN may be used to terminate the iteration early. If RETURN is not used, returns VALUES.

Package

alexandria.

Source

lists.lisp.

Macro: ensure-functionf (&rest places) ¶

Multiple-place modify macro for ENSURE-FUNCTION: ensures that each of PLACES contains a function.

Package

alexandria.

Source

functions.lisp.

Macro: ensure-gethash (key hash-table &optional default) ¶

Like GETHASH, but if KEY is not found in the HASH-TABLE saves the DEFAULT under key before returning it. Secondary return value is true if key was already in the table.

Package

alexandria.

Source

hash-tables.lisp.

Macro: eswitch ((object &key test key) &body clauses) ¶

Like SWITCH, but signals an error if no key matches.

Package

alexandria.

Source

control-flow.lisp.

Macro: if-let (bindings &body then-form) ¶

Creates new variable bindings, and conditionally executes either
THEN-FORM or ELSE-FORM. ELSE-FORM defaults to NIL.

BINDINGS must be either single binding of the form:

(variable initial-form)

or a list of bindings of the form:

((variable-1 initial-form-1)
(variable-2 initial-form-2)
...
(variable-n initial-form-n))

All initial-forms are executed sequentially in the specified order. Then all the variables are bound to the corresponding values.

If all variables were bound to true values, the THEN-FORM is executed with the bindings in effect, otherwise the ELSE-FORM is executed with the bindings in effect.

Package

alexandria.

Source

binding.lisp.

Macro: ignore-some-conditions ((&rest conditions) &body body) ¶

Similar to CL:IGNORE-ERRORS but the (unevaluated) CONDITIONS list determines which specific conditions are to be ignored.

Package

alexandria.

Source

conditions.lisp.

Macro: line-up-first (&rest forms) ¶

Lines up FORMS elements as the first argument of their successor. Example:

(line-up-first
5
(+ 20)
/
(+ 40))

is equivalent to:

(+ (/ (+ 5 20)) 40)

Note how the single ’/ got converted into a list before threading.

Package

alexandria-2.

Source

control-flow.lisp.

Macro: line-up-last (&rest forms) ¶

Lines up FORMS elements as the last argument of their successor. Example:

(line-up-last
5
(+ 20)
/
(+ 40))

is equivalent to:

(+ 40 (/ (+ 20 5)))

Note how the single ’/ got converted into a list before threading.

Package

alexandria-2.

Source

control-flow.lisp.

Macro: maxf (place &rest numbers) ¶

Modify-macro for MAX. Sets place designated by the first argument to the maximum of its original value and NUMBERS.

Package

alexandria.

Source

numbers.lisp.

Macro: minf (place &rest numbers) ¶

Modify-macro for MIN. Sets place designated by the first argument to the minimum of its original value and NUMBERS.

Package

alexandria.

Source

numbers.lisp.

Macro: multiple-value-prog2 (first-form second-form &body forms) ¶

Evaluates FIRST-FORM, then SECOND-FORM, and then FORMS. Yields as its value all the value returned by SECOND-FORM.

Package

alexandria.

Source

control-flow.lisp.

Macro: named-lambda (name lambda-list &body body) ¶

Expands into a lambda-expression within whose BODY NAME denotes the corresponding function.

Package

alexandria.

Source

functions.lisp.

Macro: nconcf (place &rest lists) ¶

Modify-macro for NCONC. Concatenates LISTS to place designated by the first argument.

Package

alexandria.

Source

lists.lisp.

Macro: nreversef (place) ¶

Modify-macro for NREVERSE. Reverses the list stored in the given place by destructively modifying it and saves back the result into the place.

Package

alexandria.

Source

lists.lisp.

Macro: nth-value-or (nth-value &body forms) ¶

Evaluates FORM arguments one at a time, until the NTH-VALUE returned by one of the forms is true. It then returns all the values returned by evaluating that form. If none of the forms return a true nth value, this form returns NIL.

Package

alexandria.

Source

control-flow.lisp.

Macro: nunionf (place list &rest args) ¶

Modify-macro for NUNION. Saves the union of LIST and the contents of the place designated by the first argument to the designated place. May modify either argument.

Package

alexandria.

Source

lists.lisp.

Macro: once-only (specs &body forms) ¶

Constructs code whose primary goal is to help automate the handling of multiple evaluation within macros. Multiple evaluation is handled by introducing intermediate variables, in order to reuse the result of an expression.

The returned value is a list of the form

(let ((<gensym-1> <expr-1>)
...
(<gensym-n> <expr-n>))
<res>)

where GENSYM-1, ..., GENSYM-N are the intermediate variables introduced in order to evaluate EXPR-1, ..., EXPR-N once, only. RES is code that is the result of evaluating the implicit progn FORMS within a special context determined by SPECS. RES should make use of (reference) the intermediate variables.

Each element within SPECS is either a symbol SYMBOL or a pair (SYMBOL INITFORM). Bare symbols are equivalent to the pair (SYMBOL SYMBOL).

Each pair (SYMBOL INITFORM) specifies a single intermediate variable:

- INITFORM is an expression evaluated to produce EXPR-i

- SYMBOL is the name of the variable that will be bound around FORMS to the corresponding gensym GENSYM-i, in order for FORMS to generate RES that references the intermediate variable

The evaluation of INITFORMs and binding of SYMBOLs resembles LET. INITFORMs of all the pairs are evaluated before binding SYMBOLs and evaluating FORMS.

Example:

The following expression

(let ((x ’(incf y)))
(once-only (x)
‘(cons ,x ,x)))

;;; =>
;;; (let ((#1=#:X123 (incf y)))
;;; (cons #1# #1#))

could be used within a macro to avoid multiple evaluation like so

(defmacro cons1 (x)
(once-only (x)
‘(cons ,x ,x)))

(let ((y 0))
(cons1 (incf y)))

;;; => (1 . 1)

Example:

The following expression demonstrates the usage of the INITFORM field

(let ((expr ’(incf y)))
(once-only ((var ‘(1+ ,expr)))
‘(list ’,expr ,var ,var)))

;;; =>
;;; (let ((#1=#:VAR123 (1+ (incf y))))
;;; (list ’(incf y) #1# #1))

which could be used like so

(defmacro print-succ-twice (expr)
(once-only ((var ‘(1+ ,expr)))
‘(format t "Expr: ~s, Once: ~s, Twice: ~s~%" ’,expr ,var ,var)))

(let ((y 10))
(print-succ-twice (incf y)))

;;; >>
;;; Expr: (INCF Y), Once: 12, Twice: 12

Package

alexandria.

Source

macros.lisp.

Macro: remove-from-plistf (place &rest keys) ¶

Modify macro for REMOVE-FROM-PLIST.

Package

alexandria.

Source

lists.lisp.

Macro: removef (place item &rest keyword-arguments) ¶

Modify-macro for REMOVE. Sets place designated by the first argument to the result of calling REMOVE with ITEM, place, and the KEYWORD-ARGUMENTS.

Package

alexandria.

Source

sequences.lisp.

Macro: reversef (place) ¶

Modify-macro for REVERSE. Copies and reverses the list stored in the given place and saves back the result into the place.

Package

alexandria.

Source

lists.lisp.

Macro: switch ((object &key test key) &body clauses) ¶

Evaluates first matching clause, returning its values, or evaluates and returns the values of T or OTHERWISE if no keys match.

Package

alexandria.

Source

control-flow.lisp.

Macro: unionf (place list &rest args) ¶

Modify-macro for UNION. Saves the union of LIST and the contents of the place designated by the first argument to the designated place.

Package

alexandria.

Source

lists.lisp.

Macro: unwind-protect-case ((&optional abort-flag) protected-form &body clauses) ¶

Like CL:UNWIND-PROTECT, but you can specify the circumstances that
the cleanup CLAUSES are run.

clauses ::= (:NORMAL form*)* | (:ABORT form*)* | (:ALWAYS form*)*

Clauses can be given in any order, and more than one clause can be
given for each circumstance. The clauses whose denoted circumstance
occured, are executed in the order the clauses appear.

ABORT-FLAG is the name of a variable that will be bound to T in
CLAUSES if the PROTECTED-FORM aborted preemptively, and to NIL
otherwise.

Examples:

(unwind-protect-case ()
(protected-form)
(:normal (format t "This is only evaluated if PROTECTED-FORM executed normally.~%")) (:abort (format t "This is only evaluated if PROTECTED-FORM aborted preemptively.~%")) (:always (format t "This is evaluated in either case.~%")))

(unwind-protect-case (aborted-p)
(protected-form)
(:always (perform-cleanup-if aborted-p)))

Package

alexandria.

Source

conditions.lisp.

Macro: when-let (bindings &body forms) ¶

Creates new variable bindings, and conditionally executes FORMS.

BINDINGS must be either single binding of the form:

(variable initial-form)

or a list of bindings of the form:

((variable-1 initial-form-1)
(variable-2 initial-form-2)
...
(variable-n initial-form-n))

All initial-forms are executed sequentially in the specified order. Then all the variables are bound to the corresponding values.

If all variables were bound to true values, then FORMS are executed as an implicit PROGN.

Package

alexandria.

Source

binding.lisp.

Macro: when-let* (bindings &body body) ¶

Creates new variable bindings, and conditionally executes BODY.

BINDINGS must be either single binding of the form:

(variable initial-form)

or a list of bindings of the form:

((variable-1 initial-form-1)
(variable-2 initial-form-2)
...
(variable-n initial-form-n))

Each INITIAL-FORM is executed in turn, and the variable bound to the corresponding value. INITIAL-FORM expressions can refer to variables previously bound by the WHEN-LET*.

Execution of WHEN-LET* stops immediately if any INITIAL-FORM evaluates to NIL. If all INITIAL-FORMs evaluate to true, then BODY is executed as an implicit PROGN.

Package

alexandria.

Source

binding.lisp.

Macro: whichever (&rest possibilities) ¶

Evaluates exactly one of POSSIBILITIES, chosen at random.

Package

alexandria.

Source

control-flow.lisp.

Macro: with-gensyms (names &body forms) ¶

Binds a set of variables to gensyms and evaluates the implicit progn FORMS.

Each element within NAMES is either a symbol SYMBOL or a pair (SYMBOL STRING-DESIGNATOR). Bare symbols are equivalent to the pair (SYMBOL SYMBOL).

Each pair (SYMBOL STRING-DESIGNATOR) specifies that the variable named by SYMBOL should be bound to a symbol constructed using GENSYM with the string designated by STRING-DESIGNATOR being its first argument.

Package

alexandria.

Source

macros.lisp.

Macro: with-input-from-file ((stream-name file-name &rest args &key direction &allow-other-keys) &body body) ¶

Evaluate BODY with STREAM-NAME to an input stream on the file FILE-NAME. ARGS is sent as is to the call to OPEN except EXTERNAL-FORMAT, which is only sent to WITH-OPEN-FILE when it’s not NIL.

Package

alexandria.

Source

io.lisp.

Macro: with-output-to-file ((stream-name file-name &rest args &key direction &allow-other-keys) &body body) ¶

Evaluate BODY with STREAM-NAME to an output stream on the file FILE-NAME. ARGS is sent as is to the call to OPEN except EXTERNAL-FORMAT, which is only sent to WITH-OPEN-FILE when it’s not NIL.

Package

alexandria.

Source

io.lisp.

Macro: with-unique-names (names &body forms) ¶

Alias for WITH-GENSYMS.

Package

alexandria.

Source

macros.lisp.

Macro: xor (&rest datums) ¶

Evaluates its arguments one at a time, from left to right. If more than one argument evaluates to a true value no further DATUMS are evaluated, and NIL is returned as both primary and secondary value. If exactly one argument evaluates to true, its value is returned as the primary value after all the arguments have been evaluated, and T is returned as the secondary value. If no arguments evaluate to true NIL is returned as primary, and T as secondary value.

Package

alexandria.

Source

control-flow.lisp.

---

6.1.2 Compiler macros

Compiler Macro: compose (function &rest more-functions) ¶

Package

alexandria.

Source

functions.lisp.

Compiler Macro: curry (function &rest arguments) ¶

Package

alexandria.

Source

functions.lisp.

Compiler Macro: emptyp (sequence) ¶

Package

alexandria.

Source

sequences.lisp.

Compiler Macro: length= (length &rest sequences) ¶

Package

alexandria.

Source

sequences.lisp.

Compiler Macro: multiple-value-compose (function &rest more-functions) ¶

Package

alexandria.

Source

functions.lisp.

Compiler Macro: of-type (type) ¶

Package

alexandria.

Source

types.lisp.

Compiler Macro: rcurry (function &rest arguments) ¶

Package

alexandria.

Source

functions.lisp.

---

6.1.3 Setf expanders

Setf Expander: (setf assoc-value) (place key &key test) ¶

Package

alexandria.

Source

lists.lisp.

Reader

assoc-value (function).

Setf Expander: (setf rassoc-value) (place key &key test) ¶

Package

alexandria.

Source

lists.lisp.

Reader

rassoc-value (function).

---

6.1.4 Ordinary functions

Function: alist-hash-table (alist &rest hash-table-initargs) ¶

Returns a hash table containing the keys and values of the association list ALIST. Hash table is initialized using the HASH-TABLE-INITARGS.

Package

alexandria.

Source

hash-tables.lisp.

Function: alist-plist (alist) ¶

Returns a property list containing the same keys and values as the association list ALIST in the same order.

Package

alexandria.

Source

lists.lisp.

Function: assoc-value (alist key &key test) ¶

ASSOC-VALUE is an alist accessor very much like ASSOC, but it can be used with SETF.

Package

alexandria.

Source

lists.lisp.

Setf expander for this function

(setf assoc-value).

Function: binomial-coefficient (n k) ¶

Binomial coefficient of N and K, also expressed as N choose K. This is the number of K element combinations given N choises. N must be equal to or greater then K.

Package

alexandria.

Source

numbers.lisp.

Function: circular-list (&rest elements) ¶

Creates a circular list of ELEMENTS.

Package

alexandria.

Source

lists.lisp.

Function: circular-list-p (object) ¶

Returns true if OBJECT is a circular list, NIL otherwise.

Package

alexandria.

Source

lists.lisp.

Function: circular-tree-p (object) ¶

Returns true if OBJECT is a circular tree, NIL otherwise.

Package

alexandria.

Source

lists.lisp.

Function: clamp (number min max) ¶

Clamps the NUMBER into [min, max] range. Returns MIN if NUMBER is lesser then MIN and MAX if NUMBER is greater then MAX, otherwise returns NUMBER.

Package

alexandria.

Source

numbers.lisp.

Function: compose (function &rest more-functions) ¶

Returns a function composed of FUNCTION and MORE-FUNCTIONS that applies its arguments to to each in turn, starting from the rightmost of MORE-FUNCTIONS, and then calling the next one with the primary value of the last.

Package

alexandria.

Source

functions.lisp.

Function: conjoin (predicate &rest more-predicates) ¶

Returns a function that applies each of PREDICATE and MORE-PREDICATE functions in turn to its arguments, returning NIL if any of the predicates returns false, without calling the remaining predicates. If none of the predicates returns false, returns the primary value of the last predicate.

Package

alexandria.

Source

functions.lisp.

Function: copy-array (array &key element-type fill-pointer adjustable) ¶

Returns an undisplaced copy of ARRAY, with same fill-pointer and adjustability (if any) as the original, unless overridden by the keyword arguments.

Package

alexandria.

Source

arrays.lisp.

Function: copy-file (from to &key if-to-exists element-type finish-output) ¶

Package

alexandria.

Source

io.lisp.

Function: copy-hash-table (table &key key test size rehash-size rehash-threshold) ¶

Returns a copy of hash table TABLE, with the same keys and values as the TABLE. The copy has the same properties as the original, unless overridden by the keyword arguments.

Before each of the original values is set into the new hash-table, KEY is invoked on the value. As KEY defaults to CL:IDENTITY, a shallow copy is returned by default.

Package

alexandria.

Source

hash-tables.lisp.

Function: copy-sequence (type sequence) ¶

Returns a fresh sequence of TYPE, which has the same elements as SEQUENCE.

Package

alexandria.

Source

sequences.lisp.

Function: copy-stream (input output &key element-type buffer-size buffer start end finish-output) ¶

Reads data from INPUT and writes it to OUTPUT. Both INPUT and OUTPUT must
be streams, they will be passed to READ-SEQUENCE and WRITE-SEQUENCE and must have compatible element-types.

Package

alexandria.

Source

io.lisp.

Function: count-permutations (n &optional k) ¶

Number of K element permutations for a sequence of N objects. K defaults to N

Package

alexandria.

Source

numbers.lisp.

Function: curry (function &rest arguments) ¶

Returns a function that applies ARGUMENTS and the arguments it is called with to FUNCTION.

Package

alexandria.

Source

functions.lisp.

Function: delete-from-plist (plist &rest keys) ¶

Just like REMOVE-FROM-PLIST, but this version may destructively modify the provided PLIST.

Package

alexandria.

Source

lists.lisp.

Function: delete-from-plist* (plist &rest keys) ¶

Just like REMOVE-FROM-PLIST, but this version may destructively modify the provided PLIST.
The second return value is an alist of the removed items, in unspecified order.

Package

alexandria-2.

Source

lists.lisp.

Function: dim-in-bounds-p (dimensions &rest subscripts) ¶

Mirrors cl:array-in-bounds-p, but takes dimensions (list of integers) as its first argument instead of an array.
(array-in-bounds-p arr ...) == (dim-in-bounds-p (array-dimensions arr) ...)

Package

alexandria-2.

Source

arrays.lisp.

Function: disjoin (predicate &rest more-predicates) ¶

Returns a function that applies each of PREDICATE and MORE-PREDICATE functions in turn to its arguments, returning the primary value of the first predicate that returns true, without calling the remaining predicates. If none of the predicates returns true, NIL is returned.

Package

alexandria.

Source

functions.lisp.

Function: ends-with (object sequence &key test key) ¶

Returns true if SEQUENCE is a sequence whose last element is EQL to OBJECT. Returns NIL if the SEQUENCE is not a sequence or is an empty sequence. Signals an error if SEQUENCE is an improper list.

Package

alexandria.

Source

sequences.lisp.

Function: ends-with-subseq (suffix sequence &key test) ¶

Test whether SEQUENCE ends with SUFFIX. In other words: return true if the last (length SUFFIX) elements of SEQUENCE are equal to SUFFIX.

Package

alexandria.

Source

sequences.lisp.

Function: ensure-car (thing) ¶

If THING is a CONS, its CAR is returned. Otherwise THING is returned.

Package

alexandria.

Source

lists.lisp.

Function: ensure-cons (cons) ¶

If CONS is a cons, it is returned. Otherwise returns a fresh cons with CONS in the car, and NIL in the cdr.

Package

alexandria.

Source

lists.lisp.

Function: ensure-function (function-designator) ¶

Returns the function designated by FUNCTION-DESIGNATOR:
if FUNCTION-DESIGNATOR is a function, it is returned, otherwise it must be a function name and its FDEFINITION is returned.

Package

alexandria.

Source

functions.lisp.

Function: ensure-list (list) ¶

If LIST is a list, it is returned. Otherwise returns the list designated by LIST.

Package

alexandria.

Source

lists.lisp.

Function: ensure-symbol (name &optional package) ¶

Returns a symbol with name designated by NAME, accessible in package designated by PACKAGE. If symbol is not already accessible in PACKAGE, it is interned there. Returns a secondary value reflecting the status of the symbol in the package, which matches the secondary return value of INTERN.

Example:

(ensure-symbol :cons :cl) => cl:cons, :external

Package

alexandria.

Source

symbols.lisp.

Function: extremum (sequence predicate &key key start end) ¶

Returns the element of SEQUENCE that would appear first if the subsequence bounded by START and END was sorted using PREDICATE and KEY.

EXTREMUM determines the relationship between two elements of SEQUENCE by using the PREDICATE function. PREDICATE should return true if and only if the first argument is strictly less than the second one (in some appropriate sense). Two arguments X and Y are considered to be equal if (FUNCALL PREDICATE X Y) and (FUNCALL PREDICATE Y X) are both false.

The arguments to the PREDICATE function are computed from elements of SEQUENCE using the KEY function, if supplied. If KEY is not supplied or is NIL, the sequence element itself is used.

If SEQUENCE is empty, NIL is returned.

Package

alexandria.

Source

sequences.lisp.

Function: factorial (n) ¶

Factorial of non-negative integer N.

Package

alexandria.

Source

numbers.lisp.

Function: featurep (feature-expression) ¶

Returns T if the argument matches the state of the *FEATURES* list and NIL if it does not. FEATURE-EXPRESSION can be any atom or list acceptable to the reader macros #+ and #-.

Package

alexandria.

Source

features.lisp.

Function: first-elt (sequence) ¶

Returns the first element of SEQUENCE. Signals a type-error if SEQUENCE is not a sequence, or is an empty sequence.

Package

alexandria.

Source

sequences.lisp.

Function: (setf first-elt) (sequence) ¶

Sets the first element of SEQUENCE. Signals a type-error if SEQUENCE is
not a sequence, is an empty sequence, or if OBJECT cannot be stored in SEQUENCE.

Package

alexandria.

Source

sequences.lisp.

Function: flatten (tree) ¶

Traverses the tree in order, collecting non-null leaves into a list.

Package

alexandria.

Source

lists.lisp.

Function: format-symbol (package control &rest arguments) ¶

Constructs a string by applying ARGUMENTS to string designator CONTROL as if by FORMAT within WITH-STANDARD-IO-SYNTAX, and then creates a symbol named by that string.

If PACKAGE is NIL, returns an uninterned symbol, if package is T, returns a symbol interned in the current package, and otherwise returns a symbol interned in the package designated by PACKAGE.

Package

alexandria.

Source

symbols.lisp.

Function: gaussian-random (&optional min max) ¶

Returns two gaussian random double floats as the primary and secondary value, optionally constrained by MIN and MAX. Gaussian random numbers form a standard normal distribution around 0.0d0.

Sufficiently positive MIN or negative MAX will cause the algorithm used to take a very long time. If MIN is positive it should be close to zero, and similarly if MAX is negative it should be close to zero.

Package

alexandria.

Source

numbers.lisp.

Function: hash-table-alist (table) ¶

Returns an association list containing the keys and values of hash table TABLE.

Package

alexandria.

Source

hash-tables.lisp.

Function: hash-table-keys (table) ¶

Returns a list containing the keys of hash table TABLE.

Package

alexandria.

Source

hash-tables.lisp.

Function: hash-table-plist (table) ¶

Returns a property list containing the keys and values of hash table TABLE.

Package

alexandria.

Source

hash-tables.lisp.

Function: hash-table-values (table) ¶

Returns a list containing the values of hash table TABLE.

Package

alexandria.

Source

hash-tables.lisp.

Function: iota (n &key start step) ¶

Return a list of n numbers, starting from START (with numeric contagion from STEP applied), each consequtive number being the sum of the previous one and STEP. START defaults to 0 and STEP to 1.

Examples:

(iota 4) => (0 1 2 3)
(iota 3 :start 1 :step 1.0) => (1.0 2.0 3.0)
(iota 3 :start -1 :step -1/2) => (-1 -3/2 -2)

Package

alexandria.

Source

numbers.lisp.

Function: last-elt (sequence) ¶

Returns the last element of SEQUENCE. Signals a type-error if SEQUENCE is not a proper sequence, or is an empty sequence.

Package

alexandria.

Source

sequences.lisp.

Function: (setf last-elt) (sequence) ¶

Sets the last element of SEQUENCE. Signals a type-error if SEQUENCE is not a proper sequence, is an empty sequence, or if OBJECT cannot be stored in SEQUENCE.

Package

alexandria.

Source

sequences.lisp.

Function: lastcar (list) ¶

Returns the last element of LIST. Signals a type-error if LIST is not a proper list.

Package

alexandria.

Source

lists.lisp.

Function: (setf lastcar) (list) ¶

Sets the last element of LIST. Signals a type-error if LIST is not a proper list.

Package

alexandria.

Source

lists.lisp.

Function: length= (&rest sequences) ¶

Takes any number of sequences or integers in any order. Returns true iff the length of all the sequences and the integers are equal. Hint: there’s a compiler macro that expands into more efficient code if the first argument is a literal integer.

Package

alexandria.

Source

sequences.lisp.

Function: lerp (v a b) ¶

Returns the result of linear interpolation between A and B, using the interpolation coefficient V.

Package

alexandria.

Source

numbers.lisp.

Function: make-circular-list (length &key initial-element) ¶

Creates a circular list of LENGTH with the given INITIAL-ELEMENT.

Package

alexandria.

Source

lists.lisp.

Function: make-gensym (name) ¶

If NAME is a non-negative integer, calls GENSYM using it. Otherwise NAME must be a string designator, in which case calls GENSYM using the designated string as the argument.

Package

alexandria.

Source

symbols.lisp.

Function: make-gensym-list (length &optional x) ¶

Returns a list of LENGTH gensyms, each generated as if with a call to MAKE-GENSYM, using the second (optional, defaulting to "G") argument.

Package

alexandria.

Source

symbols.lisp.

Function: make-keyword (name) ¶

Interns the string designated by NAME in the KEYWORD package.

Package

alexandria.

Source

symbols.lisp.

Function: map-combinations (function sequence &key start end length copy) ¶

Calls FUNCTION with each combination of LENGTH constructable from the elements of the subsequence of SEQUENCE delimited by START and END. START defaults to 0, END to length of SEQUENCE, and LENGTH to the length of the delimited subsequence. (So unless LENGTH is specified there is only a single combination, which has the same elements as the delimited subsequence.) If COPY is true (the default) each combination is freshly allocated. If COPY is false all combinations are EQ to each other, in which case consequences are unspecified if a combination is modified by FUNCTION.

Package

alexandria.

Source

sequences.lisp.

Function: map-derangements (function sequence &key start end copy) ¶

Calls FUNCTION with each derangement of the subsequence of SEQUENCE denoted by the bounding index designators START and END. Derangement is a permutation of the sequence where no element remains in place. SEQUENCE is not modified, but individual derangements are EQ to each other. Consequences are unspecified if calling FUNCTION modifies either the derangement or SEQUENCE.

Package

alexandria.

Source

sequences.lisp.

Function: map-iota (function n &key start step) ¶

Calls FUNCTION with N numbers, starting from START (with numeric contagion from STEP applied), each consequtive number being the sum of the previous one and STEP. START defaults to 0 and STEP to 1. Returns N.

Examples:

(map-iota #’print 3 :start 1 :step 1.0) => 3
;;; 1.0
;;; 2.0
;;; 3.0

Package

alexandria.

Source

numbers.lisp.

Function: map-permutations (function sequence &key start end length copy) ¶

Calls function with each permutation of LENGTH constructable from the subsequence of SEQUENCE delimited by START and END. START defaults to 0, END to length of the sequence, and LENGTH to the length of the delimited subsequence.

Package

alexandria.

Source

sequences.lisp.

Function: map-product (function list &rest more-lists) ¶

Returns a list containing the results of calling FUNCTION with one argument from LIST, and one from each of MORE-LISTS for each combination of arguments. In other words, returns the product of LIST and MORE-LISTS using FUNCTION.

Example:

(map-product ’list ’(1 2) ’(3 4) ’(5 6))
=> ((1 3 5) (1 3 6) (1 4 5) (1 4 6)
(2 3 5) (2 3 6) (2 4 5) (2 4 6))

Package

alexandria.

Source

lists.lisp.

Function: maphash-keys (function table) ¶

Like MAPHASH, but calls FUNCTION with each key in the hash table TABLE.

Package

alexandria.

Source

hash-tables.lisp.

Function: maphash-values (function table) ¶

Like MAPHASH, but calls FUNCTION with each value in the hash table TABLE.

Package

alexandria.

Source

hash-tables.lisp.

Function: mappend (function &rest lists) ¶

Applies FUNCTION to respective element(s) of each LIST, appending all the all the result list to a single list. FUNCTION must return a list.

Package

alexandria.

Source

lists.lisp.

Function: mean (sample) ¶

Returns the mean of SAMPLE. SAMPLE must be a sequence of numbers.

Package

alexandria.

Source

numbers.lisp.

Function: median (sample) ¶

Returns median of SAMPLE. SAMPLE must be a sequence of real numbers.

Package

alexandria.

Source

numbers.lisp.

Function: multiple-value-compose (function &rest more-functions) ¶

Returns a function composed of FUNCTION and MORE-FUNCTIONS that applies its arguments to each in turn, starting from the rightmost of MORE-FUNCTIONS, and then calling the next one with all the return values of the last.

Package

alexandria.

Source

functions.lisp.

Function: negative-double-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: negative-fixnum-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: negative-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: negative-integer-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: negative-long-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: negative-rational-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: negative-real-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: negative-short-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: negative-single-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-negative-double-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-negative-fixnum-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-negative-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-negative-integer-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-negative-long-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-negative-rational-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-negative-real-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-negative-short-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-negative-single-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-positive-double-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-positive-fixnum-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-positive-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-positive-integer-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-positive-long-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-positive-rational-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-positive-real-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-positive-short-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: non-positive-single-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: of-type (type) ¶

Returns a function of one argument, which returns true when its argument is of TYPE.

Package

alexandria.

Source

types.lisp.

Function: parse-body (body &key documentation whole) ¶

Parses BODY into (values remaining-forms declarations doc-string). Documentation strings are recognized only if DOCUMENTATION is true. Syntax errors in body are signalled and WHOLE is used in the signal arguments when given.

Package

alexandria.

Source

macros.lisp.

Function: parse-ordinary-lambda-list (lambda-list &key normalize allow-specializers normalize-optional normalize-keyword normalize-auxilary) ¶

Parses an ordinary lambda-list, returning as multiple values:

1. Required parameters.

2. Optional parameter specifications, normalized into form:

(name init suppliedp)

3. Name of the rest parameter, or NIL.

4. Keyword parameter specifications, normalized into form:

((keyword-name name) init suppliedp)

5. Boolean indicating &ALLOW-OTHER-KEYS presence.

6. &AUX parameter specifications, normalized into form

(name init).

7. Existence of &KEY in the lambda-list.

Signals a PROGRAM-ERROR is the lambda-list is malformed.

Package

alexandria.

Source

macros.lisp.

Function: plist-alist (plist) ¶

Returns an association list containing the same keys and values as the property list PLIST in the same order.

Package

alexandria.

Source

lists.lisp.

Function: plist-hash-table (plist &rest hash-table-initargs) ¶

Returns a hash table containing the keys and values of the property list PLIST. Hash table is initialized using the HASH-TABLE-INITARGS.

Package

alexandria.

Source

hash-tables.lisp.

Function: positive-double-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: positive-fixnum-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: positive-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: positive-integer-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: positive-long-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: positive-rational-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: positive-real-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: positive-short-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: positive-single-float-p (n) ¶

Package

alexandria.

Source

types.lisp.

Function: proper-list-length (list) ¶

Returns length of LIST, signalling an error if it is not a proper list.

Package

alexandria.

Source

lists.lisp.

Function: proper-list-p (object) ¶

Returns true if OBJECT is a proper list.

Package

alexandria.

Source

lists.lisp.

Function: random-elt (sequence &key start end) ¶

Returns a random element from SEQUENCE bounded by START and END. Signals an error if the SEQUENCE is not a proper non-empty sequence, or if END and START are not proper bounding index designators for SEQUENCE.

Package

alexandria.

Source

sequences.lisp.

Function: rassoc-value (alist key &key test) ¶

RASSOC-VALUE is an alist accessor very much like RASSOC, but it can be used with SETF.

Package

alexandria.

Source

lists.lisp.

Setf expander for this function

(setf rassoc-value).

Function: rcurry (function &rest arguments) ¶

Returns a function that applies the arguments it is called with and ARGUMENTS to FUNCTION.

Package

alexandria.

Source

functions.lisp.

Function: read-file-into-byte-vector (pathname) ¶

Read PATHNAME into a freshly allocated (unsigned-byte 8) vector.

Package

alexandria.

Source

io.lisp.

Function: read-file-into-string (pathname &key buffer-size external-format) ¶

Return the contents of the file denoted by PATHNAME as a fresh string.

The EXTERNAL-FORMAT parameter will be passed directly to WITH-OPEN-FILE unless it’s NIL, which means the system default.

Package

alexandria.

Source

io.lisp.

Function: read-stream-content-into-byte-vector (stream &key %length initial-size) ¶

Return "content" of STREAM as freshly allocated (unsigned-byte 8) vector.

Package

alexandria.

Source

io.lisp.

Function: read-stream-content-into-string (stream &key buffer-size) ¶

Return the "content" of STREAM as a fresh string.

Package

alexandria.

Source

io.lisp.

Function: remove-from-plist (plist &rest keys) ¶

Returns a property-list with same keys and values as PLIST, except that keys in the list designated by KEYS and values corresponding to them are removed. The returned property-list may share structure with the PLIST, but PLIST is not destructively modified. Keys are compared using EQ.

Package

alexandria.

Source

lists.lisp.

Function: required-argument (&optional name) ¶

Signals an error for a missing argument of NAME. Intended for use as an initialization form for structure and class-slots, and a default value for required keyword arguments.

Package

alexandria.

Source

conditions.lisp.

Function: rmajor-to-indices (dimensions index) ¶

The inverse function to row-major-index. Given a set of dimensions and a row-major index, produce the list of indices <subscripts> such that (row-major-index dimensions sucscripts) = index

Package

alexandria-2.

Source

arrays.lisp.

Function: rotate (sequence &optional n) ¶

Returns a sequence of the same type as SEQUENCE, with the elements of SEQUENCE rotated by N: N elements are moved from the end of the sequence to the front if N is positive, and -N elements moved from the front to the end if N is negative. SEQUENCE must be a proper sequence. N must be an integer, defaulting to 1.

If absolute value of N is greater then the length of the sequence, the results are identical to calling ROTATE with

(* (signum n) (mod n (length sequence))).

Note: the original sequence may be destructively altered, and result sequence may share structure with it.

Package

alexandria.

Source

sequences.lisp.

Function: row-major-index (dimensions &rest subscripts) ¶

Mirrors cl:array-row-major-index, but takes dimensions (list of integers)
as its first argument instead of an array.
Signals an error if lengths of dimensions and subscripts are not equal (array-row-major-index arr ...) == (row-major-index (array-dimensions arr) ...)

Package

alexandria-2.

Source

arrays.lisp.

Function: sequence-of-length-p (sequence length) ¶

Return true if SEQUENCE is a sequence of length LENGTH. Signals an error if SEQUENCE is not a sequence. Returns FALSE for circular lists.

Package

alexandria.

Source

sequences.lisp.

Function: set-equal (list1 list2 &key test key) ¶

Returns true if every element of LIST1 matches some element of LIST2 and every element of LIST2 matches some element of LIST1. Otherwise returns false.

Package

alexandria.

Source

lists.lisp.

Function: setp (object &key test key) ¶

Returns true if OBJECT is a list that denotes a set, NIL otherwise. A list denotes a set if each element of the list is unique under KEY and TEST.

Package

alexandria.

Source

lists.lisp.

Function: shuffle (sequence &key start end) ¶

Returns a random permutation of SEQUENCE bounded by START and END. Original sequence may be destructively modified.
Signals an error if SEQUENCE is not a proper sequence.

Package

alexandria.

Source

sequences.lisp.

Function: simple-parse-error (message &rest args) ¶

Package

alexandria.

Source

conditions.lisp.

Function: simple-program-error (message &rest args) ¶

Package

alexandria.

Source

conditions.lisp.

Function: simple-reader-error (stream message &rest args) ¶

Package

alexandria.

Source

conditions.lisp.

Function: simple-style-warning (message &rest args) ¶

Package

alexandria.

Source

conditions.lisp.

Function: standard-deviation (sample &key biased) ¶

Standard deviation of SAMPLE. Returns the biased standard deviation if BIASED is true (the default), and the square root of the unbiased estimator for variance if BIASED is false (which is not the same as the unbiased estimator for standard deviation). SAMPLE must be a sequence of numbers.

Package

alexandria.

Source

numbers.lisp.

Function: starts-with (object sequence &key test key) ¶

Returns true if SEQUENCE is a sequence whose first element is EQL to OBJECT. Returns NIL if the SEQUENCE is not a sequence or is an empty sequence.

Package

alexandria.

Source

sequences.lisp.

Function: starts-with-subseq (prefix sequence &rest args &key return-suffix &allow-other-keys) ¶

Test whether the first elements of SEQUENCE are the same (as per TEST) as the elements of PREFIX.

If RETURN-SUFFIX is T the function returns, as a second value, a
sub-sequence or displaced array pointing to the sequence after PREFIX.

Package

alexandria.

Source

sequences.lisp.

Function: subfactorial (n) ¶

Subfactorial of the non-negative integer N.

Package

alexandria.

Source

numbers.lisp.

Function: subseq* (sequence start &optional end) ¶

Like SUBSEQ, but limits END to the length.

Package

alexandria-2.

Source

sequences.lisp.

Function: symbolicate (&rest things) ¶

Concatenate together the names of some strings and symbols, producing a symbol in the current package.

Package

alexandria.

Source

symbols.lisp.

Function: type= (type1 type2) ¶

Returns a primary value of T if TYPE1 and TYPE2 are the same type,
and a secondary value that is true is the type equality could be reliably determined: primary value of NIL and secondary value of T indicates that the types are not equivalent.

Package

alexandria.

Source

types.lisp.

Function: variance (sample &key biased) ¶

Variance of SAMPLE. Returns the biased variance if BIASED is true (the default), and the unbiased estimator of variance if BIASED is false. SAMPLE must be a sequence of numbers.

Package

alexandria.

Source

numbers.lisp.

Function: write-byte-vector-into-file (bytes pathname &key if-exists if-does-not-exist) ¶

Write BYTES to PATHNAME.

Package

alexandria.

Source

io.lisp.

Function: write-string-into-file (string pathname &key if-exists if-does-not-exist external-format) ¶

Write STRING to PATHNAME.

The EXTERNAL-FORMAT parameter will be passed directly to WITH-OPEN-FILE unless it’s NIL, which means the system default.

Package

alexandria.

Source

io.lisp.

---