This is the collectors Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:05:15 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
collectorsA library providing various collector type macros
pulled from arnesi into its own library and stripped of dependencies
Russ Tyndall <russ@acceleration.net>
Marco Baringer, Russ Tyndall <russ@acceleration.net>
BSD
1.0
alexandria (system).
closer-mop (system).
symbol-munger (system).
collectors.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
collectors/collectors.lispcollectors (system).
after-values (reader method).
(setf after-values) (writer method).
aggregate (reader method).
(setf aggregate) (writer method).
aggregating (condition).
aggregator (reader method).
aggregator (reader method).
(setf aggregator) (writer method).
(setf aggregator) (writer method).
append-at-end (macro).
appending (macro).
collect-at-end (macro).
collecting (macro).
deoperate (generic function).
done-aggregating (condition).
initialize-instance (method).
initialize-instance (method).
initialize-instance (method).
make-appender (function).
make-collector (function).
make-formatter (function).
make-pusher (function).
make-reducer (function).
make-simple-appender (function).
make-simple-appender-to-place (macro).
make-simple-collector (function).
make-simple-collector-to-place (macro).
make-string-builder (function).
operate (generic function).
value (reader method).
value (reader method).
(setf value) (writer method).
(setf value) (writer method).
with-alist-output (macro).
with-appender (macro).
with-appender-output (macro).
with-collector (macro).
with-collector-output (macro).
with-collectors (macro).
with-formatter (macro).
with-formatter-output (macro).
with-mapping-appender (macro).
with-mapping-collector (macro).
with-reducer (macro).
with-string-builder (macro).
with-string-builder-output (macro).
%enqueue (method).
%enqueue (method).
%pop-n (method).
%push (method).
%unenqueue-n (method).
append-at-end-with-signals (macro).
appender (class).
collect-at-end-with-signals (macro).
collect-nil? (reader method).
(setf collect-nil?) (writer method).
collector (class).
delimiter (reader method).
(setf delimiter) (writer method).
has-written? (reader method).
(setf has-written?) (writer method).
ignore-empty-strings-and-nil? (reader method).
(setf ignore-empty-strings-and-nil?) (writer method).
initial-value (reader method).
(setf initial-value) (writer method).
list-aggregator (class).
map-aggregation (macro).
mapping-aggregation-context (function).
new-only-key (reader method).
(setf new-only-key) (writer method).
new-only-test (reader method).
(setf new-only-test) (writer method).
operation (reader method).
(setf operation) (writer method).
output-stream (reader method).
(setf output-stream) (writer method).
place-setter (reader method).
(setf place-setter) (writer method).
pretty? (reader method).
(setf pretty?) (writer method).
pusher (class).
reducer (class).
should-aggregate? (generic function).
string-builder (class).
string-formatter (class).
tail (reader method).
(setf tail) (writer method).
value-aggregator (class).
with-alist (macro).
with-signal-context (macro).
Packages are listed by definition order.
collectorscollectors-signals.
common-lisp.
common-lisp-user.
append-at-end (macro).
appending (macro).
collect-at-end (macro).
collecting (macro).
deoperate (generic function).
make-appender (function).
make-collector (function).
make-formatter (function).
make-pusher (function).
make-reducer (function).
make-simple-appender (function).
make-simple-appender-to-place (macro).
make-simple-collector (function).
make-simple-collector-to-place (macro).
make-string-builder (function).
operate (generic function).
with-alist-output (macro).
with-appender (macro).
with-appender-output (macro).
with-collector (macro).
with-collector-output (macro).
with-collectors (macro).
with-formatter (macro).
with-formatter-output (macro).
with-mapping-appender (macro).
with-mapping-collector (macro).
with-reducer (macro).
with-string-builder (macro).
with-string-builder-output (macro).
%enqueue (generic function).
%pop-n (generic function).
%push (generic function).
%unenqueue-n (generic function).
append-at-end-with-signals (macro).
appender (class).
collect-at-end-with-signals (macro).
collect-nil? (generic reader).
(setf collect-nil?) (generic writer).
collector (class).
delimiter (generic reader).
(setf delimiter) (generic writer).
has-written? (generic reader).
(setf has-written?) (generic writer).
ignore-empty-strings-and-nil? (generic reader).
(setf ignore-empty-strings-and-nil?) (generic writer).
initial-value (generic reader).
(setf initial-value) (generic writer).
list-aggregator (class).
map-aggregation (macro).
mapping-aggregation-context (function).
new-only-key (generic reader).
(setf new-only-key) (generic writer).
new-only-test (generic reader).
(setf new-only-test) (generic writer).
operation (generic reader).
(setf operation) (generic writer).
output-stream (generic reader).
(setf output-stream) (generic writer).
place-setter (generic reader).
(setf place-setter) (generic writer).
pretty? (generic reader).
(setf pretty?) (generic writer).
pusher (class).
reducer (class).
should-aggregate? (generic function).
string-builder (class).
string-formatter (class).
tail (generic reader).
(setf tail) (generic writer).
value-aggregator (class).
with-alist (macro).
with-signal-context (macro).
collectors-signalsafter-values (generic reader).
(setf after-values) (generic writer).
aggregate (generic reader).
(setf aggregate) (generic writer).
aggregating (condition).
aggregator (generic reader).
(setf aggregator) (generic writer).
done-aggregating (condition).
value (slot).
value (generic reader).
(setf value) (generic writer).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Macros to ease efficient collection (with appending) at the end of a list
A mapping collecting macro for operating on elements of a list (similar to (mapcan (lambda (,arg) ,@body) list), but using a collector so all signals are in place)
Macros to ease efficient collection at the end of a list
A mapping collecting macro for operating on elements of a list (similar to (mapcar (lambda (,arg) ,@body) list), but using a collector so all signals are in place)
A fastest possible, fewest frills collector suitable to places where efficiency matters that appends any values that re lists
Bind NAME to a collector function and execute BODY. If
FROM-END is true the collector will actually be a pusher, (see
MAKE-PUSHER), otherwise NAME will be bound to a collector,
(see MAKE-COLLECTOR).
(with-appender (app)
(app ’(1 2))
(app ’(2 3))
(app ’(3 4))
(app)) => (1 2 2 3 3 4)
Same as with-appender, but this form returns the collected values
automatically
Bind NAME to a collector function and execute BODY. If
FROM-END is true the collector will actually be a pusher, (see
MAKE-PUSHER), otherwise NAME will be bound to a collector,
(see MAKE-COLLECTOR).
(with-collector (col)
(col 1)
(col 2)
(col 3)
(col)) => (1 2 3)
Bind multiple collectors. Each element of NAMES should be a list as per WITH-COLLECTOR’s first orgument.
A macro makes a function with name for body that is a string formatter see make-formatter
A macro makes a function with name for body that is a string formatter
see make-formatter.
This form returns the result of that formatter
Like a with-appender, but instead of a name we take a function spec
calling the function will appen
(with-mapping-appender (app (l) (mapcar #’(lambda (x) (* 2 x)) l))
(app ’(1 2))
(app ’(2 3))
(app ’(3 4))
(app)) => (2 4 4 6 6 8)
Like a with-collector, but instead of a name we take a function spec
if you call the resultant function with no arguments, you get the
collection so far
if you call it with arguments the results of calling your function spec are
collected
(with-mapping-collector (col (x) (* 2 x))
(col 1)
(col 2)
(col 3)
(col)) => (2 4 6)
Locally bind NAME to a reducing function. The arguments FUNCTION and INITIAL-VALUE are passed directly to MAKE-REDUCER.
A macro that creates a string builder with name in scope during the duration of the env
A macro that creates a string builder with name in scope during the duration of the env, the form returns the string that is built
Create a string formatter collector function.
creates a (lambda &optional format-string &rest args) and collects these in a list
When called with no args, returns the concatenated (with delimiter) results
binds *print-pretty* to nil
A fastest possible, fewest frills collector suitable to places where efficiency matters that appends any values that re lists
A fastest possible, fewest frills collector suitable to places where efficiency matters
done-aggregating)) ¶done-aggregating)) ¶done-aggregating)) ¶done-aggregating)) ¶done-aggregating)) ¶done-aggregating)) ¶aggregating)) ¶aggregating)) ¶Undo the aggregation operation of an aggregator and list of values
list-aggregator) to-remove &key test key) ¶value-aggregator) values &key test key) ¶Perform the aggregation operation on the aggregator for the values
string-builder) values) ¶string-formatter) values) ¶value-aggregator) values) ¶value-aggregator)) ¶automatically generated reader method
aggregating)) ¶value-aggregator)) ¶automatically generated writer method
aggregating)) ¶string-formatter) &key &allow-other-keys) ¶value-aggregator) &key &allow-other-keys) ¶condition.
(quote nil)
:after-values
(quote nil)
:aggregate
(quote nil)
:aggregator
Macros to ease efficient collection (with appending) at the end of a list
Macros to ease efficient collection at the end of a list
list-aggregator) values) ¶list-aggregator) &optional n) ¶list-aggregator) values) ¶list-aggregator) &optional n) ¶list-aggregator)) ¶list-aggregator)) ¶Should we collect nil into our results
string-formatter)) ¶automatically generated reader method
string-formatter)) ¶automatically generated writer method
string-formatter)) ¶automatically generated reader method
string-formatter)) ¶automatically generated writer method
string-builder)) ¶automatically generated reader method
string-builder)) ¶automatically generated writer method
value-aggregator)) ¶automatically generated reader method
value-aggregator)) ¶automatically generated writer method
list-aggregator)) ¶automatically generated reader method
list-aggregator)) ¶automatically generated writer method
list-aggregator)) ¶list-aggregator)) ¶If supplied with a new-only-test, we will verify that we
have not already collected this item before collecting again
string-formatter)) ¶automatically generated reader method
string-formatter)) ¶automatically generated writer method
value-aggregator)) ¶automatically generated reader method
value-aggregator)) ¶automatically generated writer method
string-formatter)) ¶automatically generated reader method
string-formatter)) ¶automatically generated writer method
Should we aggregate a given value into our collection
string-builder) v) ¶list-aggregator) v) ¶value-aggregator) v) ¶Create an appender function.
An Appender will append any arguments into a list, all the values passed to it in the order in which they were passed. If the appender function is called without arguments it returns the current list of values.
Create a collector function.
A Collector function will collect, into a list, all the values
passed to it in the order in which they were passed. If the
callector function is called without arguments it returns the
current list of values.
Should we collect nil into our results
t
:collect-nil?
If supplied with a new-only-test, we will verify that we
have not already collected this item before collecting again
:new-only-test
:new-only-key
Create a function which, starting with INITIAL-VALUE, reduces
any other values into a single final value.
OPERATION will be called with two values: the current value and
the new value, in that order. OPERATION should return exactly one
value.
The reducing function can be called with n arguments which will
be applied to OPERATION one after the other (left to right) and
will return the new value.
If the reducing function is called with no arguments it will
return the current value.
Example:
(setf r (make-reducer #’+ 5))
(funcall r 0) => 5
(funcall r 1 2) => 8
(funcall r) => 8
:operation
Create a function that will build up a string for you
Each call to the function with arguments appends those arguments to the string
with an optional delimiter between them.
if ignore-empty-strings-and-nil is true neither empty strings nor nil will be
printed to the stream
A call to the function with no arguments returns the output string
t
:ignore-empty-strings-and-nil?
Create a string formatter collector function.
creates a (lambda &optional format-string &rest args) and collects these in a list
When called with no args, returns the concatenated (with delimiter) results
binds *print-pretty* to nil
:delimiter
:has-written?
:output-stream
:pretty?
| Jump to: | %
(
A C D F G H I M N O P S T V W |
|---|
| Jump to: | %
(
A C D F G H I M N O P S T V W |
|---|
| Jump to: | A C D H I N O P S T V |
|---|
| Jump to: | A C D H I N O P S T V |
|---|
| Jump to: | A C D F L P R S V |
|---|
| Jump to: | A C D F L P R S V |
|---|