The com.clearly-useful.generic-collection-interface Reference Manual

3.1.1 com.clearly-useful.generic-collection-interface/com.clearly-useful.generic-collection-interface.asd

Source

com.clearly-useful.generic-collection-interface.asd.

Parent Component

com.clearly-useful.generic-collection-interface (system).

ASDF Systems

com.clearly-useful.generic-collection-interface.

---

3.1.2 com.clearly-useful.generic-collection-interface/package.lisp

Source

com.clearly-useful.generic-collection-interface.asd.

Parent Component

com.clearly-useful.generic-collection-interface (system).

Packages

com.clearly-useful.generic-collection-interface.

---

3.1.3 com.clearly-useful.generic-collection-interface/features.lisp

Dependency

package.lisp (file).

Source

com.clearly-useful.generic-collection-interface.asd.

Parent Component

com.clearly-useful.generic-collection-interface (system).

---

3.1.4 com.clearly-useful.generic-collection-interface/protocols.lisp

Dependency

features.lisp (file).

Source

com.clearly-useful.generic-collection-interface.asd.

Parent Component

com.clearly-useful.generic-collection-interface (system).

Public Interface

• all-keys (generic function).
• all-values (generic function).
• associative (generic function).
• associative (type).
• coll-fold (generic function).
• coll-reduce (generic function).
• collection (type).
• collection-p (function).
• contains-key-p (generic function).
• count-elements (generic function).
• countable (generic function).
• countable (type).
• countable-p (function).
• counted-p (generic function).
• element-at (generic function).
• empty (generic function).
• empty-p (generic function).
• foldable (type).
• foldable-p (function).
• head (generic function).
• indexable (generic function).
• indexable (type).
• indexable-p (function).
• reduceable (type).
• reduceable-p (function).
• seq (generic function).
• seq (type).
• seq-p (function).
• seqable (type).
• seqable-p (function).
• tail (generic function).
• value-for-key (generic function).

Internals

associative-p (function).

---

3.1.5 com.clearly-useful.generic-collection-interface/internal-utils.lisp

Dependency

protocols.lisp (file).

Source

com.clearly-useful.generic-collection-interface.asd.

Parent Component

com.clearly-useful.generic-collection-interface (system).

Internals

• %adjustable (function).
• %dup-hash (function).
• %empty-hash (function).
• %interface-package (function).
• define-interface-package (macro).
• subvec (function).

---

3.1.6 com.clearly-useful.generic-collection-interface/macros.lisp

Dependency

internal-utils.lisp (file).

Source

com.clearly-useful.generic-collection-interface.asd.

Parent Component

com.clearly-useful.generic-collection-interface (system).

Public Interface

• doindexable (macro).
• doseq (macro).

---

3.1.7 com.clearly-useful.generic-collection-interface/methods.lisp

Dependency

macros.lisp (file).

Source

com.clearly-useful.generic-collection-interface.asd.

Parent Component

com.clearly-useful.generic-collection-interface (system).

Public Interface

• all-keys-and-values (generic function).
• getkey (function).
• seq-to-list (function).

---

3.1.8 com.clearly-useful.generic-collection-interface/conversions.lisp

Dependency

methods.lisp (file).

Source

com.clearly-useful.generic-collection-interface.asd.

Parent Component

com.clearly-useful.generic-collection-interface (system).

Public Interface

• all-keys (method).
• all-values (method).
• associative (method).
• contains-key-p (method).
• count-elements (method).
• count-elements (method).
• countable (method).
• countable (method).
• counted-p (method).
• counted-p (method).
• element-at (method).
• element-at (method).
• empty (method).
• empty (method).
• empty (method).
• empty (method).
• empty-p (method).
• empty-p (method).
• empty-p (method).
• empty-p (method).
• head (method).
• head (method).
• indexable (method).
• indexable (method).
• seq (method).
• seq (method).
• tail (method).
• tail (method).
• value-for-key (method).

Internals

