The doplus Reference Manual

Table of Contents

The doplus Reference Manual

This is the doplus Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:42:38 2018 GMT+0.

1 Introduction

doplus - an iteration macro for Common Lisp

This is DO+ (doplus), the high-level, extensible iteration construct for Common Lisp.

By design, doplus has a reasonably simple implementation, that in particular doesn't make use of a code walker, allowing users to freely mix doplus loops with macrolets and every other kind of advanced Lisp construct.

Installation and dependencies

The preferred way to install doplus is by using Quicklisp.

doplus itself depends only on parse-declarations. FiveAM is used for the test suite.

Tests

To run the test suite, use ASDF.

License

doplus is distributed under the GPLv3. See the file COPYING for details. If you'd like a different license arrangement, please contact me. I'm very open about providing friendlier licenses to individuals and companies that I trust, but by default I won't allow complete strangers to profit from my code without giving anything back.

Further information

The home of doplus is https://bitbucket.org/alessiostalla/doplus. There you can find in-depth documentation, access the code repository and checkout the latest version.

2 Systems

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

2.1 doplus

Author

Alessio Stalla <alessiostalla@gmail.com>

License

GPLv3

Description

DO+ (doplus) is a high-level, extensible iteration construct for Common Lisp with a reasonably simple implementation, which in particular does not use a code walker.

Dependency

parse-declarations-1.0

Source

doplus.asd (file)

Components

• doplus.asd (file)
• packages.lisp (file)
• destructuring.lisp (file)
• doplus.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 doplus.asd

Location

doplus.asd

Systems

doplus (system)

3.1.2 doplus/packages.lisp

Dependency

doplus.asd (file)

Parent

doplus (system)

Location

packages.lisp

Packages

doplus

3.1.3 doplus/destructuring.lisp

Dependency

packages.lisp (file)

Parent

doplus (system)

Location

destructuring.lisp

Internal Definitions

• extract-variables (function)
• make-destructuring-form (function)

3.1.4 doplus/doplus.lisp

Dependency

destructuring.lisp (file)

Parent

doplus (system)

Location

doplus.lisp

Exported Definitions

• *iteration-variable* (special variable)
• accumulating-to (macro)
• accumulating-to-and-returning (macro)
• across (macro)
• being (macro)
• collect (macro)
• collecting-into (macro)
• collecting-into-and-returning (macro)
• counting (macro)
• defclause (macro)
• do+ (macro)
• finally (macro)
• finding (macro)
• for (macro)
• from (macro)
• generating (macro)
• hash-entries-of (macro)
• in (macro)
• in-list (macro)
• in-vector (macro)
• initially (macro)
• list-tails (macro)
• make-binding (function)
• make-epilogue (function)
• make-finalization (function)
• make-initialization (function)
• make-iteration (function)
• make-prologue (function)
• make-result (function)
• make-simple-iteration (function)
• make-step (function)
• make-termination (function)
• maximizing (macro)
• minimizing (macro)
• optimizing (macro)
• options (macro)
• options (structure)
• previous (macro)
• returning (macro)
• skip (macro)
• stop-when (macro)
• sum (macro)
• summing-to (macro)
• summing-to-and-returning (macro)
• symbols-in (macro)
• terminate (macro)
• to (macro)
• try-update (macro)
• update (macro)
• with (macro)

Internal Definitions

