The generalized-reference Reference Manual

This is the generalized-reference Reference Manual, version 1.0.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 06:13:18 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 generalized-reference

Generalized reference over structured data by pairwise reduction of arbitrary place identifiers for Common Lisp.

Author

"the Phoeron" Colin J.E. Lupton

Contact

Source Control

https://github.com/thephoeron/generalized-reference/

Bug Tracker

https://github.com/thephoeron/generalized-reference/issues/

License

MIT

Version

1.0.3

Dependencies
  • closer-mop (system).
  • alexandria (system).
  • serapeum (system).
  • split-sequence (system).
  • trivial-types (system).
  • series (system).
Source

generalized-reference.asd.

Child Component

generalized-reference.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 generalized-reference/generalized-reference.asd

Source

generalized-reference.asd.

Parent Component

generalized-reference (system).

ASDF Systems

generalized-reference.

Packages

generalized-reference/asdf.


3.1.2 generalized-reference/generalized-reference.lisp

Source

generalized-reference.asd.

Parent Component

generalized-reference (system).

Packages

generalized-reference.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 generalized-reference

Source

generalized-reference.lisp.

Nicknames
  • gref
  • genref
  • gen-ref
Use List
  • closer-common-lisp.
  • series.
  • split-sequence.
Public Interface
Internals

4.2 generalized-reference/asdf

Source

generalized-reference.asd.

Use List
  • asdf/interface.
  • common-lisp.
  • uiop/driver.

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: $ (&rest references)

Convenience macro for generalized reference.

Package

generalized-reference.

Source

generalized-reference.lisp.


5.1.2 Ordinary functions

Function: ref (&rest references)

The main interface for generalized reference by pairwise reduction over a parameter list of place identifiers.

Package

generalized-reference.

Source

generalized-reference.lisp.

Function: series-p (obj)
Package

generalized-reference.

Source

generalized-reference.lisp.


5.1.3 Generic functions

Generic Function: %ref (alice rabbit-hole)

The generic function for reducing pairwise over arbitrary structures of data by place identifier.

Package

generalized-reference.

Source

generalized-reference.lisp.

Methods
Method: %ref ((store structure-object) (key function))
Method: %ref ((store structure-object) (indices sequence))
Method: %ref ((store structure-object) (index integer))
Method: %ref ((store structure-object) (selection structure-object))
Method: %ref ((store symbol) (prop symbol))
Method: %ref ((store array) (indices sequence))
Method: %ref ((store vector) (index integer))
Method: %ref ((store list) (key string))
Method: %ref ((store list) (key symbol))
Method: %ref ((store hash-table) hash-key)
Method: %ref ((store standard-object) (slot-name string))
Method: %ref ((store standard-object) (slot-name symbol))
Method: %ref ((psym pseudosymbol) (sym-name string))
Method: %ref ((psym pseudosymbol) (sym symbol))
Method: %ref ((pkg package) (sym symbol))

5.2 Internals


5.2.1 Generic functions

Generic Reader: pseudosymbol-function (object)
Package

generalized-reference.

Methods
Reader Method: pseudosymbol-function ((pseudosymbol pseudosymbol))

automatically generated reader method

Source

generalized-reference.lisp.

Target Slot

function-slot.

Generic Writer: (setf pseudosymbol-function) (object)
Package

generalized-reference.

Methods
Writer Method: (setf pseudosymbol-function) ((pseudosymbol pseudosymbol))

automatically generated writer method

Source

generalized-reference.lisp.

Target Slot

function-slot.

Generic Reader: pseudosymbol-name (object)
Package

generalized-reference.

Methods
Reader Method: pseudosymbol-name ((pseudosymbol pseudosymbol))

automatically generated reader method

Source

generalized-reference.lisp.

Target Slot

name.

Generic Writer: (setf pseudosymbol-name) (object)
Package

generalized-reference.

Methods
Writer Method: (setf pseudosymbol-name) ((pseudosymbol pseudosymbol))

automatically generated writer method

Source

generalized-reference.lisp.

Target Slot

name.

Generic Reader: pseudosymbol-package-name (object)
Package

generalized-reference.

Methods
Reader Method: pseudosymbol-package-name ((pseudosymbol pseudosymbol))

automatically generated reader method

Source

generalized-reference.lisp.

Target Slot

pkg-name.

Generic Writer: (setf pseudosymbol-package-name) (object)
Package

generalized-reference.

Methods
Writer Method: (setf pseudosymbol-package-name) ((pseudosymbol pseudosymbol))

automatically generated writer method

Source

generalized-reference.lisp.

Target Slot

pkg-name.

Generic Reader: pseudosymbol-plist (object)
Package

generalized-reference.

Methods
Reader Method: pseudosymbol-plist ((pseudosymbol pseudosymbol))

automatically generated reader method

Source

generalized-reference.lisp.

Target Slot

plist.

Generic Writer: (setf pseudosymbol-plist) (object)
Package

generalized-reference.

Methods
Writer Method: (setf pseudosymbol-plist) ((pseudosymbol pseudosymbol))

automatically generated writer method

Source

generalized-reference.lisp.

Target Slot

plist.

Generic Reader: pseudosymbol-value (object)
Package

generalized-reference.

Methods
Reader Method: pseudosymbol-value ((pseudosymbol pseudosymbol))

automatically generated reader method

Source

generalized-reference.lisp.

Target Slot

value-slot.

Generic Writer: (setf pseudosymbol-value) (object)
Package

generalized-reference.

Methods
Writer Method: (setf pseudosymbol-value) ((pseudosymbol pseudosymbol))

automatically generated writer method

Source

generalized-reference.lisp.

Target Slot

value-slot.


5.2.2 Classes

Class: pseudosymbol
Package

generalized-reference.

Source

generalized-reference.lisp.

Direct methods
Direct slots
Slot: name
Type

alexandria:string-designator

Initargs

:name

Readers

pseudosymbol-name.

Writers

(setf pseudosymbol-name).

Slot: pkg-name
Type

(or alexandria:string-designator nil)

Initargs

:package-name

Readers

pseudosymbol-package-name.

Writers

(setf pseudosymbol-package-name).

Slot: value-slot
Initargs

:value

Readers

pseudosymbol-value.

Writers

(setf pseudosymbol-value).

Slot: function-slot
Initargs

:function

Readers

pseudosymbol-function.

Writers

(setf pseudosymbol-function).

Slot: plist
Type

trivial-types:property-list

Initargs

:plist

Readers

pseudosymbol-plist.

Writers

(setf pseudosymbol-plist).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   $   %   (  
F   G   M   P   R   S  
Index Entry  Section

$
$: Public macros

%
%ref: Public generic functions
%ref: Public generic functions
%ref: Public generic functions
%ref: Public generic functions
%ref: Public generic functions
%ref: Public generic functions
%ref: Public generic functions
%ref: Public generic functions
%ref: Public generic functions
%ref: Public generic functions
%ref: Public generic functions
%ref: Public generic functions
%ref: Public generic functions
%ref: Public generic functions
%ref: Public generic functions
%ref: Public generic functions

(
(setf pseudosymbol-function): Private generic functions
(setf pseudosymbol-function): Private generic functions
(setf pseudosymbol-name): Private generic functions
(setf pseudosymbol-name): Private generic functions
(setf pseudosymbol-package-name): Private generic functions
(setf pseudosymbol-package-name): Private generic functions
(setf pseudosymbol-plist): Private generic functions
(setf pseudosymbol-plist): Private generic functions
(setf pseudosymbol-value): Private generic functions
(setf pseudosymbol-value): Private generic functions

F
Function, ref: Public ordinary functions
Function, series-p: Public ordinary functions

G
Generic Function, %ref: Public generic functions
Generic Function, (setf pseudosymbol-function): Private generic functions
Generic Function, (setf pseudosymbol-name): Private generic functions
Generic Function, (setf pseudosymbol-package-name): Private generic functions
Generic Function, (setf pseudosymbol-plist): Private generic functions
Generic Function, (setf pseudosymbol-value): Private generic functions
Generic Function, pseudosymbol-function: Private generic functions
Generic Function, pseudosymbol-name: Private generic functions
Generic Function, pseudosymbol-package-name: Private generic functions
Generic Function, pseudosymbol-plist: Private generic functions
Generic Function, pseudosymbol-value: Private generic functions

M
Macro, $: Public macros
Method, %ref: Public generic functions
Method, %ref: Public generic functions
Method, %ref: Public generic functions
Method, %ref: Public generic functions
Method, %ref: Public generic functions
Method, %ref: Public generic functions
Method, %ref: Public generic functions
Method, %ref: Public generic functions
Method, %ref: Public generic functions
Method, %ref: Public generic functions
Method, %ref: Public generic functions
Method, %ref: Public generic functions
Method, %ref: Public generic functions
Method, %ref: Public generic functions
Method, %ref: Public generic functions
Method, (setf pseudosymbol-function): Private generic functions
Method, (setf pseudosymbol-name): Private generic functions
Method, (setf pseudosymbol-package-name): Private generic functions
Method, (setf pseudosymbol-plist): Private generic functions
Method, (setf pseudosymbol-value): Private generic functions
Method, pseudosymbol-function: Private generic functions
Method, pseudosymbol-name: Private generic functions
Method, pseudosymbol-package-name: Private generic functions
Method, pseudosymbol-plist: Private generic functions
Method, pseudosymbol-value: Private generic functions

P
pseudosymbol-function: Private generic functions
pseudosymbol-function: Private generic functions
pseudosymbol-name: Private generic functions
pseudosymbol-name: Private generic functions
pseudosymbol-package-name: Private generic functions
pseudosymbol-package-name: Private generic functions
pseudosymbol-plist: Private generic functions
pseudosymbol-plist: Private generic functions
pseudosymbol-value: Private generic functions
pseudosymbol-value: Private generic functions

R
ref: Public ordinary functions

S
series-p: Public ordinary functions