The map-set Reference Manual

Table of Contents

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

The map-set Reference Manual

This is the map-set Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:03:03 2018 GMT+0.


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

1 Introduction

                               MAP-SET
                               -------

                           By Robert Smith

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


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

2 Systems

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


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

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

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

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 files   [Contents][Index]

3.1.1 map-set.asd

Location

map-set.asd

Systems

map-set (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 map-set/package.lisp

Parent

map-set (system)

Location

package.lisp

Packages

map-set


Previous: , Up: Lisp files   [Contents][Index]

3.1.3 map-set/map-set.lisp

Dependency

package.lisp (file)

Parent

map-set (system)

Location

map-set.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 map-set

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Exported definitions   [Contents][Index]

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)


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

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

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)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M  
Index Entry  Section

F
File, Lisp, map-set.asd: The map-set<dot>asd file
File, Lisp, map-set/map-set.lisp: The map-set/map-set<dot>lisp file
File, Lisp, map-set/package.lisp: The map-set/package<dot>lisp file

L
Lisp File, map-set.asd: The map-set<dot>asd file
Lisp File, map-set/map-set.lisp: The map-set/map-set<dot>lisp file
Lisp File, map-set/package.lisp: The map-set/package<dot>lisp file

M
map-set.asd: The map-set<dot>asd file
map-set/map-set.lisp: The map-set/map-set<dot>lisp file
map-set/package.lisp: The map-set/package<dot>lisp file

Jump to:   F   L   M  

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

A.2 Functions

Jump to:   (  
F   M  
Index Entry  Section

(
(setf map-set-index): Internal functions
(setf map-set-size): Internal functions
(setf map-set-table): Internal functions

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

M
make-map-set: Exported functions
map-set-index: Internal functions
map-set-p: Exported functions
map-set-size: Internal functions
map-set-table: Internal functions
ms-count: Exported functions
ms-delete: Exported functions
ms-for-each: Exported functions
ms-insert: Exported functions
ms-map: Exported functions
ms-member-p: Exported functions
ms-random: Exported functions

Jump to:   (  
F   M  

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

A.3 Variables

Jump to:   I   S   T  
Index Entry  Section

I
index: Exported structures

S
size: Exported structures
Slot, index: Exported structures
Slot, size: Exported structures
Slot, table: Exported structures

T
table: Exported structures

Jump to:   I   S   T  

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

A.4 Data types

Jump to:   M   P   S  
Index Entry  Section

M
map-set: The map-set system
map-set: The map-set package
map-set: Exported structures

P
Package, map-set: The map-set package

S
Structure, map-set: Exported structures
System, map-set: The map-set system

Jump to:   M   P   S