The map-set Reference Manual

Table of Contents

The map-set Reference Manual

This is the map-set Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 17:00:50 2021 GMT+0.

1 Introduction

                               MAP-SET
                               -------

                           By Robert Smith

Implementation of a set-like data structure with constant time
addition, removal, and random selection.

2 Systems

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

2.1 map-set

Author

Robert Smith <quad@symbo1ics.com>

License

BSD 3-clause (See LICENSE)

Description

Set-like data structure.

Source

map-set.asd (file)

Components

• package.lisp (file)
• map-set.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 map-set.asd

Location

map-set.asd

Systems

map-set (system)

3.1.2 map-set/package.lisp

Parent

map-set (system)

Location

package.lisp

Packages

map-set

3.1.3 map-set/map-set.lisp

Dependency

package.lisp (file)

Parent

map-set (system)

Location

map-set.lisp

Exported Definitions

• make-map-set (function)
• map-set (structure)
• map-set-p (function)
• ms-count (function)
• ms-delete (function)
• ms-for-each (function)
• ms-insert (function)
• ms-map (function)
• ms-member-p (function)
• ms-random (function)

Internal Definitions

• map-set-index (function)
• (setf map-set-index) (function)
• map-set-size (function)
• (setf map-set-size) (function)
• map-set-table (function)
• (setf map-set-table) (function)

4 Packages

Packages are listed by definition order.

4.1 map-set

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• make-map-set (function)
• map-set (structure)
• map-set-p (function)
• ms-count (function)
• ms-delete (function)
• ms-for-each (function)
• ms-insert (function)
• ms-map (function)
• ms-member-p (function)
• ms-random (function)

Internal Definitions

• map-set-index (function)
• (setf map-set-index) (function)
• map-set-size (function)
• (setf map-set-size) (function)
• map-set-table (function)
• (setf map-set-table) (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: make-map-set ()

Package

map-set

Source

map-set.lisp (file)

Function: map-set-p OBJECT

Package

map-set

Source

map-set.lisp (file)

Function: ms-count MS

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

Package

map-set

Source

map-set.lisp (file)

Function: ms-delete MS ITEM

Remove the item ITEM from the map-set MS.

Package

map-set

Source

map-set.lisp (file)

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 (file)

Function: ms-insert MS ITEM

Add the item ITEM to the map-set MS.

Package

map-set

Source

map-set.lisp (file)

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 (file)

Function: ms-member-p MS ITEM

Is ITEM a member of the map-set MS?

Package

map-set

Source

map-set.lisp (file)

Function: ms-random MS

Select a random element of the map-set MS.

Package

map-set

Source

map-set.lisp (file)

5.1.2 Structures

Structure: map-set ()

Package

map-set

Source

map-set.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

print-object (method)

Direct slots

Slot: table

Type

hash-table

Initform

(make-hash-table)

Readers

map-set-table (function)

Writers

(setf map-set-table) (function)

Slot: index

Type

vector

Initform

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

Readers

map-set-index (function)

Writers

(setf map-set-index) (function)

Slot: size

Type

unsigned-byte

Initform

0

Readers

map-set-size (function)

Writers

(setf map-set-size) (function)

5.2 Internal definitions

5.2.1 Functions

Function: map-set-index INSTANCE

Function: (setf map-set-index) VALUE INSTANCE

Package

map-set

Source

map-set.lisp (file)

Function: map-set-size INSTANCE

Function: (setf map-set-size) VALUE INSTANCE

Package

map-set

Source

map-set.lisp (file)

Function: map-set-table INSTANCE

Function: (setf map-set-table) VALUE INSTANCE

Package

map-set

Source

map-set.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types