• %associative-to-indexable (function).
• %count-seq (function).
• %countable-associative (structure).
• %countable-associative-countable (reader).
• (setf %countable-associative-countable) (writer).
• %countable-associative-length (reader).
• (setf %countable-associative-length) (writer).
• %countable-associative-p (function).
• %countable-sequence (structure).
• %countable-sequence-countable (reader).
• (setf %countable-sequence-countable) (writer).
• %countable-sequence-index (reader).
• (setf %countable-sequence-index) (writer).
• %countable-sequence-length (reader).
• (setf %countable-sequence-length) (writer).
• %countable-sequence-p (function).
• %countable-sequence-size (function).
• %countable-to-associative (function).
• %countable-to-seq (function).
• %next-countable-sequence (function).
• %next-range (function).
• %range (structure).
• %range-high (reader).
• (setf %range-high) (writer).
• %range-low (reader).
• (setf %range-low) (writer).
• %range-p (function).
• %range-size (function).
• %seq-countable (structure).
• %seq-countable-contains-index (function).
• %seq-countable-count (function).
• %seq-countable-fully-counted (reader).
• (setf %seq-countable-fully-counted) (writer).
• %seq-countable-p (function).
• %seq-countable-seq (reader).
• (setf %seq-countable-seq) (writer).
• %seq-countable-ubound (reader).
• (setf %seq-countable-ubound) (writer).
• %seq-indexable-by (function).
• %seq-nth-or-error (function).
• %seq-nth-or-nil-with-values (function).
• %seq-to-associative (function).
• %seq-to-countable (function).
• %seq-to-list (function).
• copy-%countable-associative (function).
• copy-%countable-sequence (function).
• copy-%range (function).
• copy-%seq-countable (function).
• implements-protocol? (method).
• implements-protocol? (method).
• implements-protocol? (method).
• implements-protocol? (method).
• implements-protocol? (method).
• implements-protocol? (method).
• implements-protocol? (method).
• implements-protocol? (method).
• implements-protocol? (method).
• implements-protocol? (method).
• implements-protocol? (method).
• implements-protocol? (method).
• implements-protocol? (method).
• make-%countable-associative (function).
• make-%countable-sequence (function).
• make-%range (function).
• make-%seq-countable (function).

---

3.1.9 com.clearly-useful.generic-collection-interface/reduceable-base.lisp

Dependency

conversions.lisp (file).

Source

com.clearly-useful.generic-collection-interface.asd.

Parent Component

com.clearly-useful.generic-collection-interface (system).

Public Interface

• coll-reduce (method).
• filtering (function).
• fold-left (function).
• mapcatting (function).
• mapping (function).
• monoid (function).
• reduced (function).
• reducer (function).

Internals

• %reduce (function).
• %reducer (structure).
• %reducer-coll (reader).
• (setf %reducer-coll) (writer).
• %reducer-p (function).
• %reducer-transformer (reader).
• (setf %reducer-transformer) (writer).
• copy-%reducer (function).
• implements-protocol? (method).
• make-%reducer (function).
• reduce-indexable (function).
• reduce-seq (function).
• reduceable-reduce (function).

---

3.1.10 com.clearly-useful.generic-collection-interface/foldable-base.lisp

Dependency

reduceable-base.lisp (file).

Source

com.clearly-useful.generic-collection-interface.asd.

Parent Component

com.clearly-useful.generic-collection-interface (system).

Public Interface

• coll-fold (method).
• fold (function).
• folder (function).

Internals

• %folder (structure).
• %folder-coll (function).
• (setf %folder-coll) (function).
• %folder-p (function).
• %folder-transformer (function).
• (setf %folder-transformer) (function).
• copy-%folder (function).
• implements-protocol? (method).
• make-%folder (function).
• with-fold-kernel (macro).

---

3.1.11 com.clearly-useful.generic-collection-interface/base-methods.lisp

Dependency

foldable-base.lisp (file).

Source

com.clearly-useful.generic-collection-interface.asd.

Parent Component

com.clearly-useful.generic-collection-interface (system).

Public Interface

• associative (method).
• coll-fold (method).
• coll-reduce (method).
• countable (method).
• indexable (method).
• seq (method).

---

3.1.12 com.clearly-useful.generic-collection-interface/default-methods.lisp

Dependency

base-methods.lisp (file).

Source

com.clearly-useful.generic-collection-interface.asd.

Parent Component

com.clearly-useful.generic-collection-interface (system).

Public Interface

• all-keys (method).
• all-values (method).
• contains-key-p (method).
• count-elements (method).
• counted-p (method).
• element-at (method).
• head (method).
• tail (method).
• value-for-key (method).

---

3.1.13 com.clearly-useful.generic-collection-interface/conj.lisp

Dependency

default-methods.lisp (file).

Source

com.clearly-useful.generic-collection-interface.asd.

Parent Component

com.clearly-useful.generic-collection-interface (system).

Public Interface

• conj (generic function).
• into (function).

Internals

• %hash-conj! (function).
• %vector-conj! (function).

---

3.1.14 com.clearly-useful.generic-collection-interface/parallel.lisp

Dependency

conj.lisp (file).

Source

com.clearly-useful.generic-collection-interface.asd.

Parent Component

com.clearly-useful.generic-collection-interface (system).

Internals

• %%%%.defpun.fold-vector (function).
• fold-vector (function).

---

3.1.15 com.clearly-useful.generic-collection-interface/builtins.lisp

Dependency

parallel.lisp (file).

Source

com.clearly-useful.generic-collection-interface.asd.

Parent Component

com.clearly-useful.generic-collection-interface (system).

Public Interface

• all-keys (method).
• all-keys (method).
• all-keys (method).
• all-keys (method).
• all-keys (method).
• all-keys-and-values (method).
• all-values (method).
• all-values (method).
• all-values (method).
• all-values (method).
• all-values (method).
• associative (method).
• associative (method).
• associative (method).
• associative (method).
• associative (method).
• coll-fold (method).
• coll-reduce (method).
• coll-reduce (method).
• coll-reduce (method).
• coll-reduce (method).
• coll-reduce (method).
• contains-key-p (method).
• contains-key-p (method).
• contains-key-p (method).
• contains-key-p (method).
• contains-key-p (method).
• count-elements (method).
• count-elements (method).
• count-elements (method).
• count-elements (method).
• count-elements (method).
• countable (method).
• countable (method).
• countable (method).
• countable (method).
• countable (method).
• counted-p (method).
• counted-p (method).
• counted-p (method).
• counted-p (method).
• counted-p (method).
• element-at (method).
• element-at (method).
• element-at (method).
• empty (method).
• empty (method).
• empty (method).
• empty (method).
• empty (method).
• empty-p (method).
• empty-p (method).
• empty-p (method).
• empty-p (method).
• empty-p (method).
• head (method).
• head (method).
• head (method).
• indexable (method).
• indexable (method).
• indexable (method).
• seq (method).
• seq (method).
• seq (method).
• seq (method).
• seq (method).
• tail (method).
• tail (method).
• tail (method).
• value-for-key (method).
• value-for-key (method).
• value-for-key (method).
• value-for-key (method).
• value-for-key (method).

---

3.1.16 com.clearly-useful.generic-collection-interface/com.clearly-useful.generic-collection-interface.lisp

Dependency

builtins.lisp (file).

Source

com.clearly-useful.generic-collection-interface.asd.

Parent Component

com.clearly-useful.generic-collection-interface (system).

Packages

• com.clearly-useful.indexable-protocol.
• com.clearly-useful.countable-protocol.
• com.clearly-useful.collection-protocol.
• com.clearly-useful.sequence-protocol.
• com.clearly-useful.foldable-protocol.
• com.clearly-useful.reduceable-protocol.
• com.clearly-useful.associative-protocol.

---

5.1.1 Macros

Macro: doindexable ((var form &optional return-clause) &body body) ¶

bind var to each item in (element-at indexed n) and execute body.
where n is 0..(count-elements indexed)
and indexed is (indexable form)
similar to dolist.

Package

com.clearly-useful.generic-collection-interface.

Source

macros.lisp.

Macro: doseq ((var form &optional return-clause) &body body) ¶

bind var to each item in (seq form) and execute body. similar to dolist.

Package

com.clearly-useful.generic-collection-interface.

Source

macros.lisp.

---

5.1.2 Ordinary functions

Function: collection-p (object) ¶

test if object implements COLLECTION

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Function: countable-p (object) ¶

test if object implements COUNTABLE

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Function: filtering (pred) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

reduceable-base.lisp.

Function: fold (reducefn collection &key divide-by combine-with) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

foldable-base.lisp.

Function: fold-left (fn collection &key initial-value) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

reduceable-base.lisp.

Function: foldable-p (object) ¶

test if object implements FOLDABLE

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Function: folder (collection transformer) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

foldable-base.lisp.

Function: getkey (object key &optional default) ¶

calls associative on object. if the result contains key, returns value-for-key, else default

Package

com.clearly-useful.generic-collection-interface.

Source

methods.lisp.

Function: indexable-p (object) ¶

test if object implements INDEXABLE

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Function: into (coll reduceable) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conj.lisp.

Function: mapcatting (f) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

reduceable-base.lisp.

Function: mapping (fn) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

reduceable-base.lisp.

Function: monoid (fn epsilon) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

reduceable-base.lisp.

Function: reduceable-p (object) ¶

test if object implements REDUCEABLE

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Function: reduced (v) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

reduceable-base.lisp.

Function: reducer (collection transformer) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

reduceable-base.lisp.

Function: seq-p (object) ¶

test if object implements SEQ

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Function: seq-to-list (seq) ¶

a fresh list will all elements of seq

Package

com.clearly-useful.generic-collection-interface.

Source

methods.lisp.

Function: seqable-p (object) ¶

test if object implements SEQABLE

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

---

5.1.3 Generic functions

Generic Function: all-keys (o) ¶

a seq of all keys in o

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: all-keys ((it hash-table)) ¶

Source

builtins.lisp.

Method: all-keys ((it array)) ¶

Source

builtins.lisp.

Method: all-keys ((it vector)) ¶

Source

builtins.lisp.

Method: all-keys ((o cons)) ¶

Source

builtins.lisp.

Method: all-keys ((o null)) ¶

Source

builtins.lisp.

Method: all-keys (thing) ¶

Source

default-methods.lisp.

Method: all-keys ((o %countable-associative)) ¶

Source

conversions.lisp.

Generic Function: all-keys-and-values (o) ¶

return a seq of proper lists in the form (key value)

Package

com.clearly-useful.generic-collection-interface.

Source

methods.lisp.

Methods

Method: all-keys-and-values ((a hash-table)) ¶

Source

builtins.lisp.

Method: all-keys-and-values (o) ¶

Generic Function: all-values (o) ¶

a seq of all values in o

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: all-values ((it hash-table)) ¶

Source

builtins.lisp.

Method: all-values ((it array)) ¶

Source

builtins.lisp.

Method: all-values ((it vector)) ¶

Source

builtins.lisp.

Method: all-values ((o cons)) ¶

Source

builtins.lisp.

Method: all-values ((o null)) ¶

Source

builtins.lisp.

Method: all-values (thing) ¶

Source

default-methods.lisp.

Method: all-values ((o %countable-associative)) ¶

Source

conversions.lisp.

Generic Function: associative (object) ¶

convert an object to ASSOCIATIVE protocol, or error.

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: associative ((object hash-table)) ¶

Source

builtins.lisp.

Method: associative ((object array)) ¶

Source

builtins.lisp.

Method: associative ((object vector)) ¶

Source

builtins.lisp.

Method: associative ((object cons)) ¶

Source

builtins.lisp.

Method: associative ((object null)) ¶

Source

builtins.lisp.

Method: associative (o) ¶

Source

base-methods.lisp.

Method: associative ((object %countable-associative)) ¶

Source

conversions.lisp.

Generic Function: coll-fold (self n combinef reducef) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: coll-fold ((self vector) n combinef reducef) ¶

Source

builtins.lisp.

Method: coll-fold (self n cm rd) ¶

Source

base-methods.lisp.

Method: coll-fold ((self %folder) n combine reduce) ¶

Source

foldable-base.lisp.

Generic Function: coll-reduce (self fn seed) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: coll-reduce ((self hash-table) fn seed) ¶

Source

builtins.lisp.

Method: coll-reduce ((self array) fn seed) ¶

Source

builtins.lisp.

Method: coll-reduce ((self vector) fn seed) ¶

Source

builtins.lisp.

Method: coll-reduce ((self cons) fn seed) ¶

Source

builtins.lisp.

Method: coll-reduce ((self null) fn seed) ¶