• %make-binding (function)
• *clauses* (special variable)
• accumulator (structure)
• accumulator-function (function)
• (setf accumulator-function) (function)
• accumulator-p (function)
• accumulator-var (function)
• (setf accumulator-var) (function)
• binding (structure)
• binding-default (function)
• (setf binding-default) (function)
• binding-default-provided? (function)
• (setf binding-default-provided?) (function)
• binding-p (function)
• binding-var (function)
• (setf binding-var) (function)
• copy-accumulator (function)
• copy-binding (function)
• copy-declaration (function)
• copy-doplus-env (function)
• copy-epilogue (function)
• copy-finalization (function)
• copy-generator (function)
• copy-initialization (function)
• copy-options (function)
• copy-prologue (function)
• copy-result (function)
• copy-step (function)
• copy-termination (function)
• copy-wrapper (function)
• declaration (structure)
• declaration-form (function)
• (setf declaration-form) (function)
• declaration-p (function)
• declaring (macro)
• do+/internal (macro)
• doplus-env (structure)
• doplus-env-accumulators (function)
• (setf doplus-env-accumulators) (function)
• doplus-env-default-collect-var (function)
• (setf doplus-env-default-collect-var) (function)
• doplus-env-generators (function)
• (setf doplus-env-generators) (function)
• doplus-env-loop-name (function)
• (setf doplus-env-loop-name) (function)
• doplus-env-p (function)
• doplus-env-parent (function)
• (setf doplus-env-parent) (function)
• doplus-env-skip-label (function)
• (setf doplus-env-skip-label) (function)
• doplus-env-terminate-label (function)
• (setf doplus-env-terminate-label) (function)
• ensure-list (function)
• epilogue (structure)
• epilogue-form (function)
• (setf epilogue-form) (function)
• epilogue-p (function)
• expand-with-simple-destructuring (function)
• finalization (structure)
• finalization-form (function)
• (setf finalization-form) (function)
• finalization-p (function)
• find-generator (function)
• find-loop-in-env (function)
• generator (structure)
• generator-clauses (function)
• (setf generator-clauses) (function)
• generator-name (function)
• (setf generator-name) (function)
• generator-p (function)
• initialization (structure)
• initialization-form (function)
• (setf initialization-form) (function)
• initialization-p (function)
• make-accumulator (function)
• make-declaration (function)
• make-doplus-env (function)
• make-generator (function)
• make-options (function)
• make-wrapper (function)
• options-map (function)
• (setf options-map) (function)
• options-p (function)
• prologue (structure)
• prologue-form (function)
• (setf prologue-form) (function)
• prologue-p (function)
• result (structure)
• result-form (function)
• (setf result-form) (function)
• result-p (function)
• step (structure)
• step-form (function)
• (setf step-form) (function)
• step-p (function)
• termination (structure)
• termination-condition (function)
• (setf termination-condition) (function)
• termination-p (function)
• until (macro)
• while (macro)
• with-atomic-updates (macro)
• with-atomic-updates* (macro)
• with-doplus-body (macro)
• without-atomic-updates (macro)
• wrapper (structure)
• wrapper-function (function)
• (setf wrapper-function) (function)
• wrapper-p (function)

3.2 Other

3.2.1 doplus/doplus.asd

Parent

doplus (system)

Location

doplus.asd

4 Packages

Packages are listed by definition order.

4.1 doplus

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

• *iteration-variable* (special variable)
• accumulating-to (macro)
• accumulating-to-and-returning (macro)
• across (macro)
• being (macro)
• collect (macro)
• collecting-into (macro)
• collecting-into-and-returning (macro)
• counting (macro)
• defclause (macro)
• do+ (macro)
• finally (macro)
• finding (macro)
• for (macro)
• from (macro)
• generating (macro)
• hash-entries-of (macro)
• in (macro)
• in-list (macro)
• in-vector (macro)
• initially (macro)
• list-tails (macro)
• make-binding (function)
• make-epilogue (function)
• make-finalization (function)
• make-initialization (function)
• make-iteration (function)
• make-prologue (function)
• make-result (function)
• make-simple-iteration (function)
• make-step (function)
• make-termination (function)
• maximizing (macro)
• minimizing (macro)
• optimizing (macro)
• options (macro)
• options (structure)
• previous (macro)
• returning (macro)
• skip (macro)
• stop-when (macro)
• sum (macro)
• summing-to (macro)
• summing-to-and-returning (macro)
• symbols-in (macro)
• terminate (macro)
• to (macro)
• try-update (macro)
• update (macro)
• with (macro)

Internal Definitions

