Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The slot-map Reference Manual

This is the slot-map Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:54:29 2024 GMT+0.

Next: Systems, Previous: The slot-map Reference Manual, Up: The slot-map Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The slot-map Reference Manual [Contents][Index]

2 Systems

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

slot-map

Previous: Systems, Up: Systems [Contents][Index]

2.1 `slot-map`

An implementation of the slot-map data structure.

Author

Michael Fiano <mail@mfiano.net>

Home Page

https://git.mfiano.net/mfiano/slot-map

License

MIT

Version

0.1.0

Dependencies

dynamic-array (system).
mfiano-utils (system).

Source

slot-map.asd.

Child Components

package.lisp (file).
slot-map.lisp (file).

Next: Packages, Previous: Systems, Up: The slot-map Reference Manual [Contents][Index]

3 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

Next: slot-map/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `slot-map/slot-map.asd`

Source: slot-map.asd.
Parent Component: slot-map (system).
ASDF Systems: slot-map.

Next: slot-map/slot-map.lisp, Previous: slot-map/slot-map.asd, Up: Lisp [Contents][Index]

3.1.2 `slot-map/package.lisp`

Source: slot-map.asd.
Parent Component: slot-map (system).
Packages: slot-map.

Previous: slot-map/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `slot-map/slot-map.lisp`

Dependency

package.lisp (file).

Source

slot-map.asd.

Parent Component

slot-map (system).

Public Interface

delete (function).
find (function).
insert (function).
make-slot-map (function).
map-keys (function).
map-values (function).
print-object (method).

Internals

%make-slot-map (function).
+id-bits+ (constant).
+version-bits+ (constant).
data (reader).
(setf data) (writer).
dequeue-free (function).
enqueue-free (function).
free-head (reader).
(setf free-head) (writer).
free-tail (reader).
(setf free-tail) (writer).
id (function).
pack (function).
repack-id (macro).
reverse-map (reader).
(setf reverse-map) (writer).
slot-map (structure).
slots (reader).
(setf slots) (writer).
unpack (function).
version (function).

Next: Definitions, Previous: Files, Up: The slot-map Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

slot-map

Previous: Packages, Up: Packages [Contents][Index]

4.1 `slot-map`

Source

package.lisp.

Use List

common-lisp.

Public Interface

delete (function).
find (function).
insert (function).
make-slot-map (function).
map-keys (function).
map-values (function).

Internals

%make-slot-map (function).
+id-bits+ (constant).
+version-bits+ (constant).
data (reader).
(setf data) (writer).
dequeue-free (function).
enqueue-free (function).
free-head (reader).
(setf free-head) (writer).
free-tail (reader).
(setf free-tail) (writer).
id (function).
pack (function).
repack-id (macro).
reverse-map (reader).
(setf reverse-map) (writer).
slot-map (structure).
slots (reader).
(setf slots) (writer).
unpack (function).
version (function).

Next: Indexes, Previous: Packages, Up: The slot-map Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Ordinary functions
Standalone methods

Next: Standalone methods, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Function: delete (slot-map key) ¶

Package: slot-map.
Source: slot-map.lisp.

Function: find (slot-map key) ¶

Package: slot-map.
Source: slot-map.lisp.

Function: insert (slot-map value) ¶

Package: slot-map.
Source: slot-map.lisp.

Function: make-slot-map (&key capacity initial-element data-type) ¶

Package: slot-map.
Source: slot-map.lisp.

Function: map-keys (slot-map func) ¶

Package: slot-map.
Source: slot-map.lisp.

Function: map-values (slot-map func) ¶

Package: slot-map.
Source: slot-map.lisp.

Previous: Ordinary functions, Up: Public Interface [Contents][Index]

5.1.2 Standalone methods

Method: print-object ((slot-map slot-map) stream) ¶

Source: slot-map.lisp.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Constants
Macros
Ordinary functions
Structures

Next: Macros, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Constants

Constant: +id-bits+ ¶

Package: slot-map.
Source: slot-map.lisp.

Constant: +version-bits+ ¶

Package: slot-map.
Source: slot-map.lisp.

Next: Ordinary functions, Previous: Constants, Up: Internals [Contents][Index]

5.2.2 Macros

Macro: repack-id (place id) ¶

Package: slot-map.
Source: slot-map.lisp.

Next: Structures, Previous: Macros, Up: Internals [Contents][Index]

5.2.3 Ordinary functions

Function: %make-slot-map (&key data slots reverse-map free-head free-tail) ¶

Package: slot-map.
Source: slot-map.lisp.

Reader: data (instance) ¶

Writer: (setf data) (instance) ¶

Package: slot-map.
Source: slot-map.lisp.
Target Slot: data.

Function: dequeue-free (slot-map) ¶

Package: slot-map.
Source: slot-map.lisp.

Function: enqueue-free (slot-map key) ¶

Package: slot-map.
Source: slot-map.lisp.

Reader: free-head (instance) ¶

Writer: (setf free-head) (instance) ¶

Package: slot-map.
Source: slot-map.lisp.
Target Slot: free-head.

Reader: free-tail (instance) ¶

Writer: (setf free-tail) (instance) ¶

Package: slot-map.
Source: slot-map.lisp.
Target Slot: free-tail.

Function: id (packed) ¶

Package: slot-map.
Source: slot-map.lisp.

Function: pack (id version) ¶

Package: slot-map.
Source: slot-map.lisp.

Reader: reverse-map (instance) ¶

Writer: (setf reverse-map) (instance) ¶

Package: slot-map.
Source: slot-map.lisp.
Target Slot: reverse-map.

Reader: slots (instance) ¶

Writer: (setf slots) (instance) ¶

