This is the cl-utilities Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:49:29 2024 GMT+0.
cl-utilities/cl-utilities.asdcl-utilities/package.lispcl-utilities/split-sequence.lispcl-utilities/extremum.lispcl-utilities/read-delimited.lispcl-utilities/expt-mod.lispcl-utilities/with-unique-names.lispcl-utilities/collecting.lispcl-utilities/once-only.lispcl-utilities/rotate-byte.lispcl-utilities/copy-array.lispcl-utilities/compose.lispThe main system appears first, followed by any subsystem dependency.
cl-utilitiesMaintained by Peter Scott
package.lisp (file).
split-sequence.lisp (file).
extremum.lisp (file).
read-delimited.lisp (file).
expt-mod.lisp (file).
with-unique-names.lisp (file).
collecting.lisp (file).
once-only.lisp (file).
rotate-byte.lisp (file).
copy-array.lisp (file).
compose.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-utilities/cl-utilities.asdcl-utilities/package.lispcl-utilities/split-sequence.lispcl-utilities/extremum.lispcl-utilities/read-delimited.lispcl-utilities/expt-mod.lispcl-utilities/with-unique-names.lispcl-utilities/collecting.lispcl-utilities/once-only.lispcl-utilities/rotate-byte.lispcl-utilities/copy-array.lispcl-utilities/compose.lispcl-utilities/cl-utilities.asdcl-utilities (system).
cl-utilities/split-sequence.lisppackage.lisp (file).
cl-utilities (system).
partition (compiler macro).
partition (function).
partition-if (compiler macro).
partition-if (function).
partition-if-not (compiler macro).
partition-if-not (function).
split-sequence (function).
split-sequence-if (function).
split-sequence-if-not (function).
cl-utilities/extremum.lisppackage.lisp (file).
with-unique-names.lisp (file).
once-only.lisp (file).
cl-utilities (system).
extrema (function).
extremum (compiler macro).
extremum (function).
extremum-fastkey (function).
n-most-extreme (function).
n-most-extreme-not-enough-elements (condition).
n-most-extreme-not-enough-elements-n (reader method).
n-most-extreme-not-enough-elements-subsequence (reader method).
no-extremum (condition).
comparator (compiler macro).
comparator (function).
with-check-length (macro).
zero-length-p (function).
cl-utilities/read-delimited.lisppackage.lisp (file).
cl-utilities (system).
read-delimited (function).
read-delimited-bounds-error (condition).
read-delimited-bounds-error-end (reader method).
read-delimited-bounds-error-sequence (reader method).
read-delimited-bounds-error-start (reader method).
%read-delimited-bounds-check (function).
%read-delimited-bounds-check-end (function).
%read-delimited-bounds-check-order (function).
%read-delimited-bounds-check-start (function).
cl-utilities/expt-mod.lisppackage.lisp (file).
cl-utilities (system).
cl-utilities/with-unique-names.lisppackage.lisp (file).
cl-utilities (system).
list-binding-not-supported (condition).
list-binding-not-supported-binding (reader method).
with-gensyms (macro).
with-unique-names (macro).
%with-unique-names-binding-parts (function).
cl-utilities/collecting.lisppackage.lisp (file).
with-unique-names.lisp (file).
compose.lisp (file).
cl-utilities (system).
collect (function).
collecting (macro).
with-collectors (macro).
%with-collectors-check-collectors (function).
%with-collectors-gensyms-alist (function).
cl-utilities/once-only.lisppackage.lisp (file).
cl-utilities (system).
once-only (macro).
%check-once-only-names (function).
cl-utilities/rotate-byte.lisppackage.lisp (file).
cl-utilities (system).
rotate-byte (function).
cl-utilities/copy-array.lisppackage.lisp (file).
cl-utilities (system).
copy-array (function).
%make-array-with-same-properties (function).
cl-utilities/compose.lisppackage.lisp (file).
cl-utilities (system).
Packages are listed by definition order.
cl-utilitiescommon-lisp.
collect (function).
collecting (macro).
compose (compiler macro).
compose (function).
copy-array (function).
expt-mod (compiler macro).
expt-mod (function).
extrema (function).
extremum (compiler macro).
extremum (function).
extremum-fastkey (function).
list-binding-not-supported (condition).
list-binding-not-supported-binding (generic reader).
n-most-extreme (function).
n-most-extreme-not-enough-elements (condition).
n-most-extreme-not-enough-elements-n (generic reader).
n-most-extreme-not-enough-elements-subsequence (generic reader).
no-extremum (condition).
once-only (macro).
partition (compiler macro).
partition (function).
partition-if (compiler macro).
partition-if (function).
partition-if-not (compiler macro).
partition-if-not (function).
read-delimited (function).
read-delimited-bounds-error (condition).
read-delimited-bounds-error-end (generic reader).
read-delimited-bounds-error-sequence (generic reader).
read-delimited-bounds-error-start (generic reader).
rotate-byte (function).
split-sequence (function).
split-sequence-if (function).
split-sequence-if-not (function).
with-collectors (macro).
with-gensyms (macro).
with-unique-names (macro).
%check-once-only-names (function).
%make-array-with-same-properties (function).
%read-delimited-bounds-check (function).
%read-delimited-bounds-check-end (function).
%read-delimited-bounds-check-order (function).
%read-delimited-bounds-check-start (function).
%with-collectors-check-collectors (function).
%with-collectors-gensyms-alist (function).
%with-unique-names-binding-parts (function).
comparator (compiler macro).
comparator (function).
with-check-length (macro).
zero-length-p (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Collect things into a list forwards. Within the body of this macro, the COLLECT function will collect its argument into the list returned by COLLECTING.
Collect some things into lists forwards. The names in COLLECTORS are defined as local functions which each collect into a separate list. Returns as many values as there are collectors, in the order they were given.
Synonym for WITH-UNIQUE-NAMES, but BINDINGS should only consist of atoms; lists are not supported. If you try to give list bindings, a LIST-BINDING-NOT-SUPPORTED warning will be signalled, but it will work the same way as WITH-UNIQUE-NAMES. Don’t do it, though.
Executes a series of forms with each var bound to a fresh, uninterned symbol. See http://www.cliki.net/WITH-UNIQUE-NAMES
Collect THING in the context established by the COLLECTING macro
Compose FUNCTIONS right-associatively, returning a function
Shallow copies the contents of any array into another array with equivalent properties. If array is displaced, then this function will normally create another displaced array with similar properties, unless UNDISPLACE is non-NIL, in which case the contents of the array will be copied into a completely new, not displaced, array.
As (mod (expt n exponent) modulus), but more efficient.
Returns the element of SEQUENCE that would appear first if the sequence were ordered according to SORT using PREDICATE and KEY using an unstable sorting algorithm. See http://www.cliki.net/EXTREMUM for the full specification.
EXTREMUM implemented so that it calls KEY less. This is only faster if the KEY function is so slow that calling it less often would be a significant improvement; ordinarily it’s slower.
Returns a list of the N elements of SEQUENCE that would appear first if the sequence were ordered according to SORT using PREDICATE and KEY with a stable sorting algorithm. If there are less than N elements in the relevant part of the sequence, this will return all the elements it can and signal the warning N-MOST-EXTREME-NOT-ENOUGH-ELEMENTS
Rotates a field of bits within INTEGER; specifically, returns an integer that contains the bits of INTEGER rotated COUNT times leftwards within the byte specified by BYTESPEC, and elsewhere contains the bits of INTEGER. See http://www.cliki.net/ROTATE-BYTE
Return a list of subsequences in seq delimited by delimiter.
If :remove-empty-subseqs is NIL, empty subsequences will be included in the result; otherwise they will be discarded. All other keywords work analogously to those for CL:SUBSTITUTE. In particular, the behaviour of :from-end is possibly different from other versions of this function; :from-end values of NIL and T are equivalent unless :count is supplied. The second return value is an index suitable as an argument to CL:SUBSEQ into the sequence indicating where processing stopped.
Return a list of subsequences in seq delimited by items satisfying
predicate.
If :remove-empty-subseqs is NIL, empty subsequences will be included in the result; otherwise they will be discarded. All other keywords work analogously to those for CL:SUBSTITUTE-IF. In particular, the behaviour of :from-end is possibly different from other versions of this function; :from-end values of NIL and T are equivalent unless :count is supplied. The second return value is an index suitable as an argument to CL:SUBSEQ into the sequence indicating where processing stopped.
Return a list of subsequences in seq delimited by items satisfying
(CL:COMPLEMENT predicate).
If :remove-empty-subseqs is NIL, empty subsequences will be included in the result; otherwise they will be discarded. All other keywords work analogously to those for CL:SUBSTITUTE-IF-NOT. In particular, the behaviour of :from-end is possibly different from other versions of this function; :from-end values of NIL and T are equivalent unless :count is supplied. The second return value is an index suitable as an argument to CL:SUBSEQ into the sequence indicating where processing stopped.
list-binding-not-supported)) ¶n-most-extreme-not-enough-elements)) ¶n.
n-most-extreme-not-enough-elements)) ¶read-delimited-bounds-error)) ¶end.
read-delimited-bounds-error)) ¶read-delimited-bounds-error)) ¶List bindings aren’t supported by WITH-GENSYMS, and
if you want to use them you should use WITH-UNIQUE-NAMES instead. That
said, they will work; they’ll just signal this warning to complain
about it.
warning.
:binding
This slot is read-only.
There are not enough elements in the sequence given to N-MOST-EXTREME to return the N most extreme elements.
warning.
The number of elements that need to be returned
:n
This slot is read-only.
The subsequence from which elements
must be taken. This is determined by the sequence and the :start and
:end arguments to N-MOST-EXTREME.
:subsequence
This slot is read-only.
Raised when EXTREMUM is called on an empty sequence, since there is no morally smallest element
error.
There’s a problem with the indices START and END
for SEQUENCE. See CLHS SUBSEQ-OUT-OF-BOUNDS:IS-AN-ERROR issue.
error.
:start
This slot is read-only.
:end
This slot is read-only.
common-lisp.
:sequence
This slot is read-only.
Check that all of the NAMES are symbols. If not, raise an error.
Make an array with the same properties (size, adjustability, etc.) as another array, optionally undisplacing the array.
Check to make sure START and END are in bounds when calling READ-DELIMITED with SEQUENCE
Check to make sure END is in bounds when calling READ-DELIMITED with SEQUENCE
Check the order of START and END bounds, and return them in the correct order.
Check to make sure START is in bounds when calling READ-DELIMITED with SEQUENCE
Check that all of the COLLECTORS are symbols. If not, raise an error.
Return an alist mapping the symbols in COLLECTORS to gensyms
Return (values var prefix) from a WITH-UNIQUE-NAMES binding form. If PREFIX is not given in the binding, NIL is returned to indicate that the default should be used.
Comparison operator: auxilliary function used by EXTREMUM
Is the length of SEQUENCE equal to zero?
| Jump to: | %
C E F G L M N O P R S W Z |
|---|
| Jump to: | %
C E F G L M N O P R S W Z |
|---|
| Jump to: | B E N S |
|---|
| Jump to: | B E N S |
|---|
| Jump to: | C E F L N O P R S W |
|---|
| Jump to: | C E F L N O P R S W |
|---|