• %make-binding (function)
• *clauses* (special variable)
• accumulator (structure)
• accumulator-function (function)
• (setf accumulator-function) (function)
• accumulator-p (function)
• accumulator-var (function)
• (setf accumulator-var) (function)
• binding (structure)
• binding-default (function)
• (setf binding-default) (function)
• binding-default-provided? (function)
• (setf binding-default-provided?) (function)
• binding-p (function)
• binding-var (function)
• (setf binding-var) (function)
• copy-accumulator (function)
• copy-binding (function)
• copy-declaration (function)
• copy-doplus-env (function)
• copy-epilogue (function)
• copy-finalization (function)
• copy-generator (function)
• copy-initialization (function)
• copy-options (function)
• copy-prologue (function)
• copy-result (function)
• copy-step (function)
• copy-termination (function)
• copy-wrapper (function)
• declaration (structure)
• declaration-form (function)
• (setf declaration-form) (function)
• declaration-p (function)
• declaring (macro)
• do+/internal (macro)
• doplus-env (structure)
• doplus-env-accumulators (function)
• (setf doplus-env-accumulators) (function)
• doplus-env-default-collect-var (function)
• (setf doplus-env-default-collect-var) (function)
• doplus-env-generators (function)
• (setf doplus-env-generators) (function)
• doplus-env-loop-name (function)
• (setf doplus-env-loop-name) (function)
• doplus-env-p (function)
• doplus-env-parent (function)
• (setf doplus-env-parent) (function)
• doplus-env-skip-label (function)
• (setf doplus-env-skip-label) (function)
• doplus-env-terminate-label (function)
• (setf doplus-env-terminate-label) (function)
• ensure-list (function)
• epilogue (structure)
• epilogue-form (function)
• (setf epilogue-form) (function)
• epilogue-p (function)
• expand-with-simple-destructuring (function)
• extract-variables (function)
• finalization (structure)
• finalization-form (function)
• (setf finalization-form) (function)
• finalization-p (function)
• find-generator (function)
• find-loop-in-env (function)
• generator (structure)
• generator-clauses (function)
• (setf generator-clauses) (function)
• generator-name (function)
• (setf generator-name) (function)
• generator-p (function)
• initialization (structure)
• initialization-form (function)
• (setf initialization-form) (function)
• initialization-p (function)
• make-accumulator (function)
• make-declaration (function)
• make-destructuring-form (function)
• make-doplus-env (function)
• make-generator (function)
• make-options (function)
• make-wrapper (function)
• options-map (function)
• (setf options-map) (function)
• options-p (function)
• prologue (structure)
• prologue-form (function)
• (setf prologue-form) (function)
• prologue-p (function)
• result (structure)
• result-form (function)
• (setf result-form) (function)
• result-p (function)
• step (structure)
• step-form (function)
• (setf step-form) (function)
• step-p (function)
• termination (structure)
• termination-condition (function)
• (setf termination-condition) (function)
• termination-p (function)
• until (macro)
• while (macro)
• with-atomic-updates (macro)
• with-atomic-updates* (macro)
• with-doplus-body (macro)
• without-atomic-updates (macro)
• wrapper (structure)
• wrapper-function (function)
• (setf wrapper-function) (function)
• wrapper-p (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *iteration-variable*

Package

doplus

Source

doplus.lisp (file)

5.1.2 Macros

Macro: accumulating-to VARS &key INITIALLY BY FINALLY

Specifies an accumulation clause. Refer to the manual for details.

Package

doplus

Source

doplus.lisp (file)

Macro: accumulating-to-and-returning VARS &rest ARGS &key INITIALLY BY FINALLY

Same as accumulating-into, but also returns the value of each <vars> at the end of the loop.

Package

doplus

Source

doplus.lisp (file)

Macro: across VECTOR &rest ARGS &key INDEX START END BY

Synonym for in-vector.

Package

doplus

Source

doplus.lisp (file)

Macro: being FORM &key THEN

Assigns to the iteration variable a value computed by evaluating FORM on each iteration, including the first. Optionally, the variable can be updated evaluating a differen form (the value of the ‘then’ parameter). Examples: (for x (being (random))), (for y (being ’quiet :then (if (> x 0.5) ’angry ’quiet))).

Package

doplus

Source

doplus.lisp (file)

Macro: collect VALUE &key INTO

Collects a value into an accumulator. If no accumulator is provided, the default one for the current do+ loop is used.

Package

doplus

Source

doplus.lisp (file)

Macro: collecting-into VARS &rest ARGS &key INITIALLY BY FINALLY

Synonym for accumulating-to.

Package

doplus

Source

doplus.lisp (file)

Macro: collecting-into-and-returning VARS &rest ARGS &key INITIALLY BY FINALLY

Same as collecting-into, but also returns the value of each <vars> at the end of the loop.

Package

doplus

Source

doplus.lisp (file)

Macro: counting VAR

Counts the number of iterations, starting from 0.

Package

doplus

Source

doplus.lisp (file)

Macro: defclause NAME ARGLIST &body BODY

Same as cl:defmacro, but additionally records <name> in *clauses* as a known clause macro.

Package

doplus

Source

doplus.lisp (file)

Macro: do+ &body BODY

High-level, extensible iteration construct. Refer to the manual for syntax and semantics.

Package

doplus

Source

doplus.lisp (file)

Macro: finally &rest FORMS

Evaluates <form> after the last iteration, before returning a value.

Package

doplus

Source

doplus.lisp (file)

Macro: finding VAR CONDITION

Same as FOR, but perhaps nicer to read when used in conjunction with macros like MAXIMIZING.

Package

doplus

Source

doplus.lisp (file)

Macro: for VAR-OR-VARS ITERATION

General iteration clause. Its actual behaviour is controlled by ITERATION, a macro form that FOR expands with *ITERATION-VARIABLE* bound to VAR. Example: in (for x (in ’(1 2 3))), IN is a macro that expands into clauses that make use of *ITERATION-VARIABLE*, which is bound to the symbol X in the example. For certain iteration macros, VAR can be a lambda-list as well, in which case destructuring is applied. Example: (for (x &optional y) (in-list ’((1 2) (3)))).

Package

doplus

Source

doplus.lisp (file)

Macro: from INITIAL-VALUE &key TO BY WHILE USING

Iterates from a given initial value to an optional maximum. Every iteration increments/decrements the value applying the <using> function (by default +) to the previous value and <by> (by default 1 or -1, depending on whether to >= from or not). Similarly, the <while> function is used to determine if <to> has been reached or surpassed. <while> is a function of two arguments, the current value and the value of <to>, and as soon as it returns false, the loop is terminated. <while> defaults to a function that returns true only if <to> has been specified and, letting cur be the current value, (<= (min to from) cur (max to from)).

Package

doplus

Source

doplus.lisp (file)

Macro: generating VAR ITERATION

Lazy version of FOR. The user must call UPDATE or TRY-UPDATE in the body of the DO+ form in order to compute new values for the variable(s). Initialization, instead, is *always* performed eagerly.

Package

doplus

Source

doplus.lisp (file)

Macro: hash-entries-of HASH-TABLE

Iterates over the entries of a hash table. The iteration variables must be specified as (key value), for example: (for (lemma definitions) (hash-entries-of the-english-vocabulary)).

Package

doplus

Source

doplus.lisp (file)

Macro: in SEQ &rest ARGS &key &allow-other-keys

Iterates over a sequence. IN must be used in combination with FOR, GENERATING and similar macros (those that bind *ITERATION-VARIABLE*). In implementations with extensible sequences (currently ABCL and SBCL), native sequence iterators are used, and all sequence types are supported, not just lists and vectors. In other implementations, an iterator specialized for lists or vectors is used depending on the type of sequence. All ‘args‘ are passed down to make-sequence-iterator (see the extensible sequences API paper for details [Rhodes2007]). IN can perform destructuring.

Package

doplus

Source

doplus.lisp (file)

Macro: in-list LIST &key BY REST

Like IN, but specialized for lists. Successive lists are obtained by calling the function BY (which by default is #’CDR) on the previous list. REST, if specified, is the variable holding the remaining elements to be processed; REST initially is bound to the entire list, then to successive lists obtained by funcalling BY.

Package

doplus

Source

doplus.lisp (file)

Macro: in-vector VECTOR &key INDEX START END BY

Loops across a vector. INDEX is bound to the index of the current element in the vector. The vector is traversed starting from index START (0 by default) to index END (the end of the vector if not specified); the index is incremented by BY (1 by default) on each iteration.

Package

doplus

Source

doplus.lisp (file)

Macro: initially &rest FORMS

Evaluates <form> before the first iteration.

Package

doplus

Source

doplus.lisp (file)

Macro: list-tails LIST &key BY

Loops over the successive tails of a list, checking for the end of the list as if by ATOM. Can perform destructuring.

Package

doplus

Source

doplus.lisp (file)

Macro: maximizing FORM &key TEST SAVING IN

Synonym for optimizing.

Package

doplus

Source

doplus.lisp (file)

Macro: minimizing FORM &key TEST SAVING IN

Same as optimizing but with < as the default test.

Package

doplus

Source

doplus.lisp (file)

Macro: optimizing FORM &key TEST SAVING IN

Finds the optimum value of an expression across the iteration. Refer to the manual for details.

Package

doplus

Source

doplus.lisp (file)

Macro: options &rest ARGS &key NAME ATOMIC-UPDATES

Package

doplus

Source

doplus.lisp (file)

Macro: previous EXPR

On every iteration, the for-variable is set to the value <expr> had at the end of the previous iteration (initially NIL).

Package

doplus

Source

doplus.lisp (file)

Macro: returning &rest FORMS

Returns each form in <forms> as the value of the do+ form when the loop ends. If multiple forms are specified, by one or more RETURNING clauses, multiple values are returned, in the order the corresponding forms appear lexically. If one of the <forms> is (cl:values ...), then each value will be returned as if the values were spelled as direct arguments of the RETURNING form.

Package

doplus

Source

doplus.lisp (file)

Macro: skip &optional LOOP-NAME

Skips the current iteration. Refers to the current loop or, if loop-name is specified, to the closest surrounding loop with that name.

Package

doplus

Source

doplus.lisp (file)

Macro: stop-when CONDITION

Synonym for until.

Package

doplus

Source

doplus.lisp (file)

Macro: sum VALUE &key TO

Syntactic sugar for collect, intended to be used when the accumulator computes a sum.

Package

doplus

Source

doplus.lisp (file)

Macro: summing-to VARS &optional RESULT-PROCESSOR

Specifies an accumulation strategy with 0 as the default value and + as the accumulator function.

Package

doplus

Source

doplus.lisp (file)

Macro: summing-to-and-returning VARS &optional RESULT-PROCESSOR

Same as summing-to, but also returns the value of each <vars> at the end of the loop.

Package

doplus

Source

doplus.lisp (file)

Macro: symbols-in PACKAGE-OR-PACKAGES &rest SYMBOL-TYPES

Iterates over the symbols in one or more packages. Symbol-types follows the specification of cl:with-package-iterator.

Package

doplus

Source

doplus.lisp (file)

Macro: terminate &optional LOOP-NAME RETURN-VALUE

Immediately terminates the loop. Refers to the current loop or, if loop-name is specified and non-NIL, to the closest surrounding loop with that name. Can optionally specify a return value for the loop, which, if provided, will override the loop’s ordinary return value.

Package

doplus

Source

doplus.lisp (file)

Macro: to FINAL-VALUE &key FROM BY WHILE USING

Variation over from.

Package

doplus

Source

doplus.lisp (file)

Macro: try-update VAR &key ON-ERROR

Tries to update the generator named <var> as by UPDATE. If the loop would be terminated as a result of the update operation, it is not terminated.

Any errors occurring during the update are ignored by default; however, it is possible to provide a function to be invoked in case of error to determine what to do. This is the value of the <on-error> parameter, which, if provided, must be a function of two arguments: the first is the value to be returned as the result of the try-update form if the error is suppressed; the second is the condition object itself, which can be resignaled. Calling TERMINATE inside the function, if it is defined lexically inside the DO+ body, will regularly terminate the loop.

Package

doplus

Source

doplus.lisp (file)

Macro: update VAR

Updates the generator named <var>, calculating new value(s) for its variable(s) and evaluating its pre and post conditions, terminating the loop if they fail. If successful, the update returns the value of <var>.

Package

doplus

Source

doplus.lisp (file)

Macro: with &rest BINDINGS

Establishes bindings which are in effect for the whole loop.

Package

doplus

Source

doplus.lisp (file)

5.1.3 Functions

Function: make-binding VAR &key DEFAULT

Package

doplus

Source

doplus.lisp (file)

Function: make-epilogue &key (FORM FORM)

Package

doplus

Source

doplus.lisp (file)

Function: make-finalization &key (FORM FORM)

Package

doplus

Source

doplus.lisp (file)

Function: make-initialization &key (FORM FORM)

Package

doplus

Source

doplus.lisp (file)

Function: make-iteration &key BINDINGS INITIALIZATIONS STEPS PRECONDITIONS POSTCONDITIONS

General iteration clause generator.

Package

doplus

Source

doplus.lisp (file)

Function: make-prologue &key (FORM FORM)

Package

doplus

Source

doplus.lisp (file)

Function: make-result &key (FORM FORM)

Package

doplus

Source

doplus.lisp (file)

Function: make-simple-iteration &key VAR INIT STEP PRECONDITION POSTCONDITION

Specialized iteration clause generator, where the iteration clause refers to a single variable, possibly with an initial value, step form, precondition, or postcondition.

Package

doplus

Source

doplus.lisp (file)

Function: make-step &key (FORM FORM)

Package

doplus

Source

doplus.lisp (file)

Function: make-termination &key (CONDITION CONDITION)

Package

doplus

Source

doplus.lisp (file)

5.1.4 Structures

Structure: options ()

Package

doplus

Source

doplus.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: map

Readers

options-map (function)

Writers

(setf options-map) (function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *clauses*

A list of known symbols that name clause macros, useful for introspection and documentation purposes.

Package

doplus

Source

doplus.lisp (file)

5.2.2 Macros

Macro: declaring THING

Causes the emission of a (declare <thing>) form in the declaration section of the loop.

Package

doplus

Source

doplus.lisp (file)

Macro: do+/internal DOPLUS-ENV &body BODY

Package

doplus

Source

doplus.lisp (file)

Macro: until CONDITION

Specifies a termination clause for the loop. When, at the beginning of an iteration, the clause evaluates to true, the loop stops.

Package

doplus

Source

doplus.lisp (file)

Macro: while CONDITION

Same as (until (not <condition>)).

Package

doplus

Source

doplus.lisp (file)

Macro: with-atomic-updates (&rest VARIABLES) &body BODY

Package

doplus

Source

doplus.lisp (file)

Macro: with-atomic-updates* (&rest VARIABLES) BINDING-FORM &body BODY

Package

doplus

Source

doplus.lisp (file)

Macro: with-doplus-body ENV &body BODY

Package

doplus

Source

doplus.lisp (file)

Macro: without-atomic-updates (&rest VARIABLES) &body BODY

Package

doplus

Source

doplus.lisp (file)

5.2.3 Functions

Function: %make-binding &key (VAR VAR) (DEFAULT DEFAULT) (DEFAULT-PROVIDED? DEFAULT-PROVIDED?)

Package

doplus

Source

doplus.lisp (file)

Function: accumulator-function INSTANCE

Function: (setf accumulator-function) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: accumulator-p OBJECT

Package

doplus

Source

doplus.lisp (file)

Function: accumulator-var INSTANCE

Function: (setf accumulator-var) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: binding-default INSTANCE

Function: (setf binding-default) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: binding-default-provided? INSTANCE

Function: (setf binding-default-provided?) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: binding-p OBJECT

Package

doplus

Source

doplus.lisp (file)

Function: binding-var INSTANCE

Function: (setf binding-var) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: copy-accumulator INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: copy-binding INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: copy-declaration INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: copy-doplus-env INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: copy-epilogue INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: copy-finalization INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: copy-generator INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: copy-initialization INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: copy-options INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: copy-prologue INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: copy-result INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: copy-step INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: copy-termination INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: copy-wrapper INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: declaration-form INSTANCE

Function: (setf declaration-form) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: declaration-p OBJECT

Package

doplus

Source

doplus.lisp (file)

Function: doplus-env-accumulators INSTANCE

Function: (setf doplus-env-accumulators) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: doplus-env-default-collect-var INSTANCE

Function: (setf doplus-env-default-collect-var) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: doplus-env-generators INSTANCE

Function: (setf doplus-env-generators) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: doplus-env-loop-name INSTANCE

Function: (setf doplus-env-loop-name) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: doplus-env-p OBJECT

Package

doplus

Source

doplus.lisp (file)

Function: doplus-env-parent INSTANCE

Function: (setf doplus-env-parent) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: doplus-env-skip-label INSTANCE

Function: (setf doplus-env-skip-label) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: doplus-env-terminate-label INSTANCE

Function: (setf doplus-env-terminate-label) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: ensure-list OBJ

(if (listp obj) obj (list obj))

Package

doplus

Source

doplus.lisp (file)

Function: epilogue-form INSTANCE

Function: (setf epilogue-form) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: epilogue-p OBJECT

Package

doplus

Source

doplus.lisp (file)

Function: expand-with-simple-destructuring FORM ENV

Expand ‘form’ in ‘env’ as an iteration form that assigns to ‘*iteration-variable*’ destructuring as by ‘destructuring-bind’.

Package

doplus

Source

doplus.lisp (file)

Function: extract-variables LAMBDA-LIST

Package

doplus

Source

destructuring.lisp (file)

Function: finalization-form INSTANCE

Function: (setf finalization-form) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: finalization-p OBJECT

Package

doplus

Source

doplus.lisp (file)

Function: find-generator NAME ENV

Package

doplus

Source

doplus.lisp (file)

Function: find-loop-in-env NAME ENV

Package

doplus

Source

doplus.lisp (file)

Function: generator-clauses INSTANCE

Function: (setf generator-clauses) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: generator-name INSTANCE

Function: (setf generator-name) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: generator-p OBJECT

Package

doplus

Source

doplus.lisp (file)

Function: initialization-form INSTANCE

Function: (setf initialization-form) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: initialization-p OBJECT

Package

doplus

Source

doplus.lisp (file)

Function: make-accumulator &key (VAR VAR) (FUNCTION FUNCTION)

Package

doplus

Source

doplus.lisp (file)

Function: make-declaration &key (FORM FORM)

Package

doplus

Source

doplus.lisp (file)

Function: make-destructuring-form LAMBDA-LIST EXPRESSION

Package

doplus

Source

destructuring.lisp (file)

Function: make-doplus-env &key (LOOP-NAME LOOP-NAME) (SKIP-LABEL SKIP-LABEL) (TERMINATE-LABEL TERMINATE-LABEL) (DEFAULT-COLLECT-VAR DEFAULT-COLLECT-VAR) (ACCUMULATORS ACCUMULATORS) (GENERATORS GENERATORS) (PARENT PARENT)

Package

doplus

Source

doplus.lisp (file)

Function: make-generator &key (NAME NAME) (CLAUSES CLAUSES)

Package

doplus

Source

doplus.lisp (file)

Function: make-options &key (MAP MAP)

Package

doplus

Source

doplus.lisp (file)

Function: make-wrapper &key (FUNCTION FUNCTION)

Package

doplus

Source

doplus.lisp (file)

Function: options-map INSTANCE

Function: (setf options-map) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: options-p OBJECT

Package

doplus

Source

doplus.lisp (file)

Function: prologue-form INSTANCE

Function: (setf prologue-form) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: prologue-p OBJECT

Package

doplus

Source

doplus.lisp (file)

Function: result-form INSTANCE

Function: (setf result-form) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: result-p OBJECT

Package

doplus

Source

doplus.lisp (file)

Function: step-form INSTANCE

Function: (setf step-form) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: step-p OBJECT

Package

doplus

Source

doplus.lisp (file)

Function: termination-condition INSTANCE

Function: (setf termination-condition) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: termination-p OBJECT

Package

doplus

Source

doplus.lisp (file)

Function: wrapper-function INSTANCE

Function: (setf wrapper-function) VALUE INSTANCE

Package

doplus

Source

doplus.lisp (file)

Function: wrapper-p OBJECT

Package

doplus

Source

doplus.lisp (file)

5.2.4 Structures

Structure: accumulator ()

Package

doplus

Source

doplus.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: var

Readers

accumulator-var (function)

Writers

(setf accumulator-var) (function)

Slot: function

Readers

accumulator-function (function)

Writers

(setf accumulator-function) (function)

Structure: binding ()

Package

doplus

Source

doplus.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: var

Readers

binding-var (function)

Writers

(setf binding-var) (function)

Slot: default

Readers

binding-default (function)

Writers

(setf binding-default) (function)

Slot: default-provided?

Readers

binding-default-provided? (function)

Writers

(setf binding-default-provided?) (function)

Structure: declaration ()

Package

doplus

Source

doplus.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: form

Readers

declaration-form (function)

Writers

(setf declaration-form) (function)

Structure: doplus-env ()

Package

doplus

Source

doplus.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: loop-name

Readers

doplus-env-loop-name (function)

Writers

(setf doplus-env-loop-name) (function)

Slot: skip-label

Readers

doplus-env-skip-label (function)

Writers

(setf doplus-env-skip-label) (function)

Slot: terminate-label

Readers

doplus-env-terminate-label (function)

Writers

(setf doplus-env-terminate-label) (function)

Slot: default-collect-var

Readers

doplus-env-default-collect-var (function)

Writers

(setf doplus-env-default-collect-var) (function)

Slot: accumulators

Readers

doplus-env-accumulators (function)

Writers

(setf doplus-env-accumulators) (function)

Slot: generators

Readers

doplus-env-generators (function)

Writers

(setf doplus-env-generators) (function)

Slot: parent

Readers

doplus-env-parent (function)

Writers

(setf doplus-env-parent) (function)

Structure: epilogue ()

Package

doplus

Source

doplus.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: form

Readers

epilogue-form (function)

Writers

(setf epilogue-form) (function)

Structure: finalization ()

Package

doplus

Source

doplus.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: form

Readers

finalization-form (function)

Writers

(setf finalization-form) (function)

Structure: generator ()

Package

doplus

Source

doplus.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: name

Readers

generator-name (function)

Writers

(setf generator-name) (function)

Slot: clauses

Readers

generator-clauses (function)

Writers

(setf generator-clauses) (function)

Structure: initialization ()

Package

doplus

Source

doplus.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: form

Readers

initialization-form (function)

Writers

(setf initialization-form) (function)

Structure: prologue ()

Package

doplus

Source

doplus.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: form

Readers

prologue-form (function)

Writers

(setf prologue-form) (function)

Structure: result ()

Package

doplus

Source

doplus.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: form

Readers

result-form (function)

Writers

(setf result-form) (function)

Structure: step ()

Package

doplus

Source

doplus.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: form

Readers

step-form (function)

Writers

(setf step-form) (function)

Structure: termination ()

Package

doplus

Source

doplus.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: condition

Readers

termination-condition (function)

Writers

(setf termination-condition) (function)

Structure: wrapper ()

Package

doplus

Source

doplus.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: function

Readers

wrapper-function (function)

Writers

(setf wrapper-function) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions