The map-set Reference Manual

This is the map-set Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:10:14 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 map-set

Set-like data structure.

Author

Robert Smith <>

License

BSD 3-clause (See LICENSE)

Source

map-set.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 map-set/map-set.asd

Source

map-set.asd.

Parent Component

map-set (system).

ASDF Systems

map-set.


3.1.2 map-set/package.lisp

Source

map-set.asd.

Parent Component

map-set (system).

Packages

map-set.


3.1.3 map-set/map-set.lisp

Dependency

package.lisp (file).

Source

map-set.asd.

Parent Component

map-set (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 map-set

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.


5.1 Public Interface


5.1.1 Ordinary functions

Function: make-map-set ()
Package

map-set.

Source

map-set.lisp.

Function: map-set-p (object)
Package

map-set.

Source

map-set.lisp.

Function: ms-count (ms)

Return the cardinality/size of the map-set MS.

Package

map-set.

Source

map-set.lisp.

Function: ms-delete (ms item)

Remove the item ITEM from the map-set MS.

Package

map-set.

Source

map-set.lisp.

Function: ms-for-each (f ms)

Apply the function F to each item in the map-set MS.

Package

map-set.

Source

map-set.lisp.

Function: ms-insert (ms item)

Add the item ITEM to the map-set MS.

Package

map-set.

Source

map-set.lisp.

Function: ms-map (type f ms)

Map the unary function F across the map-set MS with a result type TYPE.

Package

map-set.

Source

map-set.lisp.

Function: ms-member-p (ms item)

Is ITEM a member of the map-set MS?

Package

map-set.

Source

map-set.lisp.

Function: ms-random (ms)

Select a random element of the map-set MS.

Package

map-set.

Source

map-set.lisp.


5.1.2 Standalone methods

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

map-set.lisp.


5.1.3 Structures

Structure: map-set
Package

map-set.

Source

map-set.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots
Slot: table
Type

hash-table

Initform

(make-hash-table)

Readers

map-set-table.

Writers

(setf map-set-table).

Slot: index
Type

vector

Initform

(make-array 16 :adjustable t :fill-pointer 0)

Readers

map-set-index.

Writers

(setf map-set-index).

Slot: size
Type

unsigned-byte

Initform

0

Readers

map-set-size.

Writers

(setf map-set-size).


5.2 Internals


5.2.1 Ordinary functions

Reader: map-set-index (instance)
Writer: (setf map-set-index) (instance)
Package

map-set.

Source

map-set.lisp.

Target Slot

index.

Reader: map-set-size (instance)
Writer: (setf map-set-size) (instance)
Package

map-set.

Source

map-set.lisp.

Target Slot

size.

Reader: map-set-table (instance)
Writer: (setf map-set-table) (instance)
Package

map-set.

Source

map-set.lisp.

Target Slot

table.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
F   M   P  
Index Entry  Section

(
(setf map-set-index): Private ordinary functions
(setf map-set-size): Private ordinary functions
(setf map-set-table): Private ordinary functions

F
Function, (setf map-set-index): Private ordinary functions
Function, (setf map-set-size): Private ordinary functions
Function, (setf map-set-table): Private ordinary functions
Function, make-map-set: Public ordinary functions
Function, map-set-index: Private ordinary functions
Function, map-set-p: Public ordinary functions
Function, map-set-size: Private ordinary functions
Function, map-set-table: Private ordinary functions
Function, ms-count: Public ordinary functions
Function, ms-delete: Public ordinary functions
Function, ms-for-each: Public ordinary functions
Function, ms-insert: Public ordinary functions
Function, ms-map: Public ordinary functions
Function, ms-member-p: Public ordinary functions
Function, ms-random: Public ordinary functions

M
make-map-set: Public ordinary functions
map-set-index: Private ordinary functions
map-set-p: Public ordinary functions
map-set-size: Private ordinary functions
map-set-table: Private ordinary functions
Method, print-object: Public standalone methods
ms-count: Public ordinary functions
ms-delete: Public ordinary functions
ms-for-each: Public ordinary functions
ms-insert: Public ordinary functions
ms-map: Public ordinary functions
ms-member-p: Public ordinary functions
ms-random: Public ordinary functions

P
print-object: Public standalone methods


A.3 Variables