Package: slot-map.
Source: slot-map.lisp.
Target Slot: slots.

Function: unpack (packed) ¶

Package: slot-map.
Source: slot-map.lisp.

Function: version (packed) ¶

Package: slot-map.
Source: slot-map.lisp.

Previous: Ordinary functions, Up: Internals [Contents][Index]

5.2.4 Structures

Structure: slot-map ¶

Package

slot-map.

Source

slot-map.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots

Slot: data ¶

Type: vector
Initform: (make-array 0 :adjustable t :fill-pointer 0)
Readers: data.
Writers: (setf data).

Slot: slots ¶

Type: dynamic-array:dynamic-array
Initform: (dynamic-array:make-array)
Readers: slots.
Writers: (setf slots).

Slot: reverse-map ¶

Type: dynamic-array:dynamic-array
Initform: (dynamic-array:make-array)
Readers: reverse-map.
Writers: (setf reverse-map).

Slot: free-head ¶

Type: (or null mfiano-utils:ub24)
Readers: free-head.
Writers: (setf free-head).

Slot: free-tail ¶

Type: (or null mfiano-utils:ub24)
Readers: free-tail.
Writers: (setf free-tail).

Previous: Definitions, Up: The slot-map Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	% ( D E F I M P R S U V

	Index Entry	Section

%
	`%make-slot-map`:	Private ordinary functions

(
	`(setf data)`:	Private ordinary functions
	`(setf free-head)`:	Private ordinary functions
	`(setf free-tail)`:	Private ordinary functions
	`(setf reverse-map)`:	Private ordinary functions
	`(setf slots)`:	Private ordinary functions

D
	`data`:	Private ordinary functions
	`delete`:	Public ordinary functions
	`dequeue-free`:	Private ordinary functions

E
	`enqueue-free`:	Private ordinary functions

F
	`find`:	Public ordinary functions
	`free-head`:	Private ordinary functions
	`free-tail`:	Private ordinary functions
	`Function, %make-slot-map`:	Private ordinary functions
	`Function, (setf data)`:	Private ordinary functions
	`Function, (setf free-head)`:	Private ordinary functions
	`Function, (setf free-tail)`:	Private ordinary functions
	`Function, (setf reverse-map)`:	Private ordinary functions
	`Function, (setf slots)`:	Private ordinary functions
	`Function, data`:	Private ordinary functions
	`Function, delete`:	Public ordinary functions
	`Function, dequeue-free`:	Private ordinary functions
	`Function, enqueue-free`:	Private ordinary functions
	`Function, find`:	Public ordinary functions
	`Function, free-head`:	Private ordinary functions
	`Function, free-tail`:	Private ordinary functions
	`Function, id`:	Private ordinary functions
	`Function, insert`:	Public ordinary functions
	`Function, make-slot-map`:	Public ordinary functions
	`Function, map-keys`:	Public ordinary functions
	`Function, map-values`:	Public ordinary functions
	`Function, pack`:	Private ordinary functions
	`Function, reverse-map`:	Private ordinary functions
	`Function, slots`:	Private ordinary functions
	`Function, unpack`:	Private ordinary functions
	`Function, version`:	Private ordinary functions

I
	`id`:	Private ordinary functions
	`insert`:	Public ordinary functions

M
	`Macro, repack-id`:	Private macros
	`make-slot-map`:	Public ordinary functions
	`map-keys`:	Public ordinary functions
	`map-values`:	Public ordinary functions
	`Method, print-object`:	Public standalone methods

P
	`pack`:	Private ordinary functions
	`print-object`:	Public standalone methods

R
	`repack-id`:	Private macros
	`reverse-map`:	Private ordinary functions

S
	`slots`:	Private ordinary functions

U
	`unpack`:	Private ordinary functions

V
	`version`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	+ C D F R S

	Index Entry	Section

+
	`+id-bits+`:	Private constants
	`+version-bits+`:	Private constants

C
	`Constant, +id-bits+`:	Private constants
	`Constant, +version-bits+`:	Private constants

D
	`data`:	Private structures

F
	`free-head`:	Private structures
	`free-tail`:	Private structures

R
	`reverse-map`:	Private structures

S
	`Slot, data`:	Private structures
	`Slot, free-head`:	Private structures
	`Slot, free-tail`:	Private structures
	`Slot, reverse-map`:	Private structures
	`Slot, slots`:	Private structures
	`slots`:	Private structures

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	F P S

	Index Entry	Section

F
	`File, package.lisp`:	The slot-map/package․lisp file
	`File, slot-map.asd`:	The slot-map/slot-map․asd file
	`File, slot-map.lisp`:	The slot-map/slot-map․lisp file

P
	`Package, slot-map`:	The slot-map package
	`package.lisp`:	The slot-map/package․lisp file

S
	`slot-map`:	The slot-map system
	`slot-map`:	The slot-map package
	`slot-map`:	Private structures
	`slot-map.asd`:	The slot-map/slot-map․asd file
	`slot-map.lisp`:	The slot-map/slot-map․lisp file
	`Structure, slot-map`:	Private structures
	`System, slot-map`:	The slot-map system

The slot-map Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 slot-map

3 Files

3.1 Lisp

3.1.1 slot-map/slot-map.asd

3.1.2 slot-map/package.lisp

3.1.3 slot-map/slot-map.lisp

4 Packages

4.1 slot-map

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.1.2 Standalone methods

5.2 Internals

5.2.1 Constants

5.2.2 Macros

5.2.3 Ordinary functions

5.2.4 Structures

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `slot-map`

3.1.1 `slot-map/slot-map.asd`

3.1.2 `slot-map/package.lisp`

3.1.3 `slot-map/slot-map.lisp`

4.1 `slot-map`