This is the vellum Reference Manual, version 1.3.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 07:03:17 2024 GMT+0.
vellum/vellum.asdvellum/aux-package.lispvellum/column/package.lispvellum/column/protocol.lispvellum/column/types.lispvellum/column/conditions.lispvellum/column/docstring.lispvellum/column/internal.lispvellum/column/implementation.lispvellum/header/package.lispvellum/header/variables.lispvellum/header/types.lispvellum/header/macros.lispvellum/header/protocol.lispvellum/header/utils.lispvellum/header/functions.lispvellum/header/conditions.lispvellum/header/internal.lispvellum/header/implementation.lispvellum/header/documentation.lispvellum/selection/package.lispvellum/selection/implementation.lispvellum/table/package.lispvellum/table/variables.lispvellum/table/macros.lispvellum/table/generics.lispvellum/table/types.lispvellum/table/conditions.lispvellum/table/functions.lispvellum/table/documentation.lispvellum/table/to-table.lispvellum/table/internal.lispvellum/table/implementation.lispvellum/api/package.lispvellum/api/macros.lispvellum/api/conditions.lispvellum/api/generics.lispvellum/api/functions.lispvellum/api/docstrings.lispvellum/integration/package.lispvellum/integration/cl-ds.lispThe main system appears first, followed by any subsystem dependency.
vellumData Frames for Common Lisp
Marek Kochanowicz
BSD simplified
1.3.4
iterate (system).
serapeum (system).
lparallel (system).
closer-mop (system).
metabang-bind (system).
alexandria (system).
agnostic-lizard (system).
cl-data-structures (system)., at least version ((>= "1.4.0"))
documentation-utils-extensions (system).
aux-package.lisp (file).
column (module).
header (module).
selection (module).
table (module).
api (module).
integration (module).
Modules are listed depth-first from the system components tree.
vellum/columnaux-package.lisp (file).
vellum (system).
package.lisp (file).
protocol.lisp (file).
types.lisp (file).
conditions.lisp (file).
docstring.lisp (file).
internal.lisp (file).
implementation.lisp (file).
vellum/headercolumn (module).
vellum (system).
package.lisp (file).
variables.lisp (file).
types.lisp (file).
macros.lisp (file).
protocol.lisp (file).
utils.lisp (file).
functions.lisp (file).
conditions.lisp (file).
internal.lisp (file).
implementation.lisp (file).
documentation.lisp (file).
vellum/selectionheader (module).
vellum (system).
package.lisp (file).
implementation.lisp (file).
vellum/tableselection (module).
vellum (system).
package.lisp (file).
variables.lisp (file).
macros.lisp (file).
generics.lisp (file).
types.lisp (file).
conditions.lisp (file).
functions.lisp (file).
documentation.lisp (file).
to-table.lisp (file).
internal.lisp (file).
implementation.lisp (file).
vellum/apitable (module).
vellum (system).
package.lisp (file).
macros.lisp (file).
conditions.lisp (file).
generics.lisp (file).
functions.lisp (file).
docstrings.lisp (file).
vellum/integrationapi (module).
vellum (system).
package.lisp (file).
cl-ds.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
vellum/vellum.asdvellum/aux-package.lispvellum/column/package.lispvellum/column/protocol.lispvellum/column/types.lispvellum/column/conditions.lispvellum/column/docstring.lispvellum/column/internal.lispvellum/column/implementation.lispvellum/header/package.lispvellum/header/variables.lispvellum/header/types.lispvellum/header/macros.lispvellum/header/protocol.lispvellum/header/utils.lispvellum/header/functions.lispvellum/header/conditions.lispvellum/header/internal.lispvellum/header/implementation.lispvellum/header/documentation.lispvellum/selection/package.lispvellum/selection/implementation.lispvellum/table/package.lispvellum/table/variables.lispvellum/table/macros.lispvellum/table/generics.lispvellum/table/types.lispvellum/table/conditions.lispvellum/table/functions.lispvellum/table/documentation.lispvellum/table/to-table.lispvellum/table/internal.lispvellum/table/implementation.lispvellum/api/package.lispvellum/api/macros.lispvellum/api/conditions.lispvellum/api/generics.lispvellum/api/functions.lispvellum/api/docstrings.lispvellum/integration/package.lispvellum/integration/cl-ds.lispvellum/column/protocol.lispcolumn (module).
augment-iterator (generic function).
column-at (generic function).
(setf column-at) (generic function).
column-size (generic function).
column-type (generic function).
finish-iterator (generic function).
make-iterator (generic function).
remove-nulls (generic function).
truncate-to-length (generic function).
vellum/column/types.lispcolumn (module).
cloning-information (method).
columns (function).
fundamental-column (class).
index (function).
make-sparse-material-column (function).
sparse-material-column (class).
sparse-material-column-iterator-index (reader).
(setf sparse-material-column-iterator-index) (writer).
access-index (function).
(setf access-index) (function).
copy-sparse-material-column-iterator (function).
iterator-buffer (type).
iterator-change (type).
iterator-stack (type).
make-sparse-material-column-iterator (function).
read-buffers (function).
read-changes (function).
read-column-types (function).
read-columns (function).
read-depths (function).
read-indexes (function).
read-initial-index (function).
read-initialization-status (function).
read-stacks (function).
read-touched (function).
read-transformation (function).
sparse-material-column-iterator (structure).
sparse-material-column-iterator-buffers (reader).
(setf sparse-material-column-iterator-buffers) (writer).
sparse-material-column-iterator-changes (reader).
(setf sparse-material-column-iterator-changes) (writer).
sparse-material-column-iterator-column-types (reader).
(setf sparse-material-column-iterator-column-types) (writer).
sparse-material-column-iterator-columns (reader).
(setf sparse-material-column-iterator-columns) (writer).
sparse-material-column-iterator-depths (reader).
(setf sparse-material-column-iterator-depths) (writer).
sparse-material-column-iterator-indexes (reader).
(setf sparse-material-column-iterator-indexes) (writer).
sparse-material-column-iterator-initial-index (reader).
(setf sparse-material-column-iterator-initial-index) (writer).
sparse-material-column-iterator-initialization-status (reader).
(setf sparse-material-column-iterator-initialization-status) (writer).
sparse-material-column-iterator-p (function).
sparse-material-column-iterator-stacks (reader).
(setf sparse-material-column-iterator-stacks) (writer).
sparse-material-column-iterator-touched (reader).
(setf sparse-material-column-iterator-touched) (writer).
sparse-material-column-iterator-transformation (reader).
(setf sparse-material-column-iterator-transformation) (writer).
vellum/column/conditions.lispcolumn (module).
column-type-error (condition).
column-error (condition).
column-type-error-column (reader method).
column-type-error-column (reader method).
index-out-of-column-bounds (condition).
iterator-error (condition).
no-such-column (condition).
setting-to-null (condition).
vellum/column/internal.lispcolumn (module).
access-iterator (reader method).
(setf access-iterator) (writer method).
access-position (reader method).
(setf access-position) (writer method).
build-new-mask (function).
calculate-depth (function).
change-leaf (function).
change-leafs (function).
child-index (function).
children (function).
clear-buffers (function).
clear-changed-parents-masks (function).
clear-changes (function).
clear-masks (function).
column-root (function).
concatenate-masks (function).
concatenate-trees (function).
concatenation-state (function).
concatenation-state (structure).
concatenation-state-changed-parents (reader).
(setf concatenation-state-changed-parents) (writer).
concatenation-state-columns (reader).
(setf concatenation-state-columns) (writer).
concatenation-state-iterator (reader).
(setf concatenation-state-iterator) (writer).
concatenation-state-masks (reader).
(setf concatenation-state-masks) (writer).
concatenation-state-masks-logcount (function).
concatenation-state-max-index (reader).
(setf concatenation-state-max-index) (writer).
concatenation-state-nodes (reader).
(setf concatenation-state-nodes) (writer).
concatenation-state-nodes-logcount (function).
concatenation-state-p (function).
concatenation-state-parents (reader).
(setf concatenation-state-parents) (writer).
copy-concatenation-state (function).
copy-on-write-node (function).
distinct-missing (function).
fill-buffer (function).
fill-buffers (function).
find-max-index (function).
free-space (function).
gather-masks (function).
index-promoted (function).
initialize-iterator-column (function).
initialize-iterator-columns (function).
logior-mask (function).
make-concatenation-state (function).
make-leaf (function).
make-node (function).
mask (function).
(setf mask) (function).
mask-bytes (symbol macro).
max-index (function).
move-children (function).
move-children-in-column (function).
move-children-in-columns (function).
move-column-to (function).
move-stack (function).
move-to-existing-column (function).
move/pad-stack (function).
mutate-leaf (function).
node (function).
(setf node) (function).
occupied-space (function).
offset (function).
pad-stack (function).
parent-changed (function).
(setf parent-changed) (function).
parent-index (function).
range-iterator (function).
read-column (reader method).
read-initial-position (reader method).
reduce-stack (function).
reduce-stacks (function).
shift-content (function).
sparse-material-column-at (function).
(setf sparse-material-column-at) (function).
sparse-material-column-range (class).
tree-index (function).
trim-depth (function).
trim-depth-in-column (function).
truncate-mask (function).
update-parents (function).
with-concatenation-state (macro).
vellum/column/implementation.lispcolumn (module).
across (method).
augment-iterator (method).
clone (method).
clone (method).
column-at (method).
(setf column-at) (method).
column-size (method).
column-type (method).
consume-front (method).
drop-front (method).
finish-iterator (method).
insert-tail (function).
iterator-at (function).
(setf iterator-at) (function).
make-iterator (method).
move-iterator (function).
move-iterator-to (function).
peek-front (method).
position-modification (method).
position-modification (method).
remove-nulls (method).
reset! (method).
reset! (method).
traverse (method).
truncate-to-length (method).
untouch (function).
whole-range (method).
in-existing-content (method).
into-vector-copy (function).
make-sparse-material-column-range (function).
vellum/header/types.lispheader (module).
cloning-information (method).
cloning-information (method).
column-signature (structure).
frame-range-mixin (class).
read-header (reader method).
read-name (function).
standard-header (structure).
write-header (writer method).
column-signature-name (reader).
(setf column-signature-name) (writer).
column-signature-p (function).
column-signature-type (reader).
(setf column-signature-type) (writer).
copy-column-signature (function).
copy-standard-header (function).
make-column-signature-impl (function).
make-standard-header (function).
read-column-names (function).
read-column-signatures (function).
read-type (function).
standard-header-column-names (reader).
(setf standard-header-column-names) (writer).
standard-header-column-signatures (reader).
(setf standard-header-column-signatures) (writer).
standard-header-p (function).
vellum/header/macros.lispheader (module).
with-header (macro).
vellum/header/protocol.lispheader (module).
alter-columns (generic function).
check-column-signatures-compatibility (generic function).
column-count (generic function).
column-specs (generic function).
concatenate-headers (generic function).
make-row (generic function).
select-columns (generic function).
column-signature-spec (generic function).
vellum/header/functions.lispheader (module).
column-names (function).
column-signature (function).
column-type (function).
ensure-index (function).
header (function).
index-to-name (function).
make-header (function).
name-to-index (function).
read-new-value (function).
row (function).
set-row (function).
make-column-signature (function).
validate-active-header (function).
validate-active-row (function).
vellum/header/conditions.lispheader (module).
headers-incompatible (condition).
invalid-input-for-row (condition).
invalid-name (condition).
name-duplicated (condition).
no-column (condition).
no-header (condition).
unable-to-construct-row (condition).
no-row (condition).
vellum/header/internal.lispheader (module).
extracting-signature (function).
make-signature (function).
unique-names (function).
vellum/header/implementation.lispheader (module).
alter-columns (method).
check-column-signatures-compatibility (method).
column-count (method).
column-specs (method).
concatenate-headers (method).
consume-front (method).
make-row (method).
make-row (method).
make-row (method).
peek-front (method).
select-columns (method).
column-signature-spec (method).
validate-row (function).
vellum/selection/implementation.lispselection (module).
address-range (generic function).
between (function).
between (class).
content (generic function).
content (class).
name-when-selecting-row (condition).
rs (function).
s (function).
s-list (function).
selector (class).
read-callback (reader method).
read-from (reader method).
read-to (reader method).
vellum/table/variables.lisptable (module).
*current-row* (special variable).
*enable-restarts* (special variable).
*table* (special variable).
*transform-control* (special variable).
*transform-in-place* (special variable).
*wrap-errors* (special variable).
vellum/table/macros.lisptable (module).
aggregate (macro).
aggregated-value (macro).
bind-row (macro).
brr (macro).
distinct (macro).
group-by (macro).
with-table (macro).
aggregation-column-names (reader method).
aggregation-column-names (reader method).
aggregation-results (class).
aggregators (reader method).
aggregators (reader method).
group-by-aggregation-results (class).
group-names (reader method).
proxy-aggregator (function).
proxy-aggregator* (generic function).
rewrite-bind-row-form (function).
rewrite-bind-row-form-pass-1 (function).
rewrite-bind-row-form-pass-2 (function).
vellum/table/generics.lisptable (module).
alter-columns (generic function).
at (generic function).
(setf at) (generic function).
bind-row-closure (generic function).
column-at (generic function).
column-count (generic function).
column-name (generic function).
column-type (generic function).
erase! (generic function).
header (generic reader).
hstack* (generic function).
iterator (generic function).
make-table* (generic function).
remove-nulls (generic function).
row-count (generic function).
select (generic function).
show (generic function).
transform (generic function).
transform-row (generic function).
transformation (generic function).
transformation-result (generic function).
vmask (generic function).
vstack* (generic function).
read-iterator (generic function).
row-erase (generic function).
vellum/table/types.lisptable (module).
bind-row (class).
cloning-information (method).
cloning-information (method).
fundamental-table (class).
header (reader method).
header (reader method).
make-setfable-table-row (function).
make-table-row (function).
setfable-table-row (structure).
standard-table (class).
standard-table-range (class).
standard-transformation-row (reader).
(setf standard-transformation-row) (writer).
copy-setfable-table-row (function).
copy-standard-transformation (function).
copy-table-row (function).
make-standard-transformation (function).
optimized-closure (reader method).
read-columns (reader method).
read-header (reader method).
read-row-count (reader method).
read-table-row (reader method).
setfable-table-row-iterator (function).
(setf setfable-table-row-iterator) (function).
setfable-table-row-p (function).
standard-transformation (structure).
standard-transformation-aggregation-results (reader).
(setf standard-transformation-aggregation-results) (writer).
standard-transformation-bind-row-closure (reader).
(setf standard-transformation-bind-row-closure) (writer).
standard-transformation-column-count (reader).
(setf standard-transformation-column-count) (writer).
standard-transformation-columns (reader).
(setf standard-transformation-columns) (writer).
standard-transformation-count (reader).
(setf standard-transformation-count) (writer).
standard-transformation-dropped (reader).
(setf standard-transformation-dropped) (writer).
standard-transformation-enable-restarts (reader).
(setf standard-transformation-enable-restarts) (writer).
standard-transformation-in-place (reader).
(setf standard-transformation-in-place) (writer).
standard-transformation-iterator (reader).
(setf standard-transformation-iterator) (writer).
standard-transformation-marker-column (reader).
(setf standard-transformation-marker-column) (writer).
standard-transformation-p (function).
standard-transformation-start (reader).
(setf standard-transformation-start) (writer).
standard-transformation-table (reader).
(setf standard-transformation-table) (writer).
standard-transformation-wrap-errors (reader).
(setf standard-transformation-wrap-errors) (writer).
table-row (structure).
table-row-iterator (reader).
(setf table-row-iterator) (writer).
table-row-p (function).
write-columns (writer method).
vellum/table/conditions.lisptable (module).
aggregation-prohibited-and-found (condition).
aggregation-required-and-not-found (condition).
no-transformation (condition).
transformation-error (condition).
vellum/table/functions.lisptable (module).
aggregator-constructor (method).
aggregator-constructor (method).
column-names (function).
current-row-as-vector (function).
drop-row (function).
finish-transformation (function).
hstack (function).
make-table (function).
nullify (function).
row-at (function).
(setf row-at) (function).
row-to-list (function).
row-to-vector (function).
rr (function).
(setf rr) (function).
to-table (generic function).
vstack (function).
make-bind-row (function).
to-table-function (class).
vs (function).
vellum/table/internal.lisptable (module).
column-transformation-closure (function).
ensure-replicas (function).
make-iterator (function).
remove-nulls-from-columns (function).
select-columns (function).
select-rows (function).
table-from-header (function).
transform-row-impl (function).
vellum/table/implementation.lisptable (module).
across (method).
across (method).
alter-columns (method).
apply-range-function (method).
apply-range-function (method).
at (method).
(setf at) (method).
become-transactional (method).
bind-row-closure (method).
bind-row-closure (method).
bind-row-closure (method).
bind-row-closure (method).
clone (method).
column-at (method).
column-at (method).
column-count (method).
column-name (method).
column-type (method).
consume-front (method).
drop-front (method).
erase! (method).
hstack* (method).
iterator (method).
make-table* (method).
peek-front (method).
print-object (method).
remove-nulls (method).
replica (method).
reset! (method).
row-count (method).
select (method).
show (method).
transform (method).
transform-row (method).
transformation (method).
transformation-result (method).
traverse (method).
traverse (method).
traverse (method).
vmask (method).
vstack* (method).
whole-range (method).
aggregation-results->table (generic function).
read-iterator (method).
vellum/api/macros.lispapi (module).
aggregate-columns (macro).
aggregate-rows (macro).
drop-row-when (macro).
every-null-column-p (symbol macro).
pipeline (macro).
some-null-column-p (symbol macro).
with-standard-header (macro).
vellum/api/conditions.lispapi (module).
file-input-row-cant-be-created (condition).
row-cant-be-created (condition).
vellum/api/functions.lispapi (module).
%aggregate-columns (function).
%aggregate-rows (function).
add-columns (function).
column-list (function).
empty-column (function).
every-null-column-p* (function).
find-row (function).
found-row (macro).
join (method).
join (method).
order-by (function).
rename-columns (function).
s-list (function).
some-null-column-p* (function).
to-matrix (function).
unnest (function).
cartesian-product (function).
collect-column-specs (function).
column-name= (function).
hash-join-implementation (function).
vellum/integration/cl-ds.lispintegration (module).
common-to-table (function).
fill-columns-buffer-impl (generic function).
gather-column-data (generic function).
Packages are listed by definition order.
vellum.integrationvellum.selectionvellum.tablevellumvellum.headervellum.columnvellum.aux-packagevellum.integrationvellum.int
common-lisp.
vellum.aux-package.
common-to-table (function).
fill-columns-buffer-impl (generic function).
gather-column-data (generic function).
vellum.selectioncommon-lisp.
vellum.aux-package.
address-range (generic function).
between (function).
between (class).
content (generic function).
content (class).
name-when-selecting-row (condition).
rs (function).
s (function).
s-list (function).
selector (class).
read-callback (generic reader).
read-from (generic reader).
read-to (generic reader).
vellum.tablecommon-lisp.
vellum.aux-package.
*current-row* (special variable).
*enable-restarts* (special variable).
*table* (special variable).
*transform-control* (special variable).
*transform-in-place* (special variable).
*wrap-errors* (special variable).
aggregate (macro).
aggregated-value (macro).
aggregation-prohibited-and-found (condition).
aggregation-required-and-not-found (condition).
alter-columns (generic function).
at (generic function).
(setf at) (generic function).
bind-row (macro).
bind-row (class).
bind-row-closure (generic function).
brr (macro).
column-at (generic function).
column-count (generic function).
column-name (generic function).
column-names (function).
column-type (generic function).
current-row-as-vector (function).
distinct (macro).
drop-row (function).
erase! (generic function).
finish-transformation (function).
fundamental-table (class).
group-by (macro).
header (generic reader).
hstack (function).
hstack* (generic function).
iterator (generic function).
make-setfable-table-row (function).
make-table (function).
make-table* (generic function).
make-table-row (function).
no-transformation (condition).
nullify (function).
remove-nulls (generic function).
row-at (function).
(setf row-at) (function).
row-count (generic function).
row-to-list (function).
row-to-vector (function).
rr (function).
(setf rr) (function).
select (generic function).
setfable-table-row (structure).
show (generic function).
standard-table (class).
standard-table-range (class).
standard-transformation-row (reader).
(setf standard-transformation-row) (writer).
to-table (generic function).
transform (generic function).
transform-row (generic function).
transformation (generic function).
transformation-error (condition).
transformation-result (generic function).
vmask (generic function).
vstack (function).
vstack* (generic function).
with-table (macro).
aggregation-column-names (generic reader).
aggregation-results (class).
aggregation-results->table (generic function).
aggregators (generic reader).
column-transformation-closure (function).
copy-setfable-table-row (function).
copy-standard-transformation (function).
copy-table-row (function).
ensure-replicas (function).
group-by-aggregation-results (class).
group-names (generic reader).
make-bind-row (function).
make-iterator (function).
make-standard-transformation (function).
optimized-closure (generic reader).
proxy-aggregator (function).
proxy-aggregator* (generic function).
read-columns (generic reader).
read-header (generic reader).
read-iterator (generic function).
read-row-count (generic reader).
read-table-row (generic reader).
remove-nulls-from-columns (function).
rewrite-bind-row-form (function).
rewrite-bind-row-form-pass-1 (function).
rewrite-bind-row-form-pass-2 (function).
row-erase (generic function).
select-columns (function).
select-rows (function).
setfable-table-row-iterator (function).
(setf setfable-table-row-iterator) (function).
setfable-table-row-p (function).
standard-transformation (structure).
standard-transformation-aggregation-results (reader).
(setf standard-transformation-aggregation-results) (writer).
standard-transformation-bind-row-closure (reader).
(setf standard-transformation-bind-row-closure) (writer).
standard-transformation-column-count (reader).
(setf standard-transformation-column-count) (writer).
standard-transformation-columns (reader).
(setf standard-transformation-columns) (writer).
standard-transformation-count (reader).
(setf standard-transformation-count) (writer).
standard-transformation-dropped (reader).
(setf standard-transformation-dropped) (writer).
standard-transformation-enable-restarts (reader).
(setf standard-transformation-enable-restarts) (writer).
standard-transformation-in-place (reader).
(setf standard-transformation-in-place) (writer).
standard-transformation-iterator (reader).
(setf standard-transformation-iterator) (writer).
standard-transformation-marker-column (reader).
(setf standard-transformation-marker-column) (writer).
standard-transformation-p (function).
standard-transformation-start (reader).
(setf standard-transformation-start) (writer).
standard-transformation-table (reader).
(setf standard-transformation-table) (writer).
standard-transformation-wrap-errors (reader).
(setf standard-transformation-wrap-errors) (writer).
table-from-header (function).
table-row (structure).
table-row-iterator (reader).
(setf table-row-iterator) (writer).
table-row-p (function).
to-table-function (class).
transform-row-impl (function).
vs (function).
write-columns (generic writer).
vellumcommon-lisp.
vellum.aux-package.
%aggregate-columns (function).
%aggregate-rows (function).
add-columns (function).
aggregate-columns (macro).
aggregate-rows (macro).
column-list (function).
copy-from (generic function).
copy-to (generic function).
drop-row-when (macro).
empty-column (function).
every-null-column-p (symbol macro).
every-null-column-p* (function).
file-input-row-cant-be-created (condition).
find-row (function).
found-row (macro).
join (generic function).
order-by (function).
pipeline (macro).
rename-columns (function).
row-cant-be-created (condition).
s-list (function).
some-null-column-p (symbol macro).
some-null-column-p* (function).
to-matrix (function).
unnest (function).
visualize (generic function).
with-standard-header (macro).
cartesian-product (function).
collect-column-specs (function).
column-name= (function).
hash-join-implementation (function).
vellum.headercommon-lisp.
vellum.aux-package.
*header* (special variable).
*row* (special variable).
alter-columns (generic function).
check-column-signatures-compatibility (generic function).
column-count (generic function).
column-names (function).
column-signature (function).
column-signature (structure).
column-specs (generic function).
column-type (function).
concatenate-headers (generic function).
ensure-index (function).
frame-range-mixin (class).
header (function).
headers-incompatible (condition).
index-to-name (function).
invalid-input-for-row (condition).
invalid-name (condition).
make-header (function).
make-row (generic function).
name-duplicated (condition).
name-to-index (function).
no-column (condition).
no-header (condition).
read-header (generic reader).
read-name (function).
read-new-value (function).
row (function).
select-columns (generic function).
set-row (function).
standard-header (structure).
unable-to-construct-row (condition).
with-header (macro).
write-header (generic writer).
column-signature-name (reader).
(setf column-signature-name) (writer).
column-signature-p (function).
column-signature-spec (generic function).
column-signature-type (reader).
(setf column-signature-type) (writer).
copy-column-signature (function).
copy-standard-header (function).
extracting-signature (function).
make-column-signature (function).
make-column-signature-impl (function).
make-signature (function).
make-standard-header (function).
no-row (condition).
read-column-names (function).
read-column-signatures (function).
read-type (function).
standard-header-column-names (reader).
(setf standard-header-column-names) (writer).
standard-header-column-signatures (reader).
(setf standard-header-column-signatures) (writer).
standard-header-p (function).
unique-names (function).
validate-active-header (function).
validate-active-row (function).
validate-row (function).
vellum.columncommon-lisp.
vellum.aux-package.
augment-iterator (generic function).
column-at (generic function).
(setf column-at) (generic function).
column-size (generic function).
column-type (generic function).
column-type-error (condition).
columns (function).
finish-iterator (generic function).
fundamental-column (class).
index (function).
insert-tail (function).
iterator-at (function).
(setf iterator-at) (function).
make-iterator (generic function).
make-sparse-material-column (function).
move-iterator (function).
move-iterator-to (function).
remove-nulls (generic function).
sparse-material-column (class).
sparse-material-column-iterator-index (reader).
(setf sparse-material-column-iterator-index) (writer).
truncate-to-length (generic function).
untouch (function).
access-index (function).
(setf access-index) (function).
access-iterator (generic reader).
(setf access-iterator) (generic writer).
access-position (generic reader).
(setf access-position) (generic writer).
build-new-mask (function).
calculate-depth (function).
change-leaf (function).
change-leafs (function).
child-index (function).
children (function).
clear-buffers (function).
clear-changed-parents-masks (function).
clear-changes (function).
clear-masks (function).
column-error (condition).
column-root (function).
column-type-error-column (generic reader).
concatenate-masks (function).
concatenate-trees (function).
concatenation-state (function).
concatenation-state (structure).
concatenation-state-changed-parents (reader).
(setf concatenation-state-changed-parents) (writer).
concatenation-state-columns (reader).
(setf concatenation-state-columns) (writer).
concatenation-state-iterator (reader).
(setf concatenation-state-iterator) (writer).
concatenation-state-masks (reader).
(setf concatenation-state-masks) (writer).
concatenation-state-masks-logcount (function).
concatenation-state-max-index (reader).
(setf concatenation-state-max-index) (writer).
concatenation-state-nodes (reader).
(setf concatenation-state-nodes) (writer).
concatenation-state-nodes-logcount (function).
concatenation-state-p (function).
concatenation-state-parents (reader).
(setf concatenation-state-parents) (writer).
copy-concatenation-state (function).
copy-on-write-node (function).
copy-sparse-material-column-iterator (function).
distinct-missing (function).
fill-buffer (function).
fill-buffers (function).
find-max-index (function).
free-space (function).
gather-masks (function).
in-existing-content (generic function).
index-out-of-column-bounds (condition).
index-promoted (function).
initialize-iterator-column (function).
initialize-iterator-columns (function).
into-vector-copy (function).
iterator-buffer (type).
iterator-change (type).
iterator-error (condition).
iterator-stack (type).
logior-mask (function).
make-concatenation-state (function).
make-leaf (function).
make-node (function).
make-sparse-material-column-iterator (function).
make-sparse-material-column-range (function).
mask (function).
(setf mask) (function).
mask-bytes (symbol macro).
max-index (function).
move-children (function).
move-children-in-column (function).
move-children-in-columns (function).
move-column-to (function).
move-stack (function).
move-to-existing-column (function).
move/pad-stack (function).
mutate-leaf (function).
no-such-column (condition).
node (function).
(setf node) (function).
occupied-space (function).
offset (function).
pad-stack (function).
parent-changed (function).
(setf parent-changed) (function).
parent-index (function).
range-iterator (function).
read-buffers (function).
read-changes (function).
read-column (generic reader).
read-column-types (function).
read-columns (function).
read-depths (function).
read-indexes (function).
read-initial-index (function).
read-initial-position (generic reader).
read-initialization-status (function).
read-stacks (function).
read-touched (function).
read-transformation (function).
reduce-stack (function).
reduce-stacks (function).
setting-to-null (condition).
shift-content (function).
sparse-material-column-at (function).
(setf sparse-material-column-at) (function).
sparse-material-column-iterator (structure).
sparse-material-column-iterator-buffers (reader).
(setf sparse-material-column-iterator-buffers) (writer).
sparse-material-column-iterator-changes (reader).
(setf sparse-material-column-iterator-changes) (writer).
sparse-material-column-iterator-column-types (reader).
(setf sparse-material-column-iterator-column-types) (writer).
sparse-material-column-iterator-columns (reader).
(setf sparse-material-column-iterator-columns) (writer).
sparse-material-column-iterator-depths (reader).
(setf sparse-material-column-iterator-depths) (writer).
sparse-material-column-iterator-indexes (reader).
(setf sparse-material-column-iterator-indexes) (writer).
sparse-material-column-iterator-initial-index (reader).
(setf sparse-material-column-iterator-initial-index) (writer).
sparse-material-column-iterator-initialization-status (reader).
(setf sparse-material-column-iterator-initialization-status) (writer).
sparse-material-column-iterator-p (function).
sparse-material-column-iterator-stacks (reader).
(setf sparse-material-column-iterator-stacks) (writer).
sparse-material-column-iterator-touched (reader).
(setf sparse-material-column-iterator-touched) (writer).
sparse-material-column-iterator-transformation (reader).
(setf sparse-material-column-iterator-transformation) (writer).
sparse-material-column-range (class).
tree-index (function).
trim-depth (function).
trim-depth-in-column (function).
truncate-mask (function).
update-parents (function).
with-concatenation-state (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Description:
Expands to a closure extracting COLUMN from the CURRENT-ROW if only one argument has been passed to the macro, or expands to a closure extracting multiple values packed into a list, elementwise.
Exceptional situations:
Expanded closure signals NO-COLUMN, NO-HEADER, NO-ROW exception if: column is not found in the current header, there is no active header, there is no active row.
Notes:
Expanded closure is not thread safe.
Description:
Evaluation of this macro expansion will inform find-row that row was found
See also:
–FIND-ROW
Description:
Expands to form binding *HEADER* and establishing *CURRENT-ROW*.
Notes:
Call SET-ROW to actually set the value of the row to a specific object.
Arguments:
–FRAME, Base data frame
–COLUMN-SPECS, Column-specs, as in :COLUMNS in MAKE-TABLE
Description:
Creates new frame from the old one by adding additional columns.
Description:
Returns selected column values in the current row as a list.
Description:
Returns the complete COLUMN-SIGNATURE object from the HEADER for the specified COLUMN.
Exceptional situations:
Will signal NO-COLUMN if no COLUMN in the HEADER.
Description:
What is the type stored inside the COLUMN?
Exceptional situations:
Will signal NO-COLUMN if no COLUMN in the HEADER.
Description:
Should be called from dynamic environment established in the callback passed to the TRANSFORM. When called, removes row from the data-frame and pefrorms non-local exit.
Description:
Converts strings and symbols to index of column in the HEADER. If a numeric index is passed it is returned unaltered.
Exceptional situations:
Will signal NO-COLUMN if no column in the HEADER with such INDEX/NAME exists.
Returns true if there if all columns within the current row are :NULL.
Examples:
–(prove:is (vellum:find-row (vellum:to-table ’((1 2 3) (3 4 5)) :columns ’(a b c)) (vellum:bind-row (c) (when (= c 5) (vellum:found-row)))) ’(3 4 5))
–(prove:is (vellum:find-row (vellum:to-table ’((1 2 3) (3 4 5)) :columns ’(a b c)) (vellum:bind-row (c) (when (= c 5) (vellum:found-row a)))) ’(3))
Description:
Attempts to find row.
Returns:
Selected columns values (all by default) as a list. T as secondary value if row was found, NIL otherwise.
See also:
–FOUND-ROW
Description:
Returns the current active header.
Exceptional situations:
Will signal NO-HEADER when there is no active header.
Description:
Converts a numeric INDEX designating column to the column name in the HEADER.
Exceptional situations:
Signalls NO-COLUMN when the INDEX is not found in the HEADER.
Description:
Construct the header instance of CLASS.
Description:
Converts a column NAME (which is either string or symbol) to the numeric index designating column in the HAEDER.
Exceptional situations:
Signalls NO-COLUMN when the NAME is not found in the HEADER.
Description:
Should be called from dynamic environment established in the callback passed to the TRANSFORM. Deletes all values in the current row, leaving :NULLs.
Description:
Builds new data-frame by sorting input TABLE data frame. Multiple columns and comparators can be used.
Notes:
–This function is calls CL:SORT to order data according to first column, and calls STABLE-SORT for all other columns.
Description:
This function is used only in order to provide interactive restarts.
Description:
Creates new frame from the old one with altered column names.
Description:
Extracts value from the current row.
Exceptional situations:
Signals NO-COLUMN, NO-HEADER, NO-ROW exception if: column is not found in the current header, there is no active header, there is no active row.
Description:
Sets the inner value of *CURRENT-ROW* to the passed ROW.
Exceptional situations:
Will signal NO-ROW when *CURRENT-ROW* is unbound.
Returns true if there is at least one :NULL column in the current row.
row.
sequence) translate limit) ¶standard-table) &rest columns) ¶standard-header) columns) ¶standard-table) (row integer) column) ¶standard-table) (row integer) column) ¶sparse-material-column-iterator) (column sparse-material-column)) ¶(eql nil)) &key header &allow-other-keys) ¶column-signature) (second-signature column-signature)) ¶standard-table) (column integer)) ¶standard-table) column) ¶Description:
Obtains value under INDEX from the COLUMN.
Returns:
Value under INDEX of the COLUMN. :NULL if location is empty.
Exceptional situations:
–Will signal INDEX-OUT-OF-COLUMN-BOUNDS if INDEX is out of column bounds.
–Will signal type-error if INDEX is not NON-NEGATIVE-INTEGER.
sparse-material-column) index) ¶Description:
Sets value under INDEX in the COLUMN.
Exceptional situations:
–Will signal INDEX-OUT-OF-COLUMN-BOUNDS if INDEX is out of column bounds.
–Will signal type-error if INDEX is not NON-NEGATIVE-INTEGER.
sparse-material-column) index) ¶standard-table)) ¶Description:
How many columns header specifies?
standard-header)) ¶standard-table) (column integer)) ¶Description:
The total size of the COLUMN.
sparse-material-column)) ¶standard-header)) ¶standard-table) column) ¶Arguments:
–COLUMN, Data frame column.
Description:
Type of the elements stored in the column.
sparse-material-column)) ¶standard-header) &rest more-headers) ¶(eql nil)) input &rest options &key body key class header-class columns header) ¶standard-table) (row integer) column) ¶sparse-material-column-iterator)) ¶standard-table-range)) ¶automatically generated reader method
standard-table)) ¶automatically generated reader method
Arguments:
–FRAME, A data frame. Columns from this data frame will be placed as first.
–MORE-FRAMES, Traversable object presenting more of the data frames.
Description:
Concatenates multiple frames row-wise.
standard-table) more-frames &key isolate) ¶standard-table) in-place) ¶Examples:
(let* ((frame-1 (vellum:transform (vellum:make-table :columns ’(a b))
(vellum:bind-row (a b)
(setf a vellum.table:*current-row*)
(setf b (format nil "a~a" a)))
:end 5))
(frame-2 (vellum:transform (vellum:make-table :columns ’(a b))
(vellum:bind-row (a b)
(setf a vellum.table:*current-row*)
(setf b (format nil "b~a" a)))
:end 5))
(result (vellum:join :hash :inner
‘((:frame-1 ,frame-1 a)
(:frame-2 ,frame-2 a)))))
(vellum:show :text result))
Description:
Performs METHOD (:LEFT or :INNER) join using ALGORITHM (:HASH) on FRAME-SPECS list. Each element of FRAME-SPECS list contains elements in the following order label for data-frame, data-frame and description of columns used as join key. Each description is either name of the column, number of the column; or two elements list consisting of name or number of the column and function designator used as key.
(eql :hash)) (method (eql :left)) (frame-specs list) &key class columns header test &allow-other-keys) ¶(eql :hash)) (method (eql :inner)) (frame-specs list) &key class columns header test &allow-other-keys) ¶list) &key &allow-other-keys) ¶Description:
Constructs iterator from the column. Extra columns can be added into iterator with augment-iterator function.
Description:
Constructs new row validated for the HEADERs predicates from the DATA.
Notes:
Since there is no column at this level, you may expect that the COLUMN-TYPE-ERROR can’t be signalled. This is not true, as this function is used to implement the data-frame behavior for various streams. Examples of this is vellum-csv which depends on the whole base vellum package as a whole.
frame-range-mixin) (data list)) ¶frame-range-mixin) (data vector)) ¶(eql vellum.table:standard-table)) &optional header) ¶frame-range-mixin)) ¶automatically generated reader method
standard-table) &key in-place) ¶sparse-material-column-iterator)) ¶standard-table)) ¶Description:
Select subset of COLUMNS and ROWS from the FRAME.
standard-table) &key rows columns) ¶standard-header) columns) ¶(eql :text)) (table fundamental-table) &key output start end) ¶summary-result-range) &key key class columns body after header &allow-other-keys) ¶group-by-result-range) &key key class columns body after header &allow-other-keys) ¶array) &key class key columns body enable-restarts wrap-errors after header) ¶sequence) &key key class columns body enable-restarts wrap-errors after header) ¶frame-range-mixin) &key class body enable-restarts wrap-errors after &allow-other-keys) ¶standard-table) bind-row &key enable-restarts wrap-errors in-place start aggregated-output end) ¶standard-transformation) &optional bind-row-closure) ¶standard-table) bind-row &key in-place enable-restarts wrap-errors aggregated-output start) ¶standard-transformation)) ¶sparse-material-column) length) ¶standard-table) mask &key in-place) ¶Description:
Concatenates multiple frames column-wise.
standard-table) more-frames) ¶frame-range-mixin) frame-range-mixin) ¶automatically generated writer method
standard-table) function) ¶cl-data-structures.
frame-range-mixin) function) ¶cl-data-structures.
sparse-material-column) function) ¶cl-data-structures.
sequence) (!outer-constructor2 (eql nil)) (!function3 to-table-function) (!arguments5 list)) ¶cl-data-structures.algorithms.meta.
traversable) (!outer-constructor2 (eql nil)) (!function3 to-table-function) (!arguments5 list)) ¶cl-data-structures.algorithms.meta.
fundamental-table) (function aggregation-function) all) ¶cl-data-structures.algorithms.meta.
fundamental-table) (function layer-function) all) ¶cl-data-structures.algorithms.meta.
standard-table)) ¶cl-data-structures.
standard-table-range)) ¶cl-data-structures.
sparse-material-column-range)) ¶cl-data-structures.
sparse-material-column-iterator)) ¶cl-data-structures.
standard-table-range)) ¶cl-data-structures.utils.
standard-table)) ¶cl-data-structures.utils.
frame-range-mixin)) ¶cl-data-structures.utils.
standard-header)) ¶cl-data-structures.utils.
sparse-material-column)) ¶cl-data-structures.utils.
standard-table-range)) ¶cl-data-structures.
frame-range-mixin)) ¶cl-data-structures.
sparse-material-column-range)) ¶cl-data-structures.
standard-table-range) count) ¶cl-data-structures.
sparse-material-column-range) count) ¶cl-data-structures.
standard-table-range)) ¶cl-data-structures.
frame-range-mixin)) ¶cl-data-structures.
sparse-material-column-range)) ¶cl-data-structures.
shrink-function) (structure sparse-material-column) container position &rest all) ¶cl-data-structures.meta.
grow-function) (structure sparse-material-column) container position &rest all &key value) ¶cl-data-structures.meta.
fundamental-table) stream) ¶standard-table) &optional isolate) ¶cl-data-structures.
standard-table-range)) ¶cl-data-structures.
sparse-material-column-range)) ¶cl-data-structures.
sparse-material-column-iterator)) ¶cl-data-structures.
standard-table-range) function) ¶cl-data-structures.
standard-table) function) ¶cl-data-structures.
frame-range-mixin) function) ¶cl-data-structures.
sparse-material-column) function) ¶cl-data-structures.
standard-table)) ¶cl-data-structures.
sparse-material-column)) ¶cl-data-structures.
Thise error may be signalled only when :PROHIBIT is passed as :AGGREGATED-OUTPUT.
operation-not-allowed.
| Initarg | Value |
|---|---|
:format-control | aggregated-output was :prohibit, but aggregation was found in the bind-row |
Thise error may be signalled only when :REQUIRE is passed as :AGGREGATED-OUTPUT.
operation-not-allowed.
| Initarg | Value |
|---|---|
:format-control | aggregated-output was :require, but no aggregation was found in the bind-row |
type-error.
:column
This slot is read-only.
file-releated-error.
row-cant-be-created.
operation-not-allowed.
| Initarg | Value |
|---|---|
:format-control | headers are incompatible. |
:headers
invalid-value.
invalid-value.
Description:
Names in the header are supposed to be unique. If an operation is performed that would violate that rule, this error is signalled.
invalid-value.
| Initarg | Value |
|---|---|
:format-control | detected name ~a duplication. |
invalid-value.
Description:
Error signalled when trying to reference non existing column in the current header.
argument-value-not-in-allowed-set.
| Initarg | Value |
|---|---|
:format-control | no column ~a. |
Description:
Error signalled when trying to reference current header, but it is not binded.
operation-not-allowed.
| Initarg | Value |
|---|---|
:format-control | no active header. |
operation-not-allowed.
| Initarg | Value |
|---|---|
:format-control | not performing transformation right now. |
chainable-condition.
Wrapper for errors produced during transformation, when :WRAP-ERRORS is true.
textual-error.
| Initarg | Value |
|---|---|
:format-control | error during transformation. |
textual-error.
| Initarg | Value |
|---|---|
:format-control | can't create row from data. |
:header
Description:
Stores informations regarding the the specific column: type, name, predicate
Description:
Default class of header. Supplies the default implementaiton of the header protocol.
| Initarg | Value |
|---|---|
:from | nil |
:to | nil |
funcallable-standard-object.
:optimized-closure
This slot is read-only.
Description:
Mixin class that can be inherited by various subclasses of CL-DS:FUNDAMENTAL-FORWARD-RANGE to provide partial support for the data-frames. This includes consume-front, peek-front, traverse, and accross methods. See vellum-csv system to see the example of the use case for this class.
:header
traversable.
traversable.
:callback
This slot is read-only.
fundamental-column.
transactional-sparse-rrb-vector.
across.
alter-columns.
(setf at).
at.
become-transactional.
cloning-information.
column-at.
column-at.
column-count.
column-name.
column-type.
erase!.
header.
hstack*.
iterator.
read-columns.
remove-nulls.
replica.
row-count.
select.
transform.
transformation.
traverse.
vmask.
vstack*.
whole-range.
write-columns.
vector
:columns
fundamental-forward-range.
:table-row
This slot is read-only.
:header
This slot is read-only.
fixnum
:row-count
This slot is read-only.
name.
type.
Description:
Conrstucts the BIND-ROW instance. This function is typically not called explicitly but instead part of the BIND-ROW macros macroexpansion.
Description:
Signals NO-HEADER error when the *HEADER* is NIL.
sparse-material-column-range)) ¶automatically generated reader method
sparse-material-column-range)) ¶automatically generated writer method
sparse-material-column-range)) ¶automatically generated reader method
sparse-material-column-range)) ¶automatically generated writer method
group-by-aggregation-results)) ¶automatically generated reader method
aggregation-results)) ¶automatically generated reader method
group-by-aggregation-results)) ¶aggregation-results)) ¶group-by-aggregation-results)) ¶automatically generated reader method
aggregation-results)) ¶automatically generated reader method
column-signature)) ¶setting-to-null)) ¶column-type-error)) ¶summary-result-range) position buffer finish-callback key) ¶group-by-result-range) position buffer finish-callback key) ¶group-by-aggregation-results)) ¶automatically generated reader method
sparse-material-column-iterator)) ¶sparse-material-column-range)) ¶automatically generated reader method
standard-table)) ¶automatically generated reader method
standard-table-range)) ¶automatically generated reader method
sparse-material-column-range)) ¶automatically generated reader method
standard-table-range)) ¶standard-table-range)) ¶automatically generated reader method
standard-table-range)) ¶automatically generated reader method
standard-table) standard-table) ¶automatically generated writer method
program-error.
argument-value-out-of-bounds.
column-error.
program-error.
Description:
Error signalled when trying to reference current row, but it is not binded.
operation-not-allowed.
| Initarg | Value |
|---|---|
:format-control | no active row. |
argument-value-out-of-bounds.
column-error.
column-error.
invalid-value.
:column
This slot is read-only.
structure-object.
vector
#()
hash-table
(make-hash-table)
alexandria:non-negative-fixnum
0
vector
#()
(or null vellum.column::concatenation-state)
simple-vector
#()
structure-object.
simple-vector
(make-array 0)
(setf sparse-material-column-iterator-initialization-status).
simple-vector
(make-array 0)
simple-vector
#()
simple-vector
#()
(simple-array fixnum (*))
(make-array 0 :element-type (quote fixnum))
fixnum
0
(simple-array fixnum (*))
(make-array 0 :element-type (quote fixnum))
fixnum
0
simple-vector
(make-array 0)
simple-vector
#()
simple-vector
#()
structure-object.
boolean
boolean
vellum.table:*enable-restarts*
boolean
vellum.table:*wrap-errors*
boolean
integer
0
simple-vector
#()
fixnum
0
common-lisp.
fixnum
0
structure-object.
:aggregators
This slot is read-only.
:aggregation-column-names
This slot is read-only.
:group-names
This slot is read-only.
fundamental-forward-range.
:iterator
:column
This slot is read-only.
:position
:position
This slot is read-only.
aggregation-function.
| Jump to: | %
(
A B C D E F G H I J L M N O P R S T U V W |
|---|
| Jump to: | %
(
A B C D E F G H I J L M N O P R S T U V W |
|---|
| Jump to: | %
*
A B C D E I M N P R S T W |
|---|
| Jump to: | %
*
A B C D E I M N P R S T W |
|---|
| Jump to: | A B C D F G H I M N P R S T U V |
|---|