Source

builtins.lisp.

Method: coll-reduce (self fn seed) ¶

Source

base-methods.lisp.

Method: coll-reduce ((self %reducer) fn seed) ¶

Source

reduceable-base.lisp.

Generic Function: conj (a val) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conj.lisp.

Methods

Method: conj ((a null) v) ¶

Method: conj ((a cons) v) ¶

Method: conj ((a vector) v) ¶

Method: conj ((a hash-table) v) ¶

Generic Function: contains-key-p (o k) ¶

whether o contains k

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: contains-key-p ((o hash-table) k) ¶

Source

builtins.lisp.

Method: contains-key-p ((it array) key) ¶

Source

builtins.lisp.

Method: contains-key-p ((it vector) key) ¶

Source

builtins.lisp.

Method: contains-key-p ((o cons) key) ¶

Source

builtins.lisp.

Method: contains-key-p ((o null) k) ¶

Source

builtins.lisp.

Method: contains-key-p (thing k) ¶

Source

default-methods.lisp.

Method: contains-key-p ((o %countable-associative) key) ¶

Source

conversions.lisp.

Generic Function: count-elements (o) ¶

the number of elements in o

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: count-elements ((it hash-table)) ¶

Source

builtins.lisp.

Method: count-elements ((it array)) ¶

Source

builtins.lisp.

Method: count-elements ((it vector)) ¶

Source

builtins.lisp.

Method: count-elements ((o cons)) ¶

Source

builtins.lisp.

Method: count-elements ((o null)) ¶

Source

builtins.lisp.

Method: count-elements (thing) ¶

Source

default-methods.lisp.

Method: count-elements ((o %seq-countable)) ¶

Source

conversions.lisp.

Method: count-elements ((range %range)) ¶

Source

conversions.lisp.

Generic Function: countable (object) ¶

convert an object to COUNTABLE protocol, or error.

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: countable ((object hash-table)) ¶

Source

builtins.lisp.

Method: countable ((object array)) ¶

Source

builtins.lisp.

Method: countable ((object vector)) ¶

Source

builtins.lisp.

Method: countable ((object cons)) ¶

Source

builtins.lisp.

Method: countable ((object null)) ¶

Source

builtins.lisp.

Method: countable (o) ¶

Source

base-methods.lisp.

Method: countable ((object %seq-countable)) ¶

Source

conversions.lisp.

Method: countable ((object %range)) ¶

Source

conversions.lisp.

Generic Function: counted-p (o) ¶

whether a collection is counted in constant time

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: counted-p ((it hash-table)) ¶

Source

builtins.lisp.

Method: counted-p ((it array)) ¶

Source

builtins.lisp.

Method: counted-p ((it vector)) ¶

Source

builtins.lisp.

Method: counted-p ((o cons)) ¶

Source

builtins.lisp.

Method: counted-p ((o null)) ¶

Source

builtins.lisp.

Method: counted-p (thing) ¶

Source

default-methods.lisp.

Method: counted-p ((o %seq-countable)) ¶

Source

conversions.lisp.

Method: counted-p ((range %range)) ¶

Source

conversions.lisp.

Generic Function: element-at (o index) ¶

the element of o at index, or raise an error

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: element-at ((it array) n) ¶

Source

builtins.lisp.

Method: element-at ((it vector) n) ¶

Source

builtins.lisp.

Method: element-at ((o null) index) ¶

Source

builtins.lisp.

Method: element-at (thing n) ¶

Source

default-methods.lisp.

Method: element-at ((o %seq-countable) index) ¶

Source

conversions.lisp.

Method: element-at ((range %range) index) ¶

Source

conversions.lisp.

Generic Function: empty (o) ¶

an empty version of this collection

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: empty ((it hash-table)) ¶

Source

builtins.lisp.

Method: empty ((it array)) ¶

Source

builtins.lisp.

Method: empty ((it vector)) ¶

Source

builtins.lisp.

Method: empty ((o cons)) ¶

Source

builtins.lisp.

Method: empty ((o null)) ¶

Source

builtins.lisp.

Method: empty ((o %seq-countable)) ¶

Source

conversions.lisp.

Method: empty ((o %countable-associative)) ¶

Source

conversions.lisp.

Method: empty ((c %countable-sequence)) ¶

Source

conversions.lisp.

Method: empty ((range %range)) ¶

Source

conversions.lisp.

Method: empty (o) ¶

Generic Function: empty-p (o) ¶

wether this collection is empty

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: empty-p ((it hash-table)) ¶

Source

builtins.lisp.

Method: empty-p ((it array)) ¶

Source

builtins.lisp.

Method: empty-p ((it vector)) ¶

Source

builtins.lisp.

Method: empty-p ((o cons)) ¶

Source

builtins.lisp.

Method: empty-p ((o null)) ¶

Source

builtins.lisp.

Method: empty-p ((o %seq-countable)) ¶

Source

conversions.lisp.

Method: empty-p ((o %countable-associative)) ¶

Source

conversions.lisp.

Method: empty-p ((c %countable-sequence)) ¶

Source

conversions.lisp.

Method: empty-p ((range %range)) ¶

Source

conversions.lisp.

Method: empty-p (o) ¶

Generic Function: head (o) ¶

first element

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: head ((it vector)) ¶

Source

builtins.lisp.

Method: head ((o cons)) ¶

Source

builtins.lisp.

Method: head ((o null)) ¶

Source

builtins.lisp.

Method: head (thing) ¶

Source

default-methods.lisp.

Method: head ((c %countable-sequence)) ¶

Source

conversions.lisp.

Method: head ((range %range)) ¶

Source

conversions.lisp.

Generic Function: indexable (object) ¶

convert an object to INDEXABLE protocol, or error.

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: indexable ((object array)) ¶

Source

builtins.lisp.

Method: indexable ((object vector)) ¶

Source

builtins.lisp.

Method: indexable ((object null)) ¶

Source

builtins.lisp.

Method: indexable (o) ¶

Source

base-methods.lisp.

Method: indexable ((object %seq-countable)) ¶

Source

conversions.lisp.

Method: indexable ((object %range)) ¶

Source

conversions.lisp.

Generic Function: seq (o) ¶

return a seq (or nil if count = 0) or error

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: seq ((it hash-table)) ¶

Source

builtins.lisp.

Method: seq ((it array)) ¶

Source

builtins.lisp.

Method: seq ((it vector)) ¶

Source

builtins.lisp.

Method: seq ((o cons)) ¶

Source

builtins.lisp.

Method: seq ((o null)) ¶

Source

builtins.lisp.

Method: seq (o) ¶

Source

base-methods.lisp.

Method: seq ((c %countable-sequence)) ¶

Source

conversions.lisp.

Method: seq ((range %range)) ¶

Source

conversions.lisp.

Generic Function: tail (o) ¶

the rest of the collection or nil

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: tail ((it vector)) ¶

Source

builtins.lisp.

Method: tail ((o cons)) ¶

Source

builtins.lisp.

Method: tail ((o null)) ¶

Source

builtins.lisp.

Method: tail (thing) ¶

Source

default-methods.lisp.

Method: tail ((c %countable-sequence)) ¶

Source

conversions.lisp.

Method: tail ((range %range)) ¶

Source

conversions.lisp.

Generic Function: value-for-key (o k) ¶

returns the value of k in o and t, or (values nil nil)

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Methods

Method: value-for-key ((o hash-table) k) ¶

Source

builtins.lisp.

Method: value-for-key ((it array) key) ¶

Source

builtins.lisp.

Method: value-for-key ((it vector) key) ¶

Source

builtins.lisp.

Method: value-for-key ((o cons) index) ¶

Source

builtins.lisp.

Method: value-for-key ((o null) k) ¶

Source

builtins.lisp.

Method: value-for-key (thing k) ¶

Source

default-methods.lisp.

Method: value-for-key ((o %countable-associative) key) ¶

Source

conversions.lisp.

---

5.1.4 Types

Type: associative () ¶

a dictionary-like abstraction

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Type: collection () ¶

a collection knows if it is empty, and can produce an empty version of itself

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Type: countable () ¶

countable collection

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Type: foldable () ¶

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Type: indexable () ¶

a thing that may be indexed

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Type: reduceable () ¶

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Type: seq () ¶

a list-like abstraction

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Type: seqable () ¶

