The cl-data-frame Reference Manual

Table of Contents

The cl-data-frame Reference Manual

This is the cl-data-frame Reference Manual, version 0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 12:12:24 2020 GMT+0.

1 Introduction

#+CAPTION: Project Status: Abandoned – Initial development has started, but there has not yet been a stable, usable release; the project has been abandoned and the author(s) do not intend on continuing development.
[[http://www.repostatus.org/badges/latest/abandoned.svg]]

* Data frames for Common Lisp

/I need to write this, for now just look at the unit tests which have plenty of examples./

* Reporting bugs

Please report bugs using the [[https://github.com/tpapp/cl-data-frame/issues][issue tracker]].

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-data-frame

Maintainer

Tamas Papp <tkpapp@gmail.com>

Author

Tamas Papp <tkpapp@gmail.com>

License

MIT

Description

Data frames for Common Lisp.

Long Description

FIXME

Version

0

Dependencies

• alexandria
• anaphora
• array-operations
• cl-num-utils
• cl-slice
• let-plus

Source

cl-data-frame.asd (file)

Component

cl-data-frame.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cl-data-frame.asd

Location

cl-data-frame.asd

Systems

cl-data-frame (system)

3.1.2 cl-data-frame/cl-data-frame.lisp

Parent

cl-data-frame (system)

Location

cl-data-frame.lisp

Packages

• cl-data-frame.column
• cl-data-frame

Exported Definitions

• *column-summary-minimum-length* (special variable)
• add-column! (function)
• add-columns (function)
• add-columns! (function)
• alist-df (function)
• alist-dv (function)
• column (function)
• (setf column) (function)
• column-length (generic function)
• column-length (method)
• column-summary (generic function)
• column-summary (method)
• column-summary (method)
• columns (function)
• copy (function)
• count-rows (function)
• data-frame (class)
• data-vector (class)
• df (function)
• do-rows (function)
• duplicate-key (condition)
• dv (function)
• key-not-found (condition)
• keys (function)
• make-df (function)
• make-dv (function)
• map-columns (function)
• map-df (function)
• map-rows (function)
• mask-rows (function)
• matrix-df (function)
• plist-df (function)
• plist-dv (function)
• replace-column (function)
• replace-column! (function)

Internal Definitions

• *column-summary-quantiles-threshold* (special variable)
• add-key! (function)
• add-keys (function)
• alist-data (function)
• bit-vector-summary (structure)
• bit-vector-summary-count (function)
• bit-vector-summary-length (function)
• bit-vector-summary-p (function)
• check-column-compatibility (generic function)
• check-column-compatibility (method)
• check-column-compatibility (method)
• copy-bit-vector-summary (function)
• copy-generic-vector-summary (function)
• copy-ordered-keys (function)
• copy-quantiles-summary (function)
• copy-vector-summary% (function)
• data (class)
• define-data-subclass (macro)
• ensure-arguments-alist (function)
• ensure-not-ratio (function)
• generic-vector-summary (structure)
• generic-vector-summary-element-count-alist (function)
• generic-vector-summary-length (function)
• generic-vector-summary-p (function)
• generic-vector-summary-quantiles (function)
• guess-alist? (function)
• key-index (function)
• keys-count (function)
• keys-vector (function)
• make-bit-vector-summary (function)
• make-data (function)
• make-generic-vector-summary (function)
• make-ordered-keys (function)
• make-quantiles-summary (function)
• make-vector-summary% (function)
• ordered-keys (function)
• ordered-keys (structure)
• ordered-keys-p (function)
• ordered-keys-table (function)
• plist-data (function)
• print-count-and-percentage (function)
• quantiles-summary (structure)
• quantiles-summary-count (function)
• quantiles-summary-max (function)
• quantiles-summary-min (function)
• quantiles-summary-p (function)
• quantiles-summary-q25 (function)
• quantiles-summary-q50 (function)
• quantiles-summary-q75 (function)
• vector-summary% (structure)
• vector-summary%-length (function)
• vector-summary%-p (function)

4 Packages

Packages are listed by definition order.

4.1 cl-data-frame.column

Source

cl-data-frame.lisp (file)

Use List

• let-plus
• anaphora
• alexandria
• common-lisp

Used By List

cl-data-frame

Exported Definitions

• column-length (generic function)
• column-length (method)
• column-summary (generic function)
• column-summary (method)
• column-summary (method)

Internal Definitions

• *column-summary-quantiles-threshold* (special variable)
• bit-vector-summary (structure)
• bit-vector-summary-count (function)
• bit-vector-summary-length (function)
• bit-vector-summary-p (function)
• copy-bit-vector-summary (function)
• copy-generic-vector-summary (function)
• copy-quantiles-summary (function)
• copy-vector-summary% (function)
• ensure-not-ratio (function)
• generic-vector-summary (structure)
• generic-vector-summary-element-count-alist (function)
• generic-vector-summary-length (function)
• generic-vector-summary-p (function)
• generic-vector-summary-quantiles (function)
• make-bit-vector-summary (function)
• make-generic-vector-summary (function)
• make-quantiles-summary (function)
• make-vector-summary% (function)
• print-count-and-percentage (function)
• quantiles-summary (structure)
• quantiles-summary-count (function)
• quantiles-summary-max (function)
• quantiles-summary-min (function)
• quantiles-summary-p (function)
• quantiles-summary-q25 (function)
• quantiles-summary-q50 (function)
• quantiles-summary-q75 (function)
• vector-summary% (structure)
• vector-summary%-length (function)
• vector-summary%-p (function)

4.2 cl-data-frame

Source

cl-data-frame.lisp (file)

Nicknames

• dframe
• data-frame

Use List

• cl-slice-dev
• cl-slice
• cl-data-frame.column
• let-plus
• anaphora
• alexandria
• common-lisp

Exported Definitions

• *column-summary-minimum-length* (special variable)
• add-column! (function)
• add-columns (function)
• add-columns! (function)
• alist-df (function)
• alist-dv (function)
• column (function)
• (setf column) (function)
• columns (function)
• copy (function)
• count-rows (function)
• data-frame (class)
• data-vector (class)
• df (function)
• do-rows (function)
• duplicate-key (condition)
• dv (function)
• key-not-found (condition)
• keys (function)
• make-df (function)
• make-dv (function)
• map-columns (function)
• map-df (function)
• map-rows (function)
• mask-rows (function)
• matrix-df (function)
• plist-df (function)
• plist-dv (function)
• replace-column (function)
• replace-column! (function)

Internal Definitions

• add-key! (function)
• add-keys (function)
• alist-data (function)
• check-column-compatibility (generic function)
• check-column-compatibility (method)
• check-column-compatibility (method)
• copy-ordered-keys (function)
• data (class)
• define-data-subclass (macro)
• ensure-arguments-alist (function)
• guess-alist? (function)
• key-index (function)
• keys-count (function)
• keys-vector (function)
• make-data (function)
• make-ordered-keys (function)
• ordered-keys (function)
• ordered-keys (structure)
• ordered-keys-p (function)
• ordered-keys-table (function)
• plist-data (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *column-summary-minimum-length*

Columns are only summarized when longer than this, otherwise they are returned as is.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

5.1.2 Functions

Function: add-column! DATA KEY COLUMN

Modify DATA (a data-frame or data-vector) by adding COLUMN with KEY. Return DATA.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: add-columns DATA &rest KEYS-AND-COLUMNS

Return a new data-frame or data-vector with keys and columns added. Does not modify DATA (see README about accepted argument formats).

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: add-columns! DATA &rest KEYS-AND-COLUMNS

Modify DATA (a data-frame or data-vector) by adding columns with keys (see README about accepted argument formats).

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: alist-df ALIST

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: alist-dv ALIST

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: column DATA KEY

Return column corresponding to key.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Writer

(setf column) (function)

Function: (setf column) COLUMN DATA KEY

Set column corresponding to key.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Reader

column (function)

Function: columns DATA &optional SLICE

Return the columns as a vector, or a slice if given (keys are resolved).

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: copy DATA &key KEY

Copy data frame or vector. Keys are copied (and thus can be modified), columns or elements are copyied using KEY, making the default give a shallow copy.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: count-rows DATA-FRAME KEYS PREDICATE

Count the number of rows for which PREDICATE called on the columns corresponding to KEYS returns non-NIL.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: df &rest PLIST-OR-ALIST

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: do-rows DATA-FRAME KEYS FUNCTION

Traverse rows from first to last, calling FUNCTION on the columns corresponding to KEYS. Return no values.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: dv &rest PLIST-OR-ALIST

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: keys DATA

List of keys.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: make-df KEYS COLUMNS

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: make-dv KEYS COLUMNS

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: map-columns DATA FUNCTION &optional RESULT-CLASS

Map columns of DATA-FRAME or DATA-VECTOR using FUNCTION. The result is a new DATA-FRAME with the same keys.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: map-df DATA-FRAME KEYS FUNCTION RESULT-KEYS

Map DATA-FRAME to another one by rows. Function is called on the columns corresponding to KEYS, and should return a sequence with the same length as RESULT-KEYS, which give the keys of the resulting data frame. RESULT-KETS should be either symbols, or of the format (symbol &optional (element-type t)).

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: map-rows DATA-FRAME KEYS FUNCTION &key ELEMENT-TYPE

Map rows using FUNCTION, on the columns corresponding to KEYS. Return the result with the given ELEMENT-TYPE.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: mask-rows DATA-FRAME KEYS PREDICATE

Return a bit-vector containing the result of calling PREDICATE on rows of the columns corresponding to KEYS (0 for NIL, 1 otherwise).

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: matrix-df KEYS MATRIX

Convert a matrix to a data-frame with the given keys.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: plist-df PLIST

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: plist-dv PLIST

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: replace-column DATA KEY FUNCTION-OR-COLUMN &key ELEMENT-TYPE

Create a new data frame by with new column KEY from data-frame DATE by replacing it either with the given column, or applying the function to the current values (ELEMENT-TYPE is used.)

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: replace-column! DATA KEY FUNCTION-OR-COLUMN &key ELEMENT-TYPE

Modify column KEY of data-frame DATE by replacing it either with the given column, or applying the function to the current values (ELEMENT-TYPE is used.)

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

5.1.3 Generic functions

Generic Function: column-length COLUMN

Return the length of column.

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Methods

Method: column-length (COLUMN vector)

Generic Function: column-summary COLUMN

Return an object that summarizes COLUMN of a DATA-FRAME. Primarily intended for printing, not analysis, returned values should print nicely.

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Methods

Method: column-summary (COLUMN bit-vector)

Method: column-summary (COLUMN vector)

5.1.4 Conditions

Condition: duplicate-key ()

Duplicate key.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Direct superclasses

error (condition)

Direct slots

Slot: key

Initargs

:key

Condition: key-not-found ()

Key not found.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Direct superclasses

error (condition)

Direct slots

Slot: key

Initargs

:key

Slot: keys

Initargs

:keys

5.1.5 Classes

Class: data-frame ()

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Direct superclasses

data (class)

Direct methods

• slice (method)
• print-object (method)
• check-column-compatibility (method)
• as-array (method)
• dims (method)
• ncol (method)
• nrow (method)
• initialize-instance (method)

Class: data-vector ()

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Direct superclasses

data (class)

Direct methods

• slice (method)
• print-object (method)
• as-array (method)
• dims (method)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *column-summary-quantiles-threshold*

If the number of reals exceeds this threshold, they will be summarized with quantiles.

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

5.2.2 Macros

Macro: define-data-subclass CLASS ABBREVIATION

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

5.2.3 Functions

Function: add-key! ORDERED-KEYS KEY

Modify ORDERED-KEYS by adding KEY.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: add-keys ORDERED-KEYS &rest KEYS

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: alist-data CLASS ALIST

Create an object of CLASS (subclass of DATA) from ALIST which contains key-column pairs.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: bit-vector-summary-count INSTANCE

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: bit-vector-summary-length INSTANCE

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: bit-vector-summary-p OBJECT

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: copy-bit-vector-summary INSTANCE

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: copy-generic-vector-summary INSTANCE

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: copy-ordered-keys ORDERED-KEYS

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: copy-quantiles-summary INSTANCE

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: copy-vector-summary% INSTANCE

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: ensure-arguments-alist REST

Recognizes the following and converts them to an alist:

plist
alist
(plist)
(alist)
(data-frame)

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: ensure-not-ratio REAL

When REAL is a RATIO, convert it to a float, otherwise return as is. Used for printing.

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: generic-vector-summary-element-count-alist INSTANCE

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: generic-vector-summary-length INSTANCE

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: generic-vector-summary-p OBJECT

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: generic-vector-summary-quantiles INSTANCE

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: guess-alist? PLIST-OR-ALIST

Test if the argument is an ALIST by checking its first element. Used for deciding which creation function to call.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: key-index ORDERED-KEYS KEY

Return the index for KEY.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: keys-count ORDERED-KEYS

Number of keys.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: keys-vector ORDERED-KEYS

Vector of all keys.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: make-bit-vector-summary &key (LENGTH LENGTH) (COUNT COUNT)

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: make-data CLASS KEYS COLUMNS

Create a DATA object from KEYS and COLUMNS. FOR INTERNAL USE. Always creates a copy of COLUMNS in order to ensure that it is an adjustable array with a fill pointer. KEYS are converted to ORDERED-KEYS if necessary.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: make-generic-vector-summary &key (LENGTH LENGTH) (QUANTILES QUANTILES) (ELEMENT-COUNT-ALIST ELEMENT-COUNT-ALIST)

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: make-ordered-keys &key (TABLE TABLE)

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: make-quantiles-summary &key (COUNT COUNT) (MIN MIN) (Q25 Q25) (Q50 Q50) (Q75 Q75) (MAX MAX)

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: make-vector-summary% &key (LENGTH LENGTH)

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: ordered-keys KEYS

Create an ORDERED-KEYS object from KEYS (a sequence).

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: ordered-keys-p OBJECT

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: ordered-keys-table INSTANCE

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: plist-data CLASS PLIST

Create an object of CLASS (subclass of DATA) from PLIST which contains keys and columns, interleaved.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Function: print-count-and-percentage STREAM COUNT LENGTH

Print COUNT as is and also as a rounded percentage of

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: quantiles-summary-count INSTANCE

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: quantiles-summary-max INSTANCE

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: quantiles-summary-min INSTANCE

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: quantiles-summary-p OBJECT

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: quantiles-summary-q25 INSTANCE

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: quantiles-summary-q50 INSTANCE

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: quantiles-summary-q75 INSTANCE

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: vector-summary%-length INSTANCE

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Function: vector-summary%-p OBJECT

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

5.2.4 Generic functions

Generic Function: check-column-compatibility DATA COLUMN

Check if COLUMN is compatible with DATA.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Methods

Method: check-column-compatibility (DATA data-frame) COLUMN

Method: check-column-compatibility (DATA data) COLUMN

5.2.5 Structures

Structure: bit-vector-summary ()

Summary of a bit vector.

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Direct superclasses

vector-summary% (structure)

Direct methods

print-object (method)

Direct slots

Slot: count

Type

alexandria:array-index

Initform

0

Readers

bit-vector-summary-count (function)

Writers

(setf bit-vector-summary-count) (function)

Structure: generic-vector-summary ()

Summary for generic vectors.

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Direct superclasses

vector-summary% (structure)

Direct methods

print-object (method)

Direct slots

Slot: quantiles

Type

(or null cl-data-frame.column::quantiles-summary)

Readers

generic-vector-summary-quantiles (function)

Writers

(setf generic-vector-summary-quantiles) (function)

Slot: element-count-alist

Type

list

Readers

generic-vector-summary-element-count-alist (function)

Writers

(setf generic-vector-summary-element-count-alist) (function)

Structure: ordered-keys ()

Representation of ordered keys.

TABLE maps keys to indexes, starting from zero.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

• slice (method)
• canonical-representation (method)
• axis-dimension (method)
• print-object (method)

Direct slots

Slot: table

Type

hash-table

Initform

(make-hash-table :test (function eq))

Readers

ordered-keys-table (function)

Writers

(setf ordered-keys-table) (function)

Structure: quantiles-summary ()

Summary of a real elements (using quantiles).

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: count

Type

alexandria:array-index

Initform

0

Readers

quantiles-summary-count (function)

Writers

(setf quantiles-summary-count) (function)

Slot: min

Type

real

Initform

0

Readers

quantiles-summary-min (function)

Writers

(setf quantiles-summary-min) (function)

Slot: q25

Type

real

Initform

0

Readers

quantiles-summary-q25 (function)

Writers

(setf quantiles-summary-q25) (function)

Slot: q50

Type

real

Initform

0

Readers

quantiles-summary-q50 (function)

Writers

(setf quantiles-summary-q50) (function)

Slot: q75

Type

real

Initform

0

Readers

quantiles-summary-q75 (function)

Writers

(setf quantiles-summary-q75) (function)

Slot: max

Type

real

Initform

0

Readers

quantiles-summary-max (function)

Writers

(setf quantiles-summary-max) (function)

Structure: vector-summary% ()

Base class for summarizing vectors. Not exported.

Package

cl-data-frame.column

Source

cl-data-frame.lisp (file)

Direct superclasses

structure-object (structure)

Direct subclasses

• bit-vector-summary (structure)
• generic-vector-summary (structure)

Direct slots

Slot: length

Type

alexandria:array-index

Initform

0

Readers

vector-summary%-length (function)

Writers

(setf vector-summary%-length) (function)

5.2.6 Classes

Class: data ()

This class is used for implementing both data-vector and data-matrix, and represents and ordered collection of key-column pairs. Columns are not assumed to have any specific attributes. This class is not exported.

Package

cl-data-frame

Source

cl-data-frame.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

• data-vector (class)
• data-frame (class)

Direct methods

• as-alist (method)
• check-column-compatibility (method)
• element-type (method)

Direct slots

Slot: ordered-keys

Type

cl-data-frame::ordered-keys

Initargs

:ordered-keys

Slot: columns

Type

vector

Initargs

:columns

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types