1 % Copyright (C) 2008, 2009, 2010 Bert Burgemeister
3 % Permission is granted to copy, distribute and/or modify this
4 % document under the terms of the GNU Free Documentation License,
5 % Version 1.2 or any later version published by the Free Software
6 % Foundation; with no Invariant Sections, no Front-Cover Texts and
7 % no Back-Cover Texts. For details see file COPYING.
10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
11 \section{Control Structure
}
12 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
14 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
15 \subsection{Predicates
}
16 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
19 \IT{(
\FU*
{EQ
} \VAR{foo bar
})
}
21 \retval{\T} if
\VAR{foo
} and
\VAR{bar
} are identical.
24 \IT{(
\FU*
{EQL
} \VAR{foo bar
})
}
26 \retval{\T} if
\VAR{foo
} and
\VAR{bar
}
27 are identical, or the same
\kwd{character
}, or
\kwd{number
}s of the
31 \IT{(
\FU*
{EQUAL
} \VAR{foo bar
})
}
33 \retval{\T} if
\VAR{foo
} and
\VAR{bar
}
34 are
\FU{EQL
}, or are equivalent
\kwd{pathname
}s, or are
\kwd{cons
}es with
35 \FU{equal
} cars and cdrs, or are
\kwd{string
}s or
\kwd{bit-vector
}s with
36 \FU{eql
} elements below their fill pointers.
39 \IT{(
\FU*
{EQUALP
} \VAR{foo bar
})
}
41 \retval{\T} if
\VAR{foo
} and
\VAR{bar
} are identical; or are the
42 same
\kwd{character
} ignoring case; or are
\kwd{number
}s of the same
43 value ignoring type; or are equivalent
\kwd{pathname
}s; or are
44 \kwd{cons
}es or
\kwd{array
}s of the same shape with
\FU{equalp
}
45 elements; or are structures of the same type with
46 \FU{equalp
} elements; or are
\kwd{hash-table
}s of the same size
47 with the same
\kwd{:test
} function, the same keys in terms of
48 \kwd{:test
} function, and
\FU{equalp
} elements.
51 \IT{(
\FU*
{NOT
} \VAR{foo
})
}
53 \retval{\T} if
\VAR{foo
} is
\NIL,
\retval{\NIL} otherwise.
56 \IT{(
\FU*
{BOUNDP
} \VAR{symbol
})
}
58 \retval{\T} if
\VAR{symbol
} is a special variable.
61 \IT{(
\FU*
{CONSTANTP
} \VAR{foo
} \Op{\VAR{environment
}\DF{\NIL}})
}
63 \retval{\T} if
\VAR{foo
} is a constant form.
66 \IT{(
\FU*
{FUNCTIONP
} \VAR{foo
})
}
68 \retval{\T} if
\VAR{foo
} is of type
\kwd{function
}.
71 \IT{(
\FU*
{FBOUNDP
} \xorGOO{\VAR{foo
}\\
72 (
\kwd{setf
} \VAR{foo
})
}{\
}})
}
74 \retval{\T} if
\VAR{foo
} is a global function or macro.
81 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
82 \subsection{Variables
}
83 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
89 \MC*
{DEFPARAMETER
}}{\
}} \NEV{\VAR{foo
}} \VAR{form
}
90 \Op{\NEV{\VAR{doc
}}})
}
92 Assign value of
\VAR{form
} to global constant/dynamic variable
\retval{\VAR{foo
}}.
95 \IT{(
\MC*
{DEFVAR
} \NEV{\VAR{foo
}} \OP{\VAR{form
}
96 \Op{\NEV{\VAR{doc
}}}})
}
98 Unless bound already, assign value of
\VAR{form
} to dynamic variable
102 \IT{(
\xorGOO{\MC*
{SETF
}\\
103 \MC*
{PSETF
}}{\
}} \Goos{\VAR{place
}
106 Set
\VAR{place
}s to primary values of
\VAR{form
}s. Return
\retval{values
107 of last
\VAR{form
}}/
\retval{\NIL}; work sequentially/in parallel, respectively.
110 \IT{(
\xorGOO{\SO*
{SETQ
}\\
111 \MC*
{PSETQ
}}{\
}} \Goos{\VAR{symbol
}
114 Set
\VAR{symbol
}s to primary values of
\VAR{form
}s. Return
\retval{value
115 of last
\VAR{form
}}/
\retval{\NIL}; work sequentially/in parallel, respectively.
118 \IT{(
\FU*
{SET
} \DES{\VAR{symbol
}} \VAR{foo
})
}
120 Set
\VAR{symbol
}'s value cell to
\retval{\VAR{foo
}}. Deprecated.
123 \IT{(
\MC*
{MULTIPLE-VALUE-SETQ
} \VAR{vars
} \VAR{form
})
}
125 Set elements of
\VAR{vars
} to the values of
126 \VAR{form
}. Return
\retval{\VAR{form
}'s primary value
}.
129 \IT{(
\MC*
{SHIFTF
} \RP{\DES{\VAR{place
}}} \VAR{foo
})
}
131 Store value of
\VAR{foo
} in rightmost
\VAR{place
} shifting values of
132 \VAR{place
}s left, returning
\retval{first
\VAR{place
}}.
135 \IT{(
\MC*
{ROTATEF
} \OPn{\DES{\VAR{place
}}})
}
137 Rotate values of
\VAR{place
}s left, old first becoming new last
138 \VAR{place
}'s value. Return
\retval{\NIL}.
141 \IT{(
\FU*
{MAKUNBOUND
} \DES{\VAR{foo
}})
}
143 Delete special variable
\retval{\VAR{foo
}} if any.
146 \label{:property_lists
}
147 \IT{\arrGOO{(
\FU*
{GET
} \VAR{ symbol
} \VAR{ key
}
148 \OP{\VAR{default
}\DF{\NIL}})\\
149 (
\FU*
{GETF
} \VAR{ place
} \VAR{ key
}
150 \OP{\VAR{default
}\DF{\NIL}})
}{.
}}
152 \retval{First entry
\VAR{key
}} from property list stored in
153 \VAR{symbol
}/in
\VAR{place
}, respectively, or
\retval{\VAR{default
}} if
154 there is no
\VAR{key
}.
\kwd{setf
}able.
157 \IT{(
\FU*
{GET-PROPERTIES
} \VAR{property-list
} \VAR{keys
})
}
159 Return
\retval{key
} and
\retvalii{value
} of first entry from
\VAR{property-list
}
160 matching a key from
\VAR{keys
}, and
\retvaliii{tail of
161 \VAR{property-list
}} starting with that key. Return
\retval{\NIL},
162 \retvalii{\NIL}, and
\retvaliii{\NIL} if there was no matching key
163 in
\VAR{property-list
}.
166 \IT{\arrGOO{(
\FU*
{REMPROP
} \DES{\VAR{symbol
}} \VAR{ key
})\\
167 (
\MC*
{REMF
} \DES{\VAR{place
}} \VAR{ key
})
}{.
}}
169 Remove first entry
\VAR{key
} from property list stored in
170 \VAR{symbol
}/in
\VAR{place
}, respectively. Return
\retval{\T} if
\VAR{key
}
171 was there, or
\retval{\NIL} otherwise.
177 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
178 \subsection{Functions
}
179 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
180 \label{section:Functions
}
183 Below, ordinary lambda list (
\OPn{\VAR{ord-$
\lambda$
}}) has the form\\
184 % \VAR{var} referenced from DEFSTRUCT
186 \OP{\kwd{\&optional
} \xorGOO{%
188 (
\VAR{var
} \OP{\VAR{init
}\DF{\NIL}\text{ } \Op{\VAR{supplied-p
}}})
}{\
}^
{\!\!*
}}}
190 \Op{\kwd{\&rest
} \VAR{var
}}
192 \OP{\kwd{\&key
} \xorGOO{%
196 (
\kwd{:
}\VAR{key
} \VAR{var
})
}{\
}}
197 \text{ }\OP{\VAR{init
}\DF{\NIL}\text{ }\Op{\VAR{supplied-p
}}})
}{\
}^
{\!\!*
}}
199 \Op{\kwd{\&allow-other-keys
}}}
201 \OP{\kwd{\&aux
} \xorGOO{%
203 (
\VAR{var
} \Op{\VAR{init
}\DF{\NIL}})
}{\
}^
{\!\!*
}}}).
205 \VAR{supplied-p
} is
\T\ if there is a corresponding
206 argument.
\VAR{init
} forms can refer to any
\VAR{init
} and
207 \VAR{supplied-p
} to their left.
211 \IT{(
\xorGOO{\MC*
{DEFUN
}\xorGOO{\VAR{foo
}(
\VAR{\OPn{ord-$
\lambda$
}})\\
212 (
\kwd{setf
} \VAR{ foo
})
\text{ }(
\VAR{new-value
} \VAR{\OPn{ord-$
\lambda$
}})
}{.
}\\
213 \MC*
{LAMBDA
}(
\VAR{\OPn{ord-$
\lambda$
}})
}{\
}}
214 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}
218 Define a function named
\retval{\VAR{foo
}} or
\retval{(
\kwd{setf
}
219 \VAR{foo
})
}, or an anonymous
\retval{function
}, respectively, which applies
220 \VAR{form
}s to
\VAR{ord-$
\lambda$
}s. For
\MC{defun
},
\VAR{form
}s are
221 enclosed in an implicit
\SO{block
} named
\VAR{foo
}.
224 \IT{(
\xorGOO{\SO*
{FLET
}\\
226 (
\OPn{(
\xorGOO{\VAR{foo
}(
\OPn{\VAR{ord-$
\lambda$
}})\\
227 (
\kwd{setf
} \VAR{ foo
})
\text{ }(
\VAR{new-value
}\OPn{\VAR{ord-$
\lambda$
}})
}{\
}}
228 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{local-decl
}}})
}
230 \PROGN{\VAR{local-form
}})
})
\OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}
233 Evaluate
\VAR{form
}s with
234 locally defined functions
\VAR{foo
}. Globally defined functions of
235 the same name are shadowed. Each
\VAR{foo
} is also the name of an
236 implicit
\SO{block
} around its corresponding
\OPn{\VAR{local-form
}}.
237 Only for
\SO{LABELS
}, functions
\VAR{foo
} are visible inside
238 \VAR{local-forms
}. Return
\retval{values of
\VAR{form
}s
}.
241 \IT{(
\SO*
{FUNCTION
} \xorGOO{%
243 (
\MC{lambda
} \OPn{\VAR{form
}})
}{\
}})
}
245 Return lexically innermost
\retval{function
} named
\VAR{foo
} or a
246 lexical closure of the
\retval{\MC{lambda
} expression
}.
249 \IT{(
\FU*
{APPLY
} \xorGOO{\VAR{function
}\\
250 (
\kwd{setf
} \VAR{function
})
}{\
}} \OPn{\VAR{arg
}} \VAR{args
})
}
252 \retval{Values of
\VAR{function
}} called with
253 \VAR{arg
}s and the list elements of
\VAR{args
}.
\kwd{setf
}able if
254 \VAR{function
} is one of
\FU{aref
},
\FU{bit
}, and
\FU{sbit
}.
257 \IT{(
\FU*
{FUNCALL
} \VAR{function
} \OPn{arg
})
}
259 \retval{Values of
\VAR{function
}} called with
\VAR{arg
}s.
262 \IT{(
\SO*
{MULTIPLE-VALUE-CALL
} \VAR{function
} \OPn{\VAR{form
}})
}
264 Call
\VAR{function
} with all the values of each
\VAR{form
} as its
265 arguments. Return
\retval{values returned by
\VAR{function
}}.
268 \IT{(
\FU*
{VALUES-LIST
} \VAR{list
})
}
270 Return
\retval{elements of
\VAR{list
}}.
273 \IT{(
\FU*
{VALUES
} \OPn{\VAR{foo
}})
}
275 Return as multiple values the
\retval{primary values
} of the
276 \VAR{foo
}s.
\kwd{setf
}able.
279 \IT{(
\FU*
{MULTIPLE-VALUE-LIST
} \VAR{form
})
}
281 \retval{List of the values of
\VAR{form
}}.
284 \IT{(
\MC*
{NTH-VALUE
} \VAR{n
} \VAR{form
})
}
286 Zero-indexed
\retval{\VAR{n
}th return value
} of
\VAR{form
}.
289 \IT{(
\FU*
{COMPLEMENT
} \VAR{function
})
}
291 Return
\retval{new function
} with same arguments and same side effects
292 as
\VAR{function
}, but with complementary truth value.
295 \IT{(
\FU*
{CONSTANTLY
} \VAR{foo
})
}
297 Return
\retval{function
} of any number of arguments returning
\VAR{foo
}.
300 \IT{(
\FU*
{IDENTITY
} \VAR{foo
})
}
302 Return
\retval{\VAR{foo
}}.
305 \IT{(
\FU*
{FUNCTION-LAMBDA-EXPRESSION
} \VAR{function
})
}
307 If available, return
\retval{lambda expression
} of
\VAR{function
},
308 \retvalii{\NIL} if
\VAR{function
} was defined in an environment
309 without bindings, and
\retvaliii{name
} of
\VAR{function
}.
312 \IT{(
\FU*
{FDEFINITION
} \xorGOO{\VAR{foo
}\\
313 (
\kwd{setf
} \VAR{foo
})
}{\
}})
}
315 \retval{Definition
} of global function
\VAR{foo
}.
\kwd{setf
}able.
318 \IT{(
\FU*
{FMAKUNBOUND
} \VAR{foo
})
}
320 Remove global function or macro definition
\retval{\VAR{foo
}}.
323 \IT{\arrGOO{\CNS*
{CALL-ARGUMENTS-LIMIT
}\\
324 \CNS*
{LAMBDA-PARAMETERS-LIMIT
}}{.
}}
326 Upper bound of the number of function arguments or lambda list
327 parameters, respectively; $
\geq50$.
330 \IT{\CNS*
{MULTIPLE-VALUES-LIMIT
}}
332 Upper bound of the number of values a multiple value can have;
339 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
341 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
342 \label{section:Macros
}
345 Below, macro lambda list (
\OPn{\VAR{macro-$
\lambda$
}}) has the form of
348 (
\Op{\kwd{\&whole
} \VAR{var
}}
354 (
\OPn{\VAR{macro-$
\lambda$
}})
}{\
}^
{\!\!*
}}
363 (
\OPn{\VAR{macro-$
\lambda$
}})
}{\
}}\text{ }
364 \OP{\VAR{init
}\DF{\NIL}\text{ } \Op{\VAR{supplied-p
}}})
}{\
}^
{\!\!*
}}}
374 (
\OPn{\VAR{macro-$
\lambda$
}})
}{\
}}}
383 (
\kwd{:
}\VAR{key
} \xorGOO{%
385 (
\OPn{\VAR{macro-$
\lambda$
}})
}{\
}})
}{\
}}
386 \text{ }\OP{\VAR{init
}\DF{\NIL}\text{ } \Op{\VAR{supplied-p
}}})
}{\
}^
{\!\!*
}}
388 \Op{\kwd{\&allow-other-keys
}}}
393 (
\VAR{var
} \Op{\VAR{init
}\DF{\NIL}})
}{\
}^
{\!\!*
}}}
407 (
\OPn{\VAR{macro-$
\lambda$
}})
}{\
}^
{\!\!*
}}
416 (
\OPn{\VAR{macro-$
\lambda$
}})
}{\
}}\text{ }
417 \OP{\VAR{init
}\DF{\NIL}\text{ } \Op{\VAR{supplied-p
}}})
}{\
}^
{\!\!*
}}}
424 One toplevel
\Op{\VAR{E
}} may be replaced by
\kwd{\&environment
}
425 \VAR{var
}.
\VAR{supplied-p
} is
\T\ if there is a corresponding
426 argument.
\VAR{init
} forms can refer to any
\VAR{init
} and
427 \VAR{supplied-p
} to their left.
431 \IT{(
\xorGOO{\MC*
{DEFMACRO
}\\
432 \FU*
{DEFINE-COMPILER-MACRO
}}{\
}}
434 (
\kwd{setf
} \VAR{foo
})
}{\
}}
435 (
\OPn{\VAR{macro-$
\lambda$
}})
436 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
} \Op{\NEV{\VAR{doc
}}}
439 Define macro
\retval{\VAR{foo
}} which on evaluation as (
\VAR{foo
}
440 \VAR{tree
}) applies expanded
\VAR{form
}s to arguments from
441 \VAR{tree
}, which corresponds to
\VAR{tree
}-shaped
442 \VAR{macro-$
\lambda$
}s.
\VAR{form
}s are enclosed in an implicit
443 \SO{block
} named
\VAR{foo
}.
446 \IT{(
\MC*
{DEFINE-SYMBOL-MACRO
} \VAR{foo
} \VAR{form
})
}
448 Define symbol macro
\retval{\VAR{foo
}} which on evaluation evaluates
452 \IT{(
\SO*
{MACROLET
} (
\OPn{(
\VAR{foo
} (
\OPn{\VAR{macro-$
\lambda$
}})
453 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{local-decl
}}})
}
454 \Op{\NEV{\VAR{doc
}}} \PROGN{\VAR{macro-form
}})
})
\OPn{(
\kwd{declare
}
455 \OPn{\NEV{\VAR{decl
}}})
} \PROGN{\VAR{form
}})
}
457 Evaluate
\retval{\VAR{form
}s
} with locally defined mutually
458 invisible macros
\VAR{foo
} which are enclosed in implicit
\SO{block
}s
462 \IT{(
\SO*
{SYMBOL-MACROLET
} (
\OPn{(
\VAR{foo
}
463 \VAR{expansion-form
})
})
\OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}
466 Evaluate
\retval{\VAR{form
}s
} with locally defined symbol macros
470 \IT{(
\MC*
{DEFSETF
} \NEV{\VAR{function
}} \xorGOO{%
471 \NEV{\VAR{updater
}} \text{ } \Op{\NEV{\VAR{doc
}}}\\
472 (
\OPn{\VAR{setf-$
\lambda$
}})
\text{ } (
\OPn{\VAR{s-var
}})
\text{ }
473 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}\text{ }
474 \Op{\NEV{\VAR{doc
}}} \text{ } \PROGN{\VAR{form
}}}{\
}})
476 where defsetf lambda list (
\OPn{\VAR{setf-$
\lambda$
}}) has the form
479 \OP{\kwd{\&optional
} \xorGOO{%
481 (
\VAR{var
} \OP{\VAR{init
}\DF{\NIL}\text{ } \Op{\VAR{supplied-p
}}})
}{\
}^
{\!\!*
}}}
483 \Op{\kwd{\&rest
} \VAR{var
}}
485 \OP{\kwd{\&key
} \xorGOO{%
489 (
\kwd{:
}\VAR{key
} \VAR{var
})
}{\
}}
490 \text{ }\OP{\VAR{init
}\DF{\NIL}\text{ }\Op{\VAR{supplied-p
}}})
}{\
}^
{\!\!*
}}
492 \Op{\kwd{\&allow-other-keys
}}}
494 \OP{\kwd{\&environment
} \VAR{var
}}%
498 Specify how to
\kwd{setf
} a place accessed by
499 \retval{\VAR{function
}}.
500 \EM{Short form:
} (
\kwd{setf
} (
\VAR{function
} \OPn{\VAR{arg
}})
\VAR{value-form
}) is
501 replaced by (
\VAR{updater
} \OPn{\VAR{arg
}} \VAR{value-form
}); the
502 latter must return
\VAR{value-form
}.
503 \EM{Long form:
} on invocation of (
\kwd{setf
} (
\VAR{function
}
504 \OPn{\VAR{arg
}})
\VAR{value-form
}),
\VAR{form
}s must expand
505 into code that sets the place accessed where
\VAR{setf-$
\lambda$
}
506 and
\OPn{\VAR{s-var
}} describe the arguments of
\VAR{function
} and
507 the value(s) to be stored, respectively; and that returns
508 the value(s) of
\OPn{\VAR{s-var
}}.
\VAR{form
}s are enclosed in an
509 implicit
\SO{block
} named
\VAR{function
}.
512 \IT{(
\MC*
{DEFINE-SETF-EXPANDER
} \VAR{function
}
513 (
\OPn{\VAR{macro-$
\lambda$
}})
514 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
} \Op{\NEV{\VAR{doc
}}}
517 Specify how to
\kwd{setf
} a place accessed by
518 \retval{\VAR{function
}}. On invocation of (
\kwd{setf
} (
\VAR{function
}
519 \OPn{\VAR{arg
}})
\VAR{value-form
}),
\OPn{\VAR{form
}} must expand
520 into code returning
\VAR{arg-vars
},
\VAR{args
},
\VAR{newval-vars
},
521 \VAR{set-form
}, and
\VAR{get-form
} as described with
522 \FU{GET-SETF-EXPANSION
} where the elements of macro
523 lambda list
\OPn{\VAR{macro-$
\lambda$
}} are bound to corresponding
524 \VAR{arg
}s.
\VAR{form
}s are enclosed in an implicit
\SO{block
}
525 named
\VAR{function
}.
528 \IT{(
\FU*
{GET-SETF-EXPANSION
} \VAR{place
} \Op{\VAR{environment
}\DF{\NIL}})
}
530 Return lists of temporary variables
\retval{\VAR{arg-vars
}} and of
531 corresponding
\retvalii{\VAR{args
}} as given with
\VAR{place
},
532 list
\retvaliii{\VAR{\VAR{newval-vars
}}} with temporary variables
533 corresponding to the new values, and
\retvaln{4}{\VAR{set-form
}}
534 and
\retvaln{5}{\VAR{get-form
}} specifying in terms of
\VAR{arg-vars
}
535 and
\VAR{newval-vars
} how to
\kwd{setf
} and how to read
539 \IT{(
\MC*
{DEFINE-MODIFY-MACRO
} \VAR{foo
}
540 (
\OP{\kwd{\&optional
} \xorGOO{%
542 (
\VAR{var
} \OP{\VAR{init
}\DF{\NIL}\text{ }
543 \Op{\VAR{supplied-p
}}})
}{\
}^
{\!\!*
}}}
544 \Op{\kwd{\&rest
} \VAR{var
}})
545 \VAR{function
} \Op{\NEV{\VAR{doc
}}})
}
547 Define macro
\retval{\VAR{foo
}} able to modify a place. On
548 invocation of (
\VAR{foo
} \VAR{place
} \OPn{\VAR{arg
}}), the value of
549 \VAR{function
} applied to
\VAR{place
} and
\VAR{arg
}s will be stored into
550 \VAR{place
} and returned.
553 \IT{\CNS*
{LAMBDA-LIST-KEYWORDS
}}
554 {List of macro lambda list keywords. These are at least:
558 \IT{\kwd*
{\&whole
} \VAR{var
}}
559 {Bind
\VAR{var
} to the entire macro call form.
}
561 \IT{\kwd*
{\&optional
} \OPn{\VAR{var
}}}
562 {Bind
\VAR{var
}s to corresponding arguments if any.
}
566 \kwd*
{\&body
}} \VAR{var
}}
567 {Bind
\VAR{var
} to a list of remaining arguments.
}
569 \IT{\kwd*
{\&key
} \OPn{\VAR{var
}}}
570 {Bind
\VAR{var
}s to corresponding keyword arguments.
}
572 \IT{\kwd*
{\&allow-other-keys
}}
574 Suppress keyword argument checking. Callers can do so using
575 \kwd*
{:allow-other-keys
}~
\T.
578 \IT{\kwd*
{\&environment
} \VAR{var
}}
579 {Bind
\VAR{var
} to the lexical compilation environment.
}
581 \IT{\kwd*
{\&aux
} \OPn{\VAR{var
}}}
582 {Bind
\VAR{var
}s as in
\SO{let
\A}.
}
588 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
589 \subsection{Control Flow
}
590 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
593 \IT{(
\SO*
{IF
} \VAR{test
} \VAR{then
} \Op{\VAR{else
}\DF{\NIL}})
}
595 Return values of
\retval{\VAR{then
}} if
\VAR{test
} returns
\T;
596 return values of
\retval{\VAR{else
}} otherwise.
599 \IT{(
\MC*
{COND
} \OPn{(
\VAR{test
} \PROGN{\VAR{then
}}\DF{\VAR{test
}})
})
}
601 Return the
\retval{values
} of the first
602 \OPn{\VAR{then
}} whose
\VAR{test
} returns
\T; return
603 \retval{\NIL} if all
\VAR{test
}s return
\NIL.
606 \IT{(
\xorGOO{\MC*
{WHEN
}\\
607 \MC*
{UNLESS
}}{\
}} \VAR{test
}
610 Evaluate
\VAR{foo
}s and return
\retval{their values
} if
\VAR{test
}
611 returns
\T\ or
\NIL, respectively. Return
\retval{\NIL} otherwise.
614 \IT{(
\MC*
{CASE
} \VAR{test
} \OPn{(
\xorGOO{(
\OPn{\NEV{\VAR{key
}}})\\
615 \NEV{\VAR{key
}}}{\
}} \PROGN{\VAR{foo
}})
}
616 \OP{(
\xorGOO{\kwd*
{OTHERWISE
}\\
617 \T}{\
}} \PROGN{\VAR{bar
}})
\DF{\NIL}})
}
619 Return the
\retval{values
} of the first
\OPn{\VAR{foo
}} one of whose
\VAR{key
}s is
620 \kwd{eql
} \VAR{test
}.
621 Return
\retval{values of
\VAR{bar
}s
} if there is no matching
\VAR{key
}.
624 \IT{(
\xorGOO{\MC*
{ECASE
}\\
625 \MC*
{CCASE
}}{\
}} \VAR{test
}
626 \OPn{(
\xorGOO{(
\OPn{\NEV{\VAR{key
}}})\\
627 \NEV{\VAR{key
}}}{\
}} \PROGN{\VAR{foo
}})
})
}
629 Return the
\retval{values
} of the first
\OPn{\VAR{foo
}} one of whose
\VAR{key
}s is
\kwd{eql
}
630 \VAR{test
}. Signal non-correctable/correctable
\kwd{type-error
} and
631 return
\retval{\NIL} if there is no matching
\VAR{key
}.
634 \IT{(
\MC*
{AND
} \OPn{\VAR{form
}}\DF{\T})
}
636 Evaluate
\VAR{form
}s from left to
637 right. Immediately return
\retval{\NIL} if one
\VAR{form
}'s value is
\NIL. Return
638 \retval{values of last
\VAR{form
}} otherwise.
641 \IT{(
\MC*
{OR
} \OPn{\VAR{form
}}\DF{\NIL})
}
643 Evaluate
\VAR{form
}s from left to
644 right. Immediately return
\retval{primary value
} of first
645 non-
\NIL-evaluating form, or
\retval{all values
} if last
\VAR{form
}
646 is reached. Return
\retval{\NIL} if no
\VAR{form
} returns
\T.
649 \IT{(
\SO*
{PROGN
} \OPn{\VAR{form
}}\DF{\NIL})
}
651 Evaluate
\VAR{form
}s sequentially. Return
652 \retval{values of last
\VAR{form
}}.
656 (
\SO*
{MULTIPLE-VALUE-PROG1
} \VAR{ form-r
} \OPn{\VAR{ form
}})\\
657 (
\MC*
{PROG1
} \VAR{ form-r
} \OPn{\VAR{ form
}})\\
658 (
\MC*
{PROG2
} \VAR{ form-a
} \VAR{ form-r
} \OPn{\VAR{ form
}})
}{.
}}
660 Evaluate forms in order. Return
\retval{values/
1st value
},
661 respectively, of
\VAR{form-r
}.
664 \IT{(
\xorGOO{\SO*
{LET
}\\
667 (
\VAR{name
}\Op{\VAR{value
}\DF{\NIL}})
}{\
}^
{\!\!*
}})
668 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}
671 Evaluate
\VAR{form
}s with
\VAR{name
}s lexically bound (in parallel or
672 sequentially, respectively) to
\VAR{value
}s. Return
673 \retval{values of
\VAR{form
}s
}.
676 \IT{(
\xorGOO{\MC*
{PROG
}\\
680 (
\VAR{var
} \Op{\VAR{value
}\DF{\NIL}})
}{\
}^
{\!\!*
}})
681 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}
682 \xorGOO{\NEV{\VAR{tag
}}\\
\VAR{form
}}{\
}^
{\!\!*
}})
}
684 Evaluate
\SO{TAGBODY
}-like body with
\VAR{var
}s locally bound (in
685 parallel or sequentially, respectively) to
\VAR{value
}s. Return
686 \retval{\NIL} or explicitly
\retval{\MC{return
}ed values
}.
687 Implicitly, the whole form is a
\SO{block
} named
\NIL.
690 \IT{(
\SO*
{PROGV
} \VAR{symbols
} \VAR{values
} \PROGN{\VAR{form
}})
}
692 Evaluate
\VAR{form
}s with locally established dynamic bindings of
693 \VAR{symbols
} to
\VAR{values
} or
\NIL. Return
\retval{values of
697 \IT{(
\SO*
{UNWIND-PROTECT
} \VAR{protected
} \OPn{\VAR{cleanup
}})
}
699 Evaluate
\VAR{protected
} and then, no matter how control leaves
700 \VAR{protected
},
\VAR{cleanup
}s. Return
\retval{values of
704 \IT{(
\MC*
{DESTRUCTURING-BIND
} \VAR{destruct-$
\lambda$
} \VAR{bar
} \OPn{(
\kwd{declare
}
705 \OPn{\NEV{\VAR{decl
}}})
} \PROGN{\VAR{form
}})
}
707 Evaluate
\VAR{form
}s with variables from tree
\VAR{destruct-$
\lambda$
} bound to
708 corresponding elements of tree
\VAR{bar
}, and return
\retval{their
709 values
}.
\VAR{destruct-$
\lambda$
} resembles
\VAR{macro-$
\lambda$
}
710 (section
\ref{section:Macros
}), but without any
\kwd{\&environment
}
714 \IT{(
\MC*
{MULTIPLE-VALUE-BIND
} (
\OPn{\NEV{\VAR{var
}}})
\VAR{values-form
}
715 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
} \PROGN{\VAR{body-form
}})
}
718 \VAR{body-form
}s with
\VAR{var
}s lexically bound to the return values of
719 \VAR{values-form
}. Return
\retval{values of
\VAR{body-form
}s
}.
722 \IT{(
\SO*
{BLOCK
} \VAR{name
} \PROGN{\VAR{form
}})
}
724 Evaluate
\VAR{form
}s in a lexical environment, and
725 return
\retval{their values
} unless interrupted by
729 \IT{\arrGOO{(
\SO*
{RETURN-FROM
} \VAR{foo
} \Op{\VAR{result
}\DF{\NIL}})\\
730 (
\MC*
{RETURN
} \Op{\VAR{result
}\DF{\NIL}})
}{.
}}
732 Have nearest enclosing
\SO{block
} named
\VAR{foo
}/named
\NIL,
733 respectively, return with values of
\VAR{result
}.
736 \IT{(
\SO*
{TAGBODY
} \Goos{\NEV{\VAR{tag
}}\XOR\VAR{form
}})
}
738 Evaluate
\VAR{form
}s in a lexical environment.
\VAR{tag
}s (symbols or integers) have lexical
739 scope and dynamic extent, and are targets for
\SO{GO
}. Return
743 \IT{(
\SO*
{GO
} \NEV{\VAR{tag
}})
}
745 Within the innermost enclosing
\SO{tagbody
}, jump to a tag
\kwd{eql
} \VAR{tag
}.
748 \IT{(
\SO*
{CATCH
} \VAR{tag
} \PROGN{\VAR{form
}})
}
750 Evaluate
\VAR{form
}s and return
\retval{their values
} unless
751 interrupted by
\SO{THROW
}.
754 \IT{(
\SO*
{THROW
} \VAR{tag
} \VAR{form
})
}
755 {Have the nearest dynamically
756 enclosing
\SO{CATCH
} with a tag
\FU{eq
} \VAR{tag
} return with the
757 values of
\VAR{form
}.
760 \IT{(
\FU*
{SLEEP
} \VAR{n
})
}
761 {Wait
\VAR{n
} seconds, return
\retval{\NIL}.
767 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
768 \subsection{Iteration
}
769 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
773 \IT{(
\xorGOO{\MC*
{DO
}\\
777 (
\VAR{var
} \OP{ \VAR{start
} \Op{\VAR{step
}}})
}{\
}^
{\!\!*
}})
778 (
\VAR{stop
} \PROGN{\VAR{result
}})
779 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}
780 \xorGOO{\NEV{\VAR{tag
}}\\
\VAR{form
}}{\
}^
{\!\!*
}})
}
782 Evaluate
\SO{TAGBODY
}-like body with
\VAR{var
}s successively bound according
783 to the values of the corresponding
\VAR{start
} and
\VAR{step
}
784 forms.
\VAR{var
}s are bound in parallel/sequentially, respectively.
785 Stop iteration when
\VAR{stop
} is
\T. Return
\retval{values of
786 \OPn{\VAR{result
}}}. Implicitly, the whole form is a
\SO{block
}
790 \IT{(
\MC*
{DOTIMES
} (
\VAR{var
} \VAR{i
} \Op{\VAR{result
}\DF{\NIL}})
791 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}
792 \Goos{\NEV{\VAR{tag
}}\XOR\VAR{form
}})
}
794 Evaluate
\SO{TAGBODY
}-like body with
\VAR{var
} successively bound
795 to integers from
0 to $i -
1$. Upon evaluation of
796 \retval{\VAR{result
}},
\VAR{var
} is
\VAR{i
}. Implicitly, the whole
797 form is a
\SO{block
} named
\NIL.
800 \IT{(
\MC*
{DOLIST
}(
\VAR{var
} \VAR{list
} \Op{\VAR{result
}\DF{\NIL}})
801 \OPn{(
\kwd{declare
} \OPn{\NEV{\VAR{decl
}}})
}
802 \Goos{\NEV{\VAR{tag
}}\XOR\VAR{form
}})
}
804 Evaluate
\SO{TAGBODY
}-like body with
\VAR{var
} successively bound
805 to the elements of
\VAR{list
}. Upon evaluation of
806 \retval{\VAR{result
}},
\VAR{var
} is
\NIL. Implicitly, the whole form
807 is a
\SO{block
} named
\NIL.
813 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
814 \subsection{Loop Facility
}
815 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
820 \IT{(
\MC*
{LOOP
} \OPn{\VAR{form
}})
}
822 \EM{Simple Loop.
} If
\VAR{form
}s do not contain any atomic Loop Facility
823 keywords, evaluate them forever in an implicit
\SO{block
} named
\NIL.
826 \IT{(
\MC*
{LOOP
} \OPn{\VAR{clause
}})
}
828 \EM{Loop Facility.
} For Loop Facility keywords
829 see below and Figure
\ref{loop-overview
}.
834 \IT{\LKWD*
{named
} \VAR{n
}\DF{\NIL}}
836 Give
\MC{loop
}'s implicit
\SO{block
} a name.
839 \IT{\Goop{\LKWD*
{with
}
842 (
\OPn{\VAR{var-s
}})
}{\
}}
843 \Op{\VAR{d-type
}} \LKWD*
{=
} \VAR{foo
}} \Goos{\LKWD*
{and
}
846 (
\OPn{\VAR{var-p
}})
}{\
}}
847 \Op{\VAR{d-type
}} \LKWD*
{=
} \VAR{bar
}}
849 where destructuring type specifier
\VAR{d-type
} has the form
851 \GOO{\kwd{fixnum
}\XOR
858 (
\OPn{\VAR{type
}})
}{\
}}}}
861 Initialize (possibly trees of) local variables
\VAR{var-s
}
862 sequentially and
\VAR{var-p
} in parallel.
871 \text{\kwd{loop
}}\text{ }
873 \text{\LKWD{named
} \VAR{n
}\DF{\NIL}}
880 (
\OPn{\VAR{var
}})
}{\
}}
881 \Op{\VAR{d-type
}} \LKWD{=
} \VAR{foo
}}
885 (
\OPn{\VAR{var
}})
}{\
}}
886 \Op{\VAR{d-type
}} \LKWD{=
}
887 \VAR{bar
}}\
}^
{*
} \\ \\
[-
2.4ex
]
896 (
\OPn{\VAR{var
}})
}{\
}}}%
905 \text{\LKWD{upfrom
}}\\
909 \text{\VAR{start
}\DF{\LIT{0}}}
921 \text{\LKWD{from
} \VAR{start
}}
924 \text{\LKWD{downto
}}\\
929 \text{\LKWD{downfrom
} \VAR{start
}}\text{ }
933 \text{\LKWD{downto
}}\\
943 \text{\LKWD{by
} \VAR{step
}\DF{\LIT{1}}}
951 \text{\VAR{list
}}\text{ }
953 \text{\LKWD{by
} \VAR{function
}\DF{\kwd{\#'cdr
}}}
955 \text{\LKWD{=
} \VAR{foo
}}
957 \text{\LKWD{then
} \VAR{bar
}\DF{\VAR{foo
}}}
959 \text{\LKWD{across
} \VAR{vector
}}\\
971 \text{\LKWD{hash-key
\Op{s
}}}
980 \text{\LKWD{using
} (
\LKWD{hash-value
} \VAR{v
})
}%
982 \text{\LKWD{hash-value
\Op{s
}}}
991 \text{\LKWD{using
} (
\LKWD{hash-key
} \VAR{k
})
}%
997 \text{\LKWD{symbol
\Op{s
}}}\\
998 \text{\LKWD{present-symbol
\Op{s
}}}\\
999 \text{\LKWD{external-symbol
\Op{s
}}}
1008 \right\
} \text{\VAR{package
}\DF{\V{\A package
\A}}}%
1013 \right\
}_
{{}^
{{}^
{\displaystyle{\mathbb{F
}_0
}}}}
1016 \text{\LKWD{and
} }\boxed{\mathbb{F
}_i\!
}
1019 \boxed{\;
\mathbb{T
}_1\,
}
1022 \right\
}^
{\displaystyle{\!\!*
}}
1029 \text{\LKWD{do
\Op{ing
}}}
1030 \text{ \VAR{form
}}^
{+
}\\
1034 \text{\LKWD{when
}}\\
1035 \text{\LKWD{unless
}}
1039 \boxed{\mathbb{C
}_i\!
}\
{\text{\LKWD{and
}}\,
1040 \boxed{\mathbb{C
}_j\!
}\
}^
{*
}\Op{\text{\LKWD{else
}}\,
1041 \boxed{\mathbb{C
}_k\!
}\
{\text{\LKWD{and
}}\,
1042 \boxed{\mathbb{C
}_l\!
}\
}^
{*
}}
1043 \Op{\text{\LKWD{end
}}}\!\!\!\!\!\!\!\\
1044 \text{\LKWD{return
}}
1053 \text{\LKWD{collect
\Op{ing
}}}\\
1054 \text{\LKWD{append
\Op{ing
}}}\\
1055 \text{\LKWD{nconc
\Op{ing
}}}
1063 \right\
} \Op{\text{\LKWD{into
}\VAR{list
}}}\\
1066 \text{\LKWD{count
\Op{ing
}}}\\
1067 \text{\LKWD{sum
\Op{ming
}}}\\
1068 \text{\LKWD{maximize
}}\\
1069 \text{\LKWD{maximizing
}}\\
1070 \text{\LKWD{minimize
}}\\
1071 \text{\LKWD{minimizing
}}
1080 \Op{\text{\LKWD{into
}\VAR{num
}}}\text{ }
1081 \Op{\text{\VAR{type
}}}
1083 \right._
{{}^
{{}^
{\!\!\!\!
\displaystyle{\mathbb{C
}_0
}}}}
1092 \text{\LKWD{initially
}} \\
1093 \text{\LKWD{finally
}}
1096 \text{\VAR{form
}}^
{+
}\\
1097 \text{\LKWD{repeat
} \VAR{num
}}\\
1100 \text{\LKWD{while
}}\\
1101 \text{\LKWD{until
}}\\
1102 \text{\LKWD{always
}}\\
1103 \text{\LKWD{never
}}\\
1104 \text{\LKWD{thereis
}}
1109 \right._
{{}^
{{}^
{\displaystyle{\mathbb{T
}_2
}}}}
1112 \right\
}^
{\displaystyle{\!\!*
}}
1118 \raisebox{0em
}[0em
][0em
]{\parbox[b
]{4cm
}{\caption{\protect\raggedright Loop Facility, Overview.
\label{loop-overview
}}}}
1121 \IT{\GOop{\Goo{\LKWD*
{for
}\XOR\LKWD*
{as
}}
1124 (
\OPn{\VAR{var-s
}})
}{\
}}
1129 (
\OPn{\VAR{var-p
}})
}{\
}}
1132 Begin of iteration control clauses. Initialize and step (possibly
1133 trees of) local variables
\VAR{var-s
} sequentially and
\VAR{var-p
}
1134 in parallel. Destructuring type specifier
\VAR{d-type
} as with
\LKWD{with
}.
1139 \IT{\Goo{\LKWD*
{upfrom
}\XOR\LKWD*
{from
}\XOR\LKWD*
{downfrom
}}
1142 Start stepping with
\VAR{start
}
1145 \IT{\Goo{\LKWD*
{upto
}\XOR\LKWD*
{downto
}\XOR\LKWD*
{to
}\XOR\LKWD*
{below
}\XOR\LKWD*
{above
}}
1148 Specify
\VAR{form
} as the end value for stepping.
1151 \IT{\Goo{\LKWD*
{in
}\XOR\LKWD*
{on
}} \VAR{list
}}
1153 Bind
\VAR{var
} to successive elements/tails, respectively, of
\VAR{list
}.
1156 \IT{\LKWD*
{by
} \Goo{\VAR{step
}\DF{\LIT{1}}\XOR\VAR{function
}\DF{\kwd{\#'cdr
}}}}
1158 Specify the (positive) decrement or increment or the
1159 \VAR{function
} of one argument returning the next part of the list.
1162 \IT{\LKWD*
{=
} \VAR{foo
} \Op{\LKWD*
{then
}
1163 \VAR{bar
}\DF{\VAR{foo
}}}}
1165 Bind
\VAR{var
} in the first iteration to
\VAR{foo
} and later to
\VAR{bar
}.
1168 \IT{\LKWD*
{across
} \VAR{vector
}}
1170 Bind
\VAR{var
} to successive elements of
\VAR{vector
}.
1173 \IT{\LKWD*
{being
} \Goo{\LKWD*
{the
}\XOR\LKWD*
{each
}}}
1175 Iterate over a hash table or a package.
1180 \IT{\Goo{\LKWD*
{hash-key
}\XOR\LKWD*
{hash-keys
}} \Goo{\LKWD*
{of
}\XOR\LKWD*
{in
}} \VAR{hash-table
}
1181 \Op{\LKWD*
{using
} (
\LKWD*
{hash-value
} \VAR{value
})
}}
1183 Bind
\VAR{var
} successively to the keys of
\VAR{hash-table
}; bind
\VAR{value
} to corresponding values.
1186 \IT{\Goo{\LKWD*
{hash-value
}\XOR\LKWD*
{hash-values
}} \Goo{\LKWD*
{of
}\XOR\LKWD*
{in
}} \VAR{hash-table
}
1187 \Op{\LKWD*
{using
} (
\LKWD*
{hash-key
} \VAR{key
})
}}
1189 Bind
\VAR{var
} successively to the values of
\VAR{hash-table
}; bind
\VAR{key
} to corresponding keys.
1192 \IT{\Goo{\LKWD*
{symbol
}\XOR\LKWD*
{symbols
}\XOR\LKWD*
{present-symbol
}\XOR\LKWD*
{present-symbols
}\XOR\LKWD*
{external-symbol
}\XOR\LKWD*
{external-symbols
}}
1193 \Op{\Goo{\LKWD*
{of
}\XOR\LKWD*
{in
}}
1194 \VAR{package
}\DF{\V{\A package
\A}}}}
1196 Bind
\VAR{var
} successively to the accessible symbols, or the present
1197 symbols, or the external symbols respectively, of
1204 \IT{\Goo{\LKWD*
{do
}\XOR\LKWD*
{doing
}} \RP{\VAR{form
}}}
1206 Evaluate
\VAR{form
}s in every iteration.
1209 \IT{\Goo{\LKWD*
{if
}\XOR\LKWD*
{when
}\XOR\LKWD*
{unless
}} \VAR{ test
}
1210 \VAR{i-clause
} \Goos{\LKWD*
{and
}
1211 \VAR{j-clause
}} \Op{\LKWD*
{else
} \VAR{k-clause
} \Goos{\LKWD*
{and
}
1212 \VAR{l-clause
}}} \Op{\LKWD*
{end
}}}
1214 If
\VAR{test
} returns
\T,
\T, or
\NIL, respectively, evaluate
1215 \VAR{i-clause
} and
\VAR{j-clause
}s; otherwise, evaluate
\VAR{k-clause
}
1216 and
\VAR{l-clause
}s.
1222 Inside
\VAR{i-clause
} or
\VAR{k-clause
}:
1223 \retval{value of
\VAR{test
}}.
1227 \IT{\LKWD*
{return
} \Goo{\VAR{form
}\XOR\LKWD*
{it
}}}
1229 Return immediately, skipping any
\LKWD{finally
} parts, with values of
\VAR{form
} or
\LKWD{it
}.
1232 \IT{\Goo{\LKWD*
{collect
}\XOR\LKWD*
{collecting
}}
1233 \Goo{\VAR{form
}\XOR\LKWD*
{it
}} \Op{\LKWD*
{into
} \VAR{list
}}}
1235 Collect values of
\VAR{form
} or
\LKWD{it
} into
\VAR{list
}. If no
1236 \VAR{list
} is given, collect into an anonymous list which is
1237 returned after termination.
1240 \IT{\Goo{\LKWD*
{append
}\XOR\LKWD*
{appending
}\XOR\LKWD*
{nconc
}\XOR\LKWD*
{nconcing
}}
1241 \Goo{\VAR{form
}\XOR\LKWD*
{it
}} \Op{\LKWD*
{into
}
1244 Concatenate values of
\VAR{form
} or
\LKWD{it
}, which should be
1245 lists, into
\VAR{list
} by the means of
\FU{append
} or
\FU{nconc
},
1246 respectively. If no
\VAR{list
} is given, collect into an
1247 anonymous list which is returned after termination.
1250 \IT{\Goo{\LKWD*
{count
}\XOR\LKWD*
{counting
}}
1251 \Goo{\VAR{form
}\XOR\LKWD*
{it
}} \Op{\LKWD*
{into
}
1252 \VAR{n
}} \Op{\VAR{type
}}}
1254 Count the number of times the value of
\VAR{form
} or of
\LKWD{it
} is
\T.
1255 If no
\VAR{n
} is given, count into an anonymous variable
1256 which is returned after termination.
1259 \IT{\Goo{\LKWD*
{sum
}\XOR\LKWD*
{summing
}}
1260 \Goo{\VAR{form
}\XOR\LKWD*
{it
}} \Op{\LKWD*
{into
}
1261 \VAR{sum
}} \Op{\VAR{type
}}}
1263 Calculate the sum of the primary values of
\VAR{form
} or of
\LKWD{it
}.
1264 If no
\VAR{sum
} is given, sum into an anonymous variable
1265 which is returned after termination.
1268 \IT{\Goo{\LKWD*
{maximize
}\XOR\LKWD*
{maximizing
}\XOR
1269 \LKWD*
{minimize
}\XOR
1270 \LKWD*
{minimizing
}} \Goo{\VAR{form
}\XOR\LKWD*
{it
}} \Op{\LKWD*
{into
}
1271 \VAR{max-min
}} \Op{\VAR{type
}}}
1273 Determine the maximum or minimum, respectively, of the primary values of
1274 \VAR{form
} or of
\LKWD{it
}.
1275 If no
\VAR{max-min
} is given, use an anonymous variable
1276 which is returned after termination.
1279 \IT{\Goo{\LKWD*
{initially
}\XOR\LKWD*
{finally
}} \RP{\VAR{form
}}}
1281 Evaluate
\VAR{form
}s before begin, or after end, respectively, of iterations.
1284 \IT{\LKWD*
{repeat
} \VAR{num
}}
1286 Terminate
\MC{loop
} after
\VAR{num
} iterations;
\VAR{num
} is evaluated once.
1289 \IT{\Goo{\LKWD*
{while
}\XOR\LKWD*
{until
}} \VAR{test
}}
1291 Continue iteration until
\VAR{test
} returns
\NIL\ or
\T, respectively.
1294 \IT{\Goo{\LKWD*
{always
}\XOR\LKWD*
{never
}} \VAR{test
}}
1296 Terminate
\MC{loop
} returning
\NIL\ and skipping any
1297 \LKWD{finally
} parts as soon as
\VAR{test
} is
\NIL\ or
\T,
1298 respectively. Otherwise continue
\MC{loop
} with its default return
1302 \IT{\LKWD*
{thereis
} \VAR{test
}}
1304 Terminate
\MC{loop
} when
\VAR{test
} is
\T\ and return value of
1305 \VAR{test
}, skipping any
\LKWD{finally
} parts. Otherwise continue
1306 \MC{loop
} with its default return value set to
\NIL.
1309 \IT{(
\MC*
{loop-finish
})
}
1311 Terminate
\MC{loop
} immediately executing any
\LKWD{finally
}
1312 clauses and returning any accumulated results.
1322 %%% Local Variables:
1324 %%% TeX-master: "clqr"