a thing that may be converted to a seq default implementation provided for indexable, associative and seq.

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

---

5.2.1 Macros

Macro: define-interface-package (name documentation &rest exports) ¶

create a package named name with documentation which uses :cl and *package*, exporting the symbols of exports.

Package

com.clearly-useful.generic-collection-interface.

Source

internal-utils.lisp.

Macro: with-fold-kernel (&body body) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

foldable-base.lisp.

---

5.2.2 Ordinary functions

Function: %%%%.defpun.fold-vector (kernel0 v n combiner reducer) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

parallel.lisp.

Function: %adjustable (vector &optional pad) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

internal-utils.lisp.

Function: %associative-to-indexable (assoc) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: %count-seq (seq) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Reader: %countable-associative-countable (instance) ¶

Writer: (setf %countable-associative-countable) (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Target Slot

countable.

Reader: %countable-associative-length (instance) ¶

Writer: (setf %countable-associative-length) (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Target Slot

length.

Function: %countable-associative-p (object) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Reader: %countable-sequence-countable (instance) ¶

Writer: (setf %countable-sequence-countable) (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Target Slot

countable.

Reader: %countable-sequence-index (instance) ¶

Writer: (setf %countable-sequence-index) (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Target Slot

index.

Reader: %countable-sequence-length (instance) ¶

Writer: (setf %countable-sequence-length) (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Target Slot

length.

Function: %countable-sequence-p (object) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: %countable-sequence-size (c) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: %countable-to-associative (countable) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: %countable-to-seq (countable) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: %dup-hash (it) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

internal-utils.lisp.

Function: %empty-hash (it) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

internal-utils.lisp.

Function: %folder-coll (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

foldable-base.lisp.

Function: (setf %folder-coll) (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

foldable-base.lisp.

Function: %folder-p (object) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

foldable-base.lisp.

Function: %folder-transformer (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

foldable-base.lisp.

Function: (setf %folder-transformer) (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

foldable-base.lisp.

Function: %hash-conj! (ht seq) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conj.lisp.

Function: %interface-package (name documentation &rest exports) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

internal-utils.lisp.

Function: %next-countable-sequence (c) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: %next-range (range) ¶

return the next range by incrementing the lower bound of range, or nil

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Reader: %range-high (instance) ¶

Writer: (setf %range-high) (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Target Slot

high.

Reader: %range-low (instance) ¶

Writer: (setf %range-low) (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Target Slot

low.

Function: %range-p (object) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: %range-size (range) ¶

the number of elements in a range

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: %reduce (fn collection &key initial-value) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

reduceable-base.lisp.

Reader: %reducer-coll (instance) ¶

Writer: (setf %reducer-coll) (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

reduceable-base.lisp.

Target Slot

coll.

Function: %reducer-p (object) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

reduceable-base.lisp.

Reader: %reducer-transformer (instance) ¶

Writer: (setf %reducer-transformer) (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

reduceable-base.lisp.

Target Slot

transformer.

Function: %seq-countable-contains-index (sc index) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: %seq-countable-count (sc) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Reader: %seq-countable-fully-counted (instance) ¶

Writer: (setf %seq-countable-fully-counted) (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Target Slot

fully-counted.

Function: %seq-countable-p (object) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Reader: %seq-countable-seq (instance) ¶

Writer: (setf %seq-countable-seq) (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Target Slot

seq.

Reader: %seq-countable-ubound (instance) ¶

Writer: (setf %seq-countable-ubound) (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Target Slot

ubound.

Function: %seq-indexable-by (seq n) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: %seq-nth-or-error (seq n) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: %seq-nth-or-nil-with-values (seq n) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: %seq-to-associative (seq) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: %seq-to-countable (seq) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: %seq-to-list (seq) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: %vector-conj! (adjustable-vector val) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conj.lisp.

Function: associative-p (object) ¶

test if object implements ASSOCIATIVE

Package

com.clearly-useful.generic-collection-interface.

Source

protocols.lisp.

Function: copy-%countable-associative (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: copy-%countable-sequence (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: copy-%folder (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

foldable-base.lisp.

Function: copy-%range (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: copy-%reducer (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

reduceable-base.lisp.

Function: copy-%seq-countable (instance) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: fold-vector (v n combiner reducer) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

parallel.lisp.

Function: make-%countable-associative (&key length countable) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: make-%countable-sequence (&key length index countable) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: make-%folder (&key coll transformer) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

foldable-base.lisp.

Function: make-%range (&key low high) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: make-%reducer (&key coll transformer) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

reduceable-base.lisp.

Function: make-%seq-countable (&key seq ubound fully-counted) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

conversions.lisp.

Function: reduce-indexable (r fn seed) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

reduceable-base.lisp.

Function: reduce-seq (r fn seed) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

reduceable-base.lisp.

Function: reduceable-reduce (fn collection &key initial-value) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

reduceable-base.lisp.

Function: subvec (vec start &optional end) ¶

Package

com.clearly-useful.generic-collection-interface.

Source

internal-utils.lisp.

---

5.2.3 Standalone methods

Method: implements-protocol? ((object %seq-countable) (protocol (eql #<com.clearly-useful.protocols::protocol {100ac43f73}>))) ¶

Package

com.clearly-useful.protocols.

Source

conversions.lisp.

Method: implements-protocol? ((object %seq-countable) (protocol (eql #<com.clearly-useful.protocols::protocol {100ac43f83}>))) ¶

Package

com.clearly-useful.protocols.

Source

conversions.lisp.

Method: implements-protocol? ((object %seq-countable) (protocol (eql #<com.clearly-useful.protocols::protocol {100ac43f93}>))) ¶

Package

com.clearly-useful.protocols.

Source

conversions.lisp.

Method: implements-protocol? ((object %countable-associative) (protocol (eql #<com.clearly-useful.protocols::protocol {100ac43fa3}>))) ¶

Package

com.clearly-useful.protocols.

Source

conversions.lisp.

Method: implements-protocol? ((object %countable-associative) (protocol (eql #<com.clearly-useful.protocols::protocol {100ac43f93}>))) ¶

Package

com.clearly-useful.protocols.

Source

conversions.lisp.

Method: implements-protocol? ((object %countable-sequence) (protocol (eql #<com.clearly-useful.protocols::protocol {100ac43fb3}>))) ¶

Package

com.clearly-useful.protocols.

Source

conversions.lisp.

Method: implements-protocol? ((object %countable-sequence) (protocol (eql #<com.clearly-useful.protocols::protocol {100ac43fc3}>))) ¶

Package

com.clearly-useful.protocols.

Source

conversions.lisp.

Method: implements-protocol? ((object %countable-sequence) (protocol (eql #<com.clearly-useful.protocols::protocol {100ac43f93}>))) ¶

Package

com.clearly-useful.protocols.

Source

conversions.lisp.

Method: implements-protocol? ((object %folder) (protocol (eql #<com.clearly-useful.protocols::protocol {100ad99eb3}>))) ¶

Package

com.clearly-useful.protocols.

Source

foldable-base.lisp.

Method: implements-protocol? ((object %range) (protocol (eql #<com.clearly-useful.protocols::protocol {100ac43f73}>))) ¶

Package

com.clearly-useful.protocols.

Source

conversions.lisp.

Method: implements-protocol? ((object %range) (protocol (eql #<com.clearly-useful.protocols::protocol {100ac43f83}>))) ¶

Package

com.clearly-useful.protocols.

Source

conversions.lisp.

Method: implements-protocol? ((object %range) (protocol (eql #<com.clearly-useful.protocols::protocol {100ac43fb3}>))) ¶

Package

com.clearly-useful.protocols.

Source

conversions.lisp.

Method: implements-protocol? ((object %range) (protocol (eql #<com.clearly-useful.protocols::protocol {100ac43fc3}>))) ¶

Package

com.clearly-useful.protocols.

Source

conversions.lisp.

Method: implements-protocol? ((object %range) (protocol (eql #<com.clearly-useful.protocols::protocol {100ac43f93}>))) ¶

Package

com.clearly-useful.protocols.

Source

conversions.lisp.

Method: implements-protocol? ((object %reducer) (protocol (eql #<com.clearly-useful.protocols::protocol {100ac43f63}>))) ¶

Package

com.clearly-useful.protocols.

Source

reduceable-base.lisp.

---