This is the iterate Reference Manual, version 1.5.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 13:41:30 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
iterateJonathan Amsterdam’s iterator/gatherer/accumulator facility
MIT
1.5.2
package.lisp (file).
iterate.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
iterate/package.lispiterate/iterate.lisppackage.lisp (file).
iterate (system).
after-each (function).
defclause-sequence (macro).
defmacro-clause (macro).
defmacro-driver (macro).
defsynonym (macro).
display-iterate-clauses (function).
dsetq (macro).
else (function).
finally (function).
finally-protected (function).
finish (macro).
first-iteration-p (function).
first-time-p (function).
if-first-time (function).
in (function).
initially (function).
iter (macro).
iterate (macro).
leave (macro).
next (function).
next-iteration (macro).
terminate (macro).
*accum-var-alist* (special variable).
*always-declare-variables* (special variable).
*binding-context?* (special variable).
*bindings* (special variable).
*block-name* (special variable).
*clause* (special variable).
*clause-info-index* (special variable).
*declarations* (special variable).
*declare-variables* (special variable).
*decls* (special variable).
*driver-info-alist* (special variable).
*env* (special variable).
*final* (special variable).
*finalp* (special variable).
*genvar-counter* (special variable).
*initial* (special variable).
*internal-variables* (special variable).
*loop-body-wrappers* (special variable).
*loop-end* (special variable).
*loop-end-used?* (special variable).
*loop-name* (special variable).
*loop-step* (special variable).
*loop-step-used?* (special variable).
*loop-top* (special variable).
*previous-vars-alist* (special variable).
*result-var* (special variable).
*shared-bindings-alist* (special variable).
*special-clause-alist* (special variable).
*special-form-alist* (special variable).
*step* (special variable).
*temps* (special variable).
*temps-in-use* (special variable).
*top-level?* (special variable).
*type-alist* (special variable).
add-binding (function).
add-driver-info (function).
add-internal-var (function).
add-internal-vars (function).
add-loop-body-wrapper (function).
add-progn (function).
ambiguity-check-clause (function).
ambiguity-check-index (function).
ambiguous-clauses? (function).
apply-clause-function (function).
apply-subst-expr (function).
arg-check (function).
at-top-level? (function).
augment (macro).
bug (function).
build-index (function).
check-internal-variables (function).
check-sequence-keywords (function).
clause-accumulate-by-42 (function).
clause-adjoining-37 (function).
clause-always-30 (function).
clause-appending-39 (function).
clause-collect-36 (function).
clause-counting-22 (function).
clause-error (function).
clause-finding-maximizing-34 (function).
clause-finding-minimizing-35 (function).
clause-finding-such-that-33 (function).
clause-for-2 (function).
clause-for-=-20 (function).
clause-for-do-next-17 (function).
clause-for-first-then-21 (function).
clause-for-in-4 (function).
clause-for-in-file-14 (function).
clause-for-in-hashtable-11 (function).
clause-for-in-package-13 (macro).
clause-for-in-packages-12 (function).
clause-for-in-sequence-7 (function).
clause-for-in-stream-15 (function).
clause-for-in-string-9 (function).
clause-for-in-vector-5 (function).
clause-for-index-of-sequence-8 (function).
clause-for-index-of-string-10 (function).
clause-for-index-of-vector-6 (function).
clause-for-initially-then-19 (function).
clause-for-next-16 (function).
clause-for-on-3 (function).
clause-for-previous-43 (function).
clause-info (structure).
clause-info-doc-string (reader).
(setf clause-info-doc-string) (writer).
clause-info-function (reader).
(setf clause-info-function) (writer).
clause-info-generator? (reader).
(setf clause-info-generator?) (writer).
clause-info-keywords (reader).
(setf clause-info-keywords) (writer).
clause-info-p (function).
clause-info-req-keywords (reader).
(setf clause-info-req-keywords) (writer).
clause-matches? (function).
clause-maximize-26 (function).
clause-minimize-27 (function).
clause-multiply-24 (function).
clause-nconcing-38 (function).
clause-never-31 (function).
clause-nunioning-41 (function).
clause-reducing-by-25 (function).
clause-repeat-1 (function).
clause-sum-23 (function).
clause-thereis-32 (function).
clause-unioning-40 (function).
clause-until-29 (function).
clause-warning (function).
clause-while-28 (function).
clause-with-18 (function).
constant? (function).
contains-duplicates? (function).
copy-clause-info (function).
copy-driver-info (function).
copy-previous-info (function).
copy-save-info (function).
def-special-clause (macro).
default-driver-code (function).
defclause (macro).
defclause-driver (macro).
define-clause (function).
disp-std-clauses (function).
display-clause (function).
display-index (function).
display-kws (function).
do-destructuring-bindings (function).
do-dsetq (function).
do-extra-save-var-hack (function).
driver-info (structure).
driver-info-generator? (reader).
(setf driver-info-generator?) (writer).
driver-info-next-code (reader).
(setf driver-info-next-code) (writer).
driver-info-p (function).
driver-info-used (reader).
(setf driver-info-used) (writer).
dsetq-error (function).
duplicable? (function).
eval-const-expr (function).
expr-type-only (function).
expression-type (function).
extract-var (function).
extract-vars (function).
fill-col (constant).
free-variables (function).
free-vars (function).
free-vars-fspec (function).
free-vars-list (function).
function-quoted? (function).
generate-function-step-code (function).
genvar (function).
get-clause-info (function).
get-free-temp (function).
if-1st-time (function).
in-iterate? (function).
index-add (function).
index-lookup (function).
index? (function).
insert-previous-code (function).
install-clause-info (function).
install-clause-info-1 (function).
install-special-clause-function (function).
intern-previous-info (function).
internal-variable? (function).
is-iterate-clause? (function).
is-save-var (function).
keywordize (function).
lambda-expression? (function).
lambda-list-vars (function).
list-of-forms? (function).
listify (function).
local-binding-check (function).
make-accum-var-binding (function).
make-accum-var-binding-internal (function).
make-accum-var-default-binding (function).
make-application (function).
make-binding (function).
make-binding-internal (function).
make-clause-info (function).
make-default-binding (function).
make-destructuring-bindings (function).
make-driver-info (function).
make-dsetqs (function).
make-funcall (function).
make-function-name (function).
make-initial-value (function).
make-mv-dsetqs (function).
make-next-code (function).
make-post-save-var (function).
make-prev-code (function).
make-previous-info (function).
make-save-info (function).
make-save-previous-code (function).
make-save-vars (function).
make-shared-binding (function).
make-var-and-binding (function).
make-var-and-default-binding (function).
prepend (macro).
preprocess-clause (function).
previous-info (structure).
previous-info-class (reader).
(setf previous-info-class) (writer).
previous-info-code (reader).
(setf previous-info-code) (writer).
previous-info-p (function).
previous-info-save-info-list (reader).
(setf previous-info-save-info-list) (writer).
previous-info-var (reader).
(setf previous-info-var) (writer).
process-clause (function).
process-top-level-decls (function).
prognify (function).
quoted? (function).
register-previous-code (function).
remove-clause (function).
return-code (function).
return-code-modifying-body (function).
return-collection-code (function).
return-driver-code (macro).
return-extremum-code (function).
return-find-extremum-code (function).
return-reduction-code (function).
return-seq-code (function).
return-sequence-code (macro).
return-stream-driver-code (function).
save-info (structure).
save-info-iv-ref (reader).
(setf save-info-iv-ref) (writer).
save-info-p (function).
save-info-save-var (reader).
(setf save-info-save-var) (writer).
save-info-save-vars (reader).
(setf save-info-save-vars) (writer).
self-evaluating? (function).
sequence-keyword-list (constant).
special-form? (function).
splice-in-code (function).
split-clause-template (function).
split-list-odd-even (function).
standard-type-symbols (constant).
starts-clause? (function).
symbol-append (function).
symbol-synonym (function).
the-expression? (function).
top-level-check (function).
var-binding (function).
var-declaration (function).
var-spec? (function).
var-type (function).
var-value-returned (function).
version (constant).
walk (function).
walk-arglist (function).
walk-cddr (function).
walk-cddr-with-declarations (function).
walk-cdr (function).
walk-cdr-with-declarations (function).
walk-declare (function).
walk-expr (function).
walk-flet (function).
walk-fspec (function).
walk-function (function).
walk-let (function).
walk-let*-bindings (function).
walk-let-binding (function).
walk-let-bindings (function).
walk-list (function).
walk-list-nconcing (function).
walk-macrolet (function).
walk-multiple-value-bind (function).
walk-progn (function).
walk-setq (function).
walk-special-form (function).
walk-tagbody (function).
with-temporary (macro).
wrap-form (function).
Packages are listed by definition order.
iterateiter
common-lisp.
after-each (function).
defclause-sequence (macro).
defmacro-clause (macro).
defmacro-driver (macro).
defsynonym (macro).
display-iterate-clauses (function).
dsetq (macro).
else (function).
finally (function).
finally-protected (function).
finish (macro).
first-iteration-p (function).
first-time-p (function).
if-first-time (function).
in (function).
initially (function).
iter (macro).
iterate (macro).
leave (macro).
next (function).
next-iteration (macro).
terminate (macro).
*accum-var-alist* (special variable).
*always-declare-variables* (special variable).
*binding-context?* (special variable).
*bindings* (special variable).
*block-name* (special variable).
*clause* (special variable).
*clause-info-index* (special variable).
*declarations* (special variable).
*declare-variables* (special variable).
*decls* (special variable).
*driver-info-alist* (special variable).
*env* (special variable).
*final* (special variable).
*finalp* (special variable).
*genvar-counter* (special variable).
*initial* (special variable).
*internal-variables* (special variable).
*loop-body-wrappers* (special variable).
*loop-end* (special variable).
*loop-end-used?* (special variable).
*loop-name* (special variable).
*loop-step* (special variable).
*loop-step-used?* (special variable).
*loop-top* (special variable).
*previous-vars-alist* (special variable).
*result-var* (special variable).
*shared-bindings-alist* (special variable).
*special-clause-alist* (special variable).
*special-form-alist* (special variable).
*step* (special variable).
*temps* (special variable).
*temps-in-use* (special variable).
*top-level?* (special variable).
*type-alist* (special variable).
add-binding (function).
add-driver-info (function).
add-internal-var (function).
add-internal-vars (function).
add-loop-body-wrapper (function).
add-progn (function).
ambiguity-check-clause (function).
ambiguity-check-index (function).
ambiguous-clauses? (function).
apply-clause-function (function).
apply-subst-expr (function).
arg-check (function).
at-top-level? (function).
augment (macro).
bug (function).
build-index (function).
check-internal-variables (function).
check-sequence-keywords (function).
clause-accumulate-by-42 (function).
clause-adjoining-37 (function).
clause-always-30 (function).
clause-appending-39 (function).
clause-collect-36 (function).
clause-counting-22 (function).
clause-error (function).
clause-finding-maximizing-34 (function).
clause-finding-minimizing-35 (function).
clause-finding-such-that-33 (function).
clause-for-2 (function).
clause-for-=-20 (function).
clause-for-do-next-17 (function).
clause-for-first-then-21 (function).
clause-for-in-4 (function).
clause-for-in-file-14 (function).
clause-for-in-hashtable-11 (function).
clause-for-in-package-13 (macro).
clause-for-in-packages-12 (function).
clause-for-in-sequence-7 (function).
clause-for-in-stream-15 (function).
clause-for-in-string-9 (function).
clause-for-in-vector-5 (function).
clause-for-index-of-sequence-8 (function).
clause-for-index-of-string-10 (function).
clause-for-index-of-vector-6 (function).
clause-for-initially-then-19 (function).
clause-for-next-16 (function).
clause-for-on-3 (function).
clause-for-previous-43 (function).
clause-info (structure).
clause-info-doc-string (reader).
(setf clause-info-doc-string) (writer).
clause-info-function (reader).
(setf clause-info-function) (writer).
clause-info-generator? (reader).
(setf clause-info-generator?) (writer).
clause-info-keywords (reader).
(setf clause-info-keywords) (writer).
clause-info-p (function).
clause-info-req-keywords (reader).
(setf clause-info-req-keywords) (writer).
clause-matches? (function).
clause-maximize-26 (function).
clause-minimize-27 (function).
clause-multiply-24 (function).
clause-nconcing-38 (function).
clause-never-31 (function).
clause-nunioning-41 (function).
clause-reducing-by-25 (function).
clause-repeat-1 (function).
clause-sum-23 (function).
clause-thereis-32 (function).
clause-unioning-40 (function).
clause-until-29 (function).
clause-warning (function).
clause-while-28 (function).
clause-with-18 (function).
constant? (function).
contains-duplicates? (function).
copy-clause-info (function).
copy-driver-info (function).
copy-previous-info (function).
copy-save-info (function).
def-special-clause (macro).
default-driver-code (function).
defclause (macro).
defclause-driver (macro).
defconst (macro).
define-clause (function).
disp-std-clauses (function).
display-clause (function).
display-index (function).
display-kws (function).
do-destructuring-bindings (function).
do-dsetq (function).
do-extra-save-var-hack (function).
driver-info (structure).
driver-info-generator? (reader).
(setf driver-info-generator?) (writer).
driver-info-next-code (reader).
(setf driver-info-next-code) (writer).
driver-info-p (function).
driver-info-used (reader).
(setf driver-info-used) (writer).
dsetq-error (function).
duplicable? (function).
eval-const-expr (function).
expr-type-only (function).
expression-type (function).
extract-var (function).
extract-vars (function).
fill-col (constant).
free-variables (function).
free-vars (function).
free-vars-fspec (function).
free-vars-list (function).
function-quoted? (function).
generate-function-step-code (function).
genvar (function).
get-clause-info (function).
get-free-temp (function).
if-1st-time (function).
in-iterate? (function).
index-add (function).
index-lookup (function).
index? (function).
insert-previous-code (function).
install-clause-info (function).
install-clause-info-1 (function).
install-special-clause-function (function).
intern-previous-info (function).
internal-variable? (function).
is-iterate-clause? (function).
is-save-var (function).
keywordize (function).
lambda-expression? (function).
lambda-list-vars (function).
list-of-forms? (function).
listify (function).
local-binding-check (function).
make-accum-var-binding (function).
make-accum-var-binding-internal (function).
make-accum-var-default-binding (function).
make-application (function).
make-binding (function).
make-binding-internal (function).
make-clause-info (function).
make-default-binding (function).
make-destructuring-bindings (function).
make-driver-info (function).
make-dsetqs (function).
make-funcall (function).
make-function-name (function).
make-initial-value (function).
make-mv-dsetqs (function).
make-next-code (function).
make-post-save-var (function).
make-prev-code (function).
make-previous-info (function).
make-save-info (function).
make-save-previous-code (function).
make-save-vars (function).
make-shared-binding (function).
make-var-and-binding (function).
make-var-and-default-binding (function).
prepend (macro).
preprocess-clause (function).
previous-info (structure).
previous-info-class (reader).
(setf previous-info-class) (writer).
previous-info-code (reader).
(setf previous-info-code) (writer).
previous-info-p (function).
previous-info-save-info-list (reader).
(setf previous-info-save-info-list) (writer).
previous-info-var (reader).
(setf previous-info-var) (writer).
process-clause (function).
process-top-level-decls (function).
prognify (function).
quoted? (function).
register-previous-code (function).
remove-clause (function).
return-code (function).
return-code-modifying-body (function).
return-collection-code (function).
return-driver-code (macro).
return-extremum-code (function).
return-find-extremum-code (function).
return-reduction-code (function).
return-seq-code (function).
return-sequence-code (macro).
return-stream-driver-code (function).
save-info (structure).
save-info-iv-ref (reader).
(setf save-info-iv-ref) (writer).
save-info-p (function).
save-info-save-var (reader).
(setf save-info-save-var) (writer).
save-info-save-vars (reader).
(setf save-info-save-vars) (writer).
self-evaluating? (function).
sequence-keyword-list (constant).
special-form? (function).
splice-in-code (function).
split-clause-template (function).
split-list-odd-even (function).
standard-type-symbols (constant).
starts-clause? (function).
symbol-append (function).
symbol-synonym (function).
the-expression? (function).
top-level-check (function).
var-binding (function).
var-declaration (function).
var-spec? (function).
var-type (function).
var-value-returned (function).
version (constant).
walk (function).
walk-arglist (function).
walk-cddr (function).
walk-cddr-with-declarations (function).
walk-cdr (function).
walk-cdr-with-declarations (function).
walk-declare (function).
walk-expr (function).
walk-flet (function).
walk-fspec (function).
walk-function (function).
walk-let (function).
walk-let*-bindings (function).
walk-let-binding (function).
walk-let-bindings (function).
walk-list (function).
walk-list-nconcing (function).
walk-macrolet (function).
walk-multiple-value-bind (function).
walk-progn (function).
walk-setq (function).
walk-special-form (function).
walk-tagbody (function).
with-temporary (macro).
wrap-form (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
A simple way to define a simple FOR ... &sequence clause
Create your own iterate clauses
Create iterators which may also be used as generators
Makes SYN a synonym for the existing iterate keyword WORD.
Destructuring assignment; supports both
(VALUES ...) for destructuring a multiple-value form and
NIL as a variable name, meaning to ignore that position,
e.g. (DSETQ (VALUES (a . b) nil c) form)
Leave the loop gracefully, executing the epilogue
Jonathan Amsterdam’s powerful and extensible iteration facility, providing multiple accumulation, generators, memory of previous iterations, over 50 clauses to start with and a Lisp-like syntax. Evaluate (iterate:display-iterate-clauses) for an overview of clauses
Jonathan Amsterdam’s powerful iteration facility
Exit the loop without running the epilogue code
Begin the next iteration
Use within FOR ... DO-/NEXT clause to end the iteration
Lisp forms to execute after each iteration
Lisp forms to execute if the loop is never entered
Lisp forms to execute after loop ends
Lisp forms in an UNWIND-PROTECT after loop ends
True within first iteration through the body
True when evaluated for the first time
Evaluate branch depending on whether this clause is met for the first time
Process forms in a named Iterate block
Lisp forms to execute before loop starts
Explicitly step a driver variable
Table 4-1 of the Common Lisp Manual
Current version of Iterate
Symbols accessible in a package
Generalized accumulation
Adjoin into a list (tests for membership first)
Return last value iff expression is always non-nil
Append into a list
Collect into a list
Increment a variable if expression is non-nil
Return value which maximizes expression
Return value which minimizes expression
Return expression when test is non-nil
Numbers
Set a variable on each iteration
General driver; VAR must be set in DO-NEXT
Set var on first, and then on subsequent iterations
Elements of a list
Forms in a file
Elements and keys of a hashtable
Symbols and their access-types in packages
Elements of a sequence (vector or list)
Forms in a stream (which will be closed at the end)
Characters in a string
Elements of a vector
Indices of a sequence (vector or list)
Indices of a string
Indices of a vector
Set var initially, then on subsequent iterations
General driver; VAR is set to value of NEXT
Sublists of a list
Previous value of a variable
Maximize value of an expression
Minimize value of an expression
Multiply into a variable
Nconc into a list
Return T iff expression is never non-nil
Union into a list, destructively
Generalized reduction
Repeat the loop some number of times
Sum into a variable
Return value of expression as soon as it is non-nil
Union into a list
Exit loop if test is non-nil
Exit loop if test is nil
Bind a variable
used.
Look up or create an alist entry keyed by var, store a gensym in the value and also add it as a binding. Return the entry.
code.
var.
| Jump to: | (
A B C D E F G I K L M N P Q R S T V W |
|---|
| Jump to: | (
A B C D E F G I K L M N P Q R S T V W |
|---|
| Jump to: | *
C D F G I K N R S U V |
|---|
| Jump to: | *
C D F G I K N R S U V |
|---|
| Jump to: | C D F I P S |
|---|
| Jump to: | C D F I P S |
|---|