The slot-map Reference Manual

Next: , Previous: , 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 Tue Nov 15 07:13:40 2022 GMT+0.

Table of Contents


1 Introduction

slot-map

An implementation of the slot-map data structure.

Reference 1: https://github.com/WG21-SG14/SG14/blob/master/SG14/slot_map.h Reference 2: http://bitsquid.blogspot.com/2011/09/managing-decoupling-part-4-id-lookup.html Reference 3: https://github.com/orlp/slotmap

Install

(ql:quickload :slot-map)

License

Copyright © 2019-2022 Michael Fiano mail@mfiano.net

Licensed under the MIT License.


2 Systems

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


Previous: , 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

3 Files

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


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

3.1 Lisp


Next: , Previous: , 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.


3.1.2 slot-map/package.lisp

Source

slot-map.asd.

Parent Component

slot-map (system).

Packages

slot-map.


Previous: , 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
Internals

4 Packages

Packages are listed by definition order.


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

4.1 slot-map

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


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

5.1 Public Interface


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.


5.1.2 Standalone methods

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

slot-map.lisp.


5.2 Internals


Next: , Previous: , 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: , Previous: , Up: Internals   [Contents][Index]

5.2.2 Macros

Macro: repack-id (place id)
Package

slot-map.

Source

slot-map.lisp.


Next: , Previous: , 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.


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).


Appendix A Indexes


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

A.1 Concepts


Next: , Previous: , 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

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