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

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 Mon Feb 26 17:56:33 2024 GMT+0.

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

1 Introduction

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

2 Systems

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

sparse-set

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

2.1 `sparse-set`

An implementation of the sparse set data structure.

Author

Michael Fiano <mail@mfiano.net>

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

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

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

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

3.1.1 `sparse-set/sparse-set.asd`

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

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

3.1.2 `sparse-set/package.lisp`

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

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

3.1.3 `sparse-set/sparse-set.lisp`

Dependency

package.lisp (file).

Source

sparse-set.asd.

Parent Component

sparse-set (system).

Public Interface

clear (function).
copy (function).
delete (function).
find (function).
insert (function).
length (function).
make-sparse-set (function).
map (function).
print-object (method).

Internals

%length (reader).
(setf %length) (writer).
%make-sparse-set (function).
dense (reader).
(setf dense) (writer).
sparse (reader).
(setf sparse) (writer).
sparse-set (structure).

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

4 Packages

Packages are listed by definition order.

sparse-set

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

4.1 `sparse-set`

Source

package.lisp.

Use List

common-lisp.

Public Interface

clear (function).
copy (function).
delete (function).
find (function).
insert (function).
length (function).
make-sparse-set (function).
map (function).

Internals

%length (reader).
(setf %length) (writer).
%make-sparse-set (function).
dense (reader).
(setf dense) (writer).
sparse (reader).
(setf sparse) (writer).
sparse-set (structure).

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

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

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.

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

5.1.2 Standalone methods

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

Source: sparse-set.lisp.

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

5.2 Internals

Ordinary functions
Structures

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

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.

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

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

Previous: Definitions, Up: The sparse-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:	% ( 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

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

A.3 Variables

Jump to:	% D S

	Index Entry	Section

%
	`%length`:	Private structures

D
	`dense`:	Private structures

S
	`Slot, %length`:	Private structures
	`Slot, dense`:	Private structures
	`Slot, sparse`:	Private structures
	`sparse`:	Private structures

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

A.4 Data types

Jump to:	F P S

	Index Entry	Section

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

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

S
	`sparse-set`:	The sparse-set system
	`sparse-set`:	The sparse-set package
	`sparse-set`:	Private structures
	`sparse-set.asd`:	The sparse-set/sparse-set․asd file
	`sparse-set.lisp`:	The sparse-set/sparse-set․lisp file
	`Structure, sparse-set`:	Private structures
	`System, sparse-set`:	The sparse-set system

The sparse-set Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 sparse-set

3 Files

3.1 Lisp

3.1.1 sparse-set/sparse-set.asd

3.1.2 sparse-set/package.lisp

3.1.3 sparse-set/sparse-set.lisp

4 Packages

4.1 sparse-set

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.1.2 Standalone methods

5.2 Internals

5.2.1 Ordinary functions

5.2.2 Structures

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `sparse-set`

3.1.1 `sparse-set/sparse-set.asd`

3.1.2 `sparse-set/package.lisp`

3.1.3 `sparse-set/sparse-set.lisp`

4.1 `sparse-set`