The trivial-variable-bindings Reference Manual

This is the trivial-variable-bindings Reference Manual, version 0.1.7, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 07:12:17 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 trivial-variable-bindings

Offers a way to handle associations between a place-holder (aka. variable) and a value.

Author

Eric Diethelm <>

License

MIT

Version

0.1.7

Dependencies
  • trivial-utilities (system).
  • iterate (system).
Source

trivial-variable-bindings.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 trivial-variable-bindings/trivial-variable-bindings.asd

Source

trivial-variable-bindings.asd.

Parent Component

trivial-variable-bindings (system).

ASDF Systems

trivial-variable-bindings.


3.1.3 trivial-variable-bindings/trivial-variable-bindings.lisp

Source

trivial-variable-bindings.asd.

Parent Component

trivial-variable-bindings (system).

Public Interface

4 Packages

Packages are listed by definition order.


4.1 trivial-variable-bindings

Source

package.lisp.

Use List

common-lisp.

Public Interface

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: bound-variable-value (var bindings)

Return the value associated to the *place-holder* **VAR** in the *bindings* container **BINDINGS**, if any. Otherwise return the *place-holder* **VAR** itself.

Package

trivial-variable-bindings.

Source

trivial-variable-bindings.lisp.

Function: (setf bound-variable-value) (var bindings)
Package

trivial-variable-bindings.

Source

trivial-variable-bindings.lisp.

Function: contains (var bindings)

Verify that a *place-holder* **VAR** is bound to a specific value in the *bindings* container **BINDINGS**.

Package

trivial-variable-bindings.

Source

trivial-variable-bindings.lisp.

Function: remove-bound-variable (var bindings)

Delete the bound *place-holder* **VAR** in the *bindings* container **BINDINGS**.

Package

trivial-variable-bindings.

Source

trivial-variable-bindings.lisp.


5.1.2 Generic functions

Generic Reader: bound-value (object)
Package

trivial-variable-bindings.

Methods
Reader Method: bound-value ((variable-binding variable-binding))

automatically generated reader method

Source

trivial-variable-bindings.lisp.

Target Slot

value.

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

trivial-variable-bindings.

Methods
Writer Method: (setf bound-value) ((variable-binding variable-binding))

automatically generated writer method

Source

trivial-variable-bindings.lisp.

Target Slot

value.

Generic Reader: bound-variable (object)
Package

trivial-variable-bindings.

Methods
Reader Method: bound-variable ((variable-binding variable-binding))

automatically generated reader method

Source

trivial-variable-bindings.lisp.

Target Slot

variable.

Generic Reader: bound-variables (object)
Package

trivial-variable-bindings.

Methods
Reader Method: bound-variables ((bindings bindings))

automatically generated reader method

Source

trivial-variable-bindings.lisp.

Target Slot

bound-variables.

Generic Writer: (setf bound-variables) (object)
Package

trivial-variable-bindings.

Methods
Writer Method: (setf bound-variables) ((bindings bindings))

automatically generated writer method

Source

trivial-variable-bindings.lisp.

Target Slot

bound-variables.

Generic Reader: place-holder-name (object)
Package

trivial-variable-bindings.

Methods
Reader Method: place-holder-name ((place-holder place-holder))

automatically generated reader method

Source

trivial-variable-bindings.lisp.

Target Slot

name.


5.1.3 Standalone methods

Method: clone ((bindings bindings) &key &allow-other-keys)

Make a deep copy of the given *bindings* container **BINDINGS**.

Package

trivial-utilities.

Source

trivial-variable-bindings.lisp.

Method: equals ((lhs place-holder) (rhs place-holder) &key &allow-other-keys)

Compares two place-holder for equality. Only equally named place-holders are equal.

Package

trivial-utilities.

Source

trivial-variable-bindings.lisp.

Method: equals ((lhs bindings) (rhs bindings) &key &allow-other-keys)

Compares two bindings for equality.

Package

trivial-utilities.

Source

trivial-variable-bindings.lisp.

Method: equals ((lhs variable-binding) (rhs variable-binding) &key &allow-other-keys)

Compares two bound-variables for equality.

Package

trivial-utilities.

Source

trivial-variable-bindings.lisp.

Method: print-object ((var place-holder) out)
Source

trivial-variable-bindings.lisp.

Method: print-object ((var bindings) out)
Source

trivial-variable-bindings.lisp.

Method: print-object ((var variable-binding) out)
Source

trivial-variable-bindings.lisp.


5.1.4 Classes

Class: bindings

A set of named variabled bound to corresponding values.

Package

trivial-variable-bindings.

Source

trivial-variable-bindings.lisp.

Direct methods
Direct slots
Slot: bound-variables
Type

list

Initargs

:bound-variables

Readers

bound-variables.

Writers

(setf bound-variables).

Class: place-holder

A named variable.

Package

trivial-variable-bindings.

Source

trivial-variable-bindings.lisp.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

place-holder-name.

Writers

This slot is read-only.

Class: variable-binding

The binding of a named variable to a specific value.

Package

trivial-variable-bindings.

Source

trivial-variable-bindings.lisp.

Direct methods
Direct slots
Slot: variable
Package

common-lisp.

Type

trivial-variable-bindings:place-holder

Initargs

:bound-variable

Readers

bound-variable.

Writers

This slot is read-only.

Slot: value
Initargs

:bound-value

Readers

bound-value.

Writers

(setf bound-value).


5.2 Internals


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
B   C   E   F   G   M   P   R  
Index Entry  Section

(
(setf bound-value): Public generic functions
(setf bound-value): Public generic functions
(setf bound-variable-value): Public ordinary functions
(setf bound-variables): Public generic functions
(setf bound-variables): Public generic functions

B
bound-value: Public generic functions
bound-value: Public generic functions
bound-variable: Public generic functions
bound-variable: Public generic functions
bound-variable-value: Public ordinary functions
bound-variables: Public generic functions
bound-variables: Public generic functions

C
clone: Public standalone methods
contains: Public ordinary functions

E
equals: Public standalone methods
equals: Public standalone methods
equals: Public standalone methods

F
Function, (setf bound-variable-value): Public ordinary functions
Function, bound-variable-value: Public ordinary functions
Function, contains: Public ordinary functions
Function, remove-bound-variable: Public ordinary functions

G
Generic Function, (setf bound-value): Public generic functions
Generic Function, (setf bound-variables): Public generic functions
Generic Function, bound-value: Public generic functions
Generic Function, bound-variable: Public generic functions
Generic Function, bound-variables: Public generic functions
Generic Function, place-holder-name: Public generic functions

M
Method, (setf bound-value): Public generic functions
Method, (setf bound-variables): Public generic functions
Method, bound-value: Public generic functions
Method, bound-variable: Public generic functions
Method, bound-variables: Public generic functions
Method, clone: Public standalone methods
Method, equals: Public standalone methods
Method, equals: Public standalone methods
Method, equals: Public standalone methods
Method, place-holder-name: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods

P
place-holder-name: Public generic functions
place-holder-name: Public generic functions
print-object: Public standalone methods
print-object: Public standalone methods
print-object: Public standalone methods

R
remove-bound-variable: Public ordinary functions


A.3 Variables