The sparse-set Reference Manual

This is the sparse-set Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:45:50 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 sparse-set

An implementation of the sparse set data structure.

Author

Michael Fiano <>

Home Page

https://git.mfiano.net/mfiano/sparse-set

License

MIT

Version

0.1.0

Dependency

mfiano-utils (system).

Source

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

Source

sparse-set.asd.

Parent Component

sparse-set (system).

ASDF Systems

sparse-set.


3.1.2 sparse-set/package.lisp

Source

sparse-set.asd.

Parent Component

sparse-set (system).

Packages

sparse-set.


3.1.3 sparse-set/sparse-set.lisp

Dependency

package.lisp (file).

Source

sparse-set.asd.

Parent Component

sparse-set (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 sparse-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: clear (sparse-set)
Package

sparse-set.

Source

sparse-set.lisp.

Function: copy (sparse-set)
Package

sparse-set.

Source

sparse-set.lisp.

Function: delete (sparse-set value)
Package

sparse-set.

Source

sparse-set.lisp.

Function: find (sparse-set value)
Package

sparse-set.

Source

sparse-set.lisp.

Function: insert (sparse-set value)
Package

sparse-set.

Source

sparse-set.lisp.

Function: length (sparse-set)
Package

sparse-set.

Source

sparse-set.lisp.

Function: make-sparse-set (&key size)
Package

sparse-set.

Source

sparse-set.lisp.

Function: map (sparse-set func)
Package

sparse-set.

Source

sparse-set.lisp.


5.1.2 Standalone methods

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

sparse-set.lisp.


5.2 Internals


5.2.1 Ordinary functions

Reader: %length (instance)
Writer: (setf %length) (instance)
Package

sparse-set.

Source

sparse-set.lisp.

Target Slot

%length.

Function: %make-sparse-set (&key dense sparse %length)
Package

sparse-set.

Source

sparse-set.lisp.

Reader: dense (instance)
Writer: (setf dense) (instance)
Package

sparse-set.

Source

sparse-set.lisp.

Target Slot

dense.

Reader: sparse (instance)
Writer: (setf sparse) (instance)
Package

sparse-set.

Source

sparse-set.lisp.

Target Slot

sparse.


5.2.2 Structures

Structure: sparse-set
Package

sparse-set.

Source

sparse-set.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots
Slot: dense
Type

(simple-array fixnum (*))

Initform

(make-array 0 :element-type (quote fixnum))

Readers

dense.

Writers

(setf dense).

Slot: sparse
Type

(simple-array fixnum (*))

Initform

(make-array 0 :element-type (quote fixnum))

Readers

sparse.

Writers

(setf sparse).

Slot: %length
Type

fixnum

Initform

0

Readers

%length.

Writers

(setf %length).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
C   D   F   I   L   M   P   S  
Index Entry  Section

%
%length: Private ordinary functions
%make-sparse-set: Private ordinary functions

(
(setf %length): Private ordinary functions
(setf dense): Private ordinary functions
(setf sparse): Private ordinary functions

C
clear: Public ordinary functions
copy: Public ordinary functions

D
delete: Public ordinary functions
dense: Private ordinary functions

F
find: Public ordinary functions
Function, %length: Private ordinary functions
Function, %make-sparse-set: Private ordinary functions
Function, (setf %length): Private ordinary functions
Function, (setf dense): Private ordinary functions
Function, (setf sparse): Private ordinary functions
Function, clear: Public ordinary functions
Function, copy: Public ordinary functions
Function, delete: Public ordinary functions
Function, dense: Private ordinary functions
Function, find: Public ordinary functions
Function, insert: Public ordinary functions
Function, length: Public ordinary functions
Function, make-sparse-set: Public ordinary functions
Function, map: Public ordinary functions
Function, sparse: Private ordinary functions

I
insert: Public ordinary functions

L
length: Public ordinary functions

M
make-sparse-set: Public ordinary functions
map: Public ordinary functions
Method, print-object: Public standalone methods

P
print-object: Public standalone methods

S
sparse: Private ordinary functions


A.3 Variables