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

The map-set Reference Manual

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

Table of Contents

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

1 Introduction

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

2 Systems

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

map-set

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

2.1 `map-set`

Set-like data structure.

Author

Robert Smith <quad@symbo1ics.com>

License

BSD 3-clause (See LICENSE)

Source

Child Components

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

Next: Packages, Previous: Systems, Up: The map-set 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]

3.1 Lisp

map-set/map-set.asd
map-set/package.lisp
map-set/map-set.lisp

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

3.1.1 `map-set/map-set.asd`

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

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

3.1.2 `map-set/package.lisp`

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

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

3.1.3 `map-set/map-set.lisp`

Dependency

package.lisp (file).

Source

Parent Component

map-set (system).

Public Interface

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).
print-object (method).

Internals

map-set-index (reader).
(setf map-set-index) (writer).
map-set-size (reader).
(setf map-set-size) (writer).
map-set-table (reader).
(setf map-set-table) (writer).

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

4 Packages

Packages are listed by definition order.

map-set

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

4.1 `map-set`

Source

package.lisp.

Use List

common-lisp.

Public Interface

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

Internals

map-set-index (reader).
(setf map-set-index) (writer).
map-set-size (reader).
(setf map-set-size) (writer).
map-set-table (reader).
(setf map-set-table) (writer).

Next: Indexes, Previous: Packages, Up: The map-set 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
Structures

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

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.

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

5.1.2 Standalone methods

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

Source: map-set.lisp.

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

5.1.3 Structures

Structure: map-set ¶

Package

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

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

5.2 Internals

Ordinary functions

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

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.

Previous: Definitions, Up: The map-set 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:	( 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

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

A.3 Variables

Jump to:	I S T

	Index Entry		Section

I
	`index`:		Public structures

S
	`size`:		Public structures
	`Slot, index`:		Public structures
	`Slot, size`:		Public structures
	`Slot, table`:		Public structures

T
	`table`:		Public structures

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

A.4 Data types

Jump to:	F M P S

	Index Entry		Section

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

M
	`map-set`:		The map-set system
	`map-set`:		The map-set package
	`map-set`:		Public structures
	`map-set.asd`:		The map-set/map-set․asd file
	`map-set.lisp`:		The map-set/map-set․lisp file

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

S
	`Structure, map-set`:		Public structures
	`System, map-set`:		The map-set system