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

The track-best Reference Manual

This is the track-best Reference Manual, version 0.1.20220124, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 18:06:15 2024 GMT+0.

1 Introduction
2 Systems
- 2.1 track-best
3 Modules
- 3.1 track-best/src
4 Files
- 4.1 Lisp
- 4.2 Static
  - 4.2.1 track-best/README.md
5 Packages
- 5.1 track-best
6 Definitions
- 6.1 Public Interface
  - 6.1.1 Macros
  - 6.1.2 Ordinary functions
- 6.2 Internals
Appendix A Indexes

Next: Systems, Previous: The track-best Reference Manual, Up: The track-best Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The track-best Reference Manual [Contents][Index]

2 Systems

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

track-best

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

2.1 `track-best`

Macros/functions for tracking the best items. See the README.md for more details.

Author

Patrick Stein <pat@nklein.com>

License

Free

Version

0.1.20220124

Source

track-best.asd.

Child Components

readme.md (file).
src (module).

Next: Files, Previous: Systems, Up: The track-best Reference Manual [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.

track-best/src

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

3.1 `track-best/src`

Source

track-best.asd.

Parent Component

track-best (system).

Child Components

package.lisp (file).
types.lisp (file).
globals.lisp (file).
insert.lisp (file).
methods.lisp (file).
track-best.lisp (file).

Next: Packages, Previous: Modules, Up: The track-best Reference Manual [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp
Static

Next: Static, Previous: Files, Up: Files [Contents][Index]

Next: track-best/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `track-best/track-best.asd`

Source: track-best.asd.
Parent Component: track-best (system).
ASDF Systems: track-best.

Next: track-best/src/types.lisp, Previous: track-best/track-best.asd, Up: Lisp [Contents][Index]

4.1.2 `track-best/src/package.lisp`

Source: track-best.asd.
Parent Component: src (module).
Packages: track-best.

Next: track-best/src/globals.lisp, Previous: track-best/src/package.lisp, Up: Lisp [Contents][Index]

4.1.3 `track-best/src/types.lisp`

Dependency

package.lisp (file).

Source

track-best.asd.

Parent Component

src (module).

Internals

best-item-list (structure).
best-item-list-items (reader).
(setf best-item-list-items) (writer).
best-item-list-p (function).
best-item-list-score (reader).
best-item-list-size (reader).
(setf best-item-list-size) (writer).
best-tracker (structure).
best-tracker-best (reader).
(setf best-tracker-best) (writer).
best-tracker-keep (reader).
best-tracker-keep-ties (reader).
best-tracker-order-by-fn (reader).
best-tracker-p (function).
best-tracker-size (reader).
(setf best-tracker-size) (writer).
copy-best-item-list (function).
copy-best-tracker (function).
make-best-item-list (function).
make-best-tracker (function).
order-by-fn (type).

Next: track-best/src/insert.lisp, Previous: track-best/src/types.lisp, Up: Lisp [Contents][Index]

4.1.4 `track-best/src/globals.lisp`

Dependency: types.lisp (file).
Source: track-best.asd.
Parent Component: src (module).
Internals: *current-best-tracker* (special variable).

Next: track-best/src/methods.lisp, Previous: track-best/src/globals.lisp, Up: Lisp [Contents][Index]

4.1.5 `track-best/src/insert.lisp`

Dependency: globals.lisp (file).
Source: track-best.asd.
Parent Component: src (module).
Internals: insert-tracked-item (function).

Next: track-best/src/track-best.lisp, Previous: track-best/src/insert.lisp, Up: Lisp [Contents][Index]

4.1.6 `track-best/src/methods.lisp`

Dependency

insert.lisp (file).

Source

track-best.asd.

Parent Component

src (module).

Public Interface

map-best (function).
track (function).

Previous: track-best/src/methods.lisp, Up: Lisp [Contents][Index]

4.1.7 `track-best/src/track-best.lisp`

Dependency: methods.lisp (file).
Source: track-best.asd.
Parent Component: src (module).
Public Interface: with-track-best (macro).

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

4.2 Static

track-best/README.md

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

4.2.1 `track-best/README.md`

Source: track-best.asd.
Parent Component: track-best (system).

Next: Definitions, Previous: Files, Up: The track-best Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

track-best

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

5.1 `track-best`

Source

package.lisp.

Use List

common-lisp.

Public Interface

map-best (function).
track (function).
with-track-best (macro).

Internals

*current-best-tracker* (special variable).
best-item-list (structure).
best-item-list-items (reader).
(setf best-item-list-items) (writer).
best-item-list-p (function).
best-item-list-score (reader).
best-item-list-size (reader).
(setf best-item-list-size) (writer).
best-tracker (structure).
best-tracker-best (reader).
(setf best-tracker-best) (writer).
best-tracker-keep (reader).
best-tracker-keep-ties (reader).
best-tracker-order-by-fn (reader).
best-tracker-p (function).
best-tracker-size (reader).
(setf best-tracker-size) (writer).
copy-best-item-list (function).
copy-best-tracker (function).
insert-tracked-item (function).
make-best-item-list (function).
make-best-tracker (function).
order-by-fn (type).

Next: Indexes, Previous: Packages, Up: The track-best Reference Manual [Contents][Index]

6 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]

6.1 Public Interface

Macros
Ordinary functions

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

6.1.1 Macros

Macro: with-track-best ((&key name keep keep-ties order-by-fn always-return-list return-best) &body body) ¶

Package: track-best.
Source: track-best.lisp.

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

6.1.2 Ordinary functions

Function: map-best (fn &optional tracker) ¶

Package: track-best.
Source: methods.lisp.

Function: track (item score &optional tracker) ¶

Add the ITEM with SCORE to the TRACKER.

Package: track-best.
Source: methods.lisp.

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

6.2 Internals

Special variables
Ordinary functions
Structures
Types

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

6.2.1 Special variables

Special Variable: *current-best-tracker* ¶

The current best-tracker instance.

Package: track-best.
Source: globals.lisp.

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

6.2.2 Ordinary functions

Reader: best-item-list-items (instance) ¶

Writer: (setf best-item-list-items) (instance) ¶

Package: track-best.
Source: types.lisp.
Target Slot: items.

Function: best-item-list-p (object) ¶

Package: track-best.
Source: types.lisp.

Reader: best-item-list-score (instance) ¶

Package: track-best.
Source: types.lisp.
Target Slot: score.

Reader: best-item-list-size (instance) ¶

Writer: (setf best-item-list-size) (instance) ¶

Package: track-best.
Source: types.lisp.
Target Slot: size.

Reader: best-tracker-best (instance) ¶

Writer: (setf best-tracker-best) (instance) ¶

Package: track-best.
Source: types.lisp.
Target Slot: best.

Reader: best-tracker-keep (instance) ¶

Package: track-best.
Source: types.lisp.
Target Slot: keep.

Reader: best-tracker-keep-ties (instance) ¶

Package: track-best.
Source: types.lisp.
Target Slot: keep-ties.

Reader: best-tracker-order-by-fn (instance) ¶

Package: track-best.
Source: types.lisp.
Target Slot: order-by-fn.

Function: best-tracker-p (object) ¶

Package: track-best.
Source: types.lisp.

Reader: best-tracker-size (instance) ¶

Writer: (setf best-tracker-size) (instance) ¶

Package: track-best.
Source: types.lisp.
Target Slot: size.

Function: copy-best-item-list (instance) ¶

Package: track-best.
Source: types.lisp.

Function: copy-best-tracker (instance) ¶

Package: track-best.
Source: types.lisp.

Function: insert-tracked-item (tracker item score) ¶

Insert the ITEM with the given SCORE into the TRACKER.

Package: track-best.
Source: insert.lisp.

Function: make-best-item-list (&key size score items) ¶

Package: track-best.
Source: types.lisp.

Function: make-best-tracker (&key best size keep keep-ties order-by-fn) ¶

Package: track-best.
Source: types.lisp.

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

6.2.3 Structures

Structure: best-item-list ¶

Package

track-best.

Source

types.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: size ¶

Type: (integer 1 *)
Initform: 1
Readers: best-item-list-size.
Writers: (setf best-item-list-size).

Slot: score ¶

Initform: 0.0
Readers: best-item-list-score.
Writers: This slot is read-only.

Slot: items ¶

Readers: best-item-list-items.
Writers: (setf best-item-list-items).

Structure: best-tracker ¶

Package

track-best.

Source

types.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: best ¶

Type: list
Readers: best-tracker-best.
Writers: (setf best-tracker-best).

Slot: size ¶

Type: (integer 0 *)
Initform: 0
Readers: best-tracker-size.
Writers: (setf best-tracker-size).

Slot: keep ¶

Initform: 1
Readers: best-tracker-keep.
Writers: This slot is read-only.

Slot: keep-ties ¶

Readers: best-tracker-keep-ties.
Writers: This slot is read-only.

Slot: order-by-fn ¶

Type: track-best::order-by-fn
Initform: (function >)
Readers: best-tracker-order-by-fn.
Writers: This slot is read-only.

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

6.2.4 Types

Type: order-by-fn () ¶

Package: track-best.
Source: types.lisp.

Previous: Definitions, Up: The track-best 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:	( B C F I M T W

	Index Entry	Section

(
	`(setf best-item-list-items)`:	Private ordinary functions
	`(setf best-item-list-size)`:	Private ordinary functions
	`(setf best-tracker-best)`:	Private ordinary functions
	`(setf best-tracker-size)`:	Private ordinary functions

B
	`best-item-list-items`:	Private ordinary functions
	`best-item-list-p`:	Private ordinary functions
	`best-item-list-score`:	Private ordinary functions
	`best-item-list-size`:	Private ordinary functions
	`best-tracker-best`:	Private ordinary functions
	`best-tracker-keep`:	Private ordinary functions
	`best-tracker-keep-ties`:	Private ordinary functions
	`best-tracker-order-by-fn`:	Private ordinary functions
	`best-tracker-p`:	Private ordinary functions
	`best-tracker-size`:	Private ordinary functions

C
	`copy-best-item-list`:	Private ordinary functions
	`copy-best-tracker`:	Private ordinary functions

F
	`Function, (setf best-item-list-items)`:	Private ordinary functions
	`Function, (setf best-item-list-size)`:	Private ordinary functions
	`Function, (setf best-tracker-best)`:	Private ordinary functions
	`Function, (setf best-tracker-size)`:	Private ordinary functions
	`Function, best-item-list-items`:	Private ordinary functions
	`Function, best-item-list-p`:	Private ordinary functions
	`Function, best-item-list-score`:	Private ordinary functions
	`Function, best-item-list-size`:	Private ordinary functions
	`Function, best-tracker-best`:	Private ordinary functions
	`Function, best-tracker-keep`:	Private ordinary functions
	`Function, best-tracker-keep-ties`:	Private ordinary functions
	`Function, best-tracker-order-by-fn`:	Private ordinary functions
	`Function, best-tracker-p`:	Private ordinary functions
	`Function, best-tracker-size`:	Private ordinary functions
	`Function, copy-best-item-list`:	Private ordinary functions
	`Function, copy-best-tracker`:	Private ordinary functions
	`Function, insert-tracked-item`:	Private ordinary functions
	`Function, make-best-item-list`:	Private ordinary functions
	`Function, make-best-tracker`:	Private ordinary functions
	`Function, map-best`:	Public ordinary functions
	`Function, track`:	Public ordinary functions

I
	`insert-tracked-item`:	Private ordinary functions

M
	`Macro, with-track-best`:	Public macros
	`make-best-item-list`:	Private ordinary functions
	`make-best-tracker`:	Private ordinary functions
	`map-best`:	Public ordinary functions

T
	`track`:	Public ordinary functions

W
	`with-track-best`:	Public macros

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

A.3 Variables

Jump to:	* B I K O S

	Index Entry	Section

*
	`current-best-tracker`:	Private special variables

B
	`best`:	Private structures

I
	`items`:	Private structures

K
	`keep`:	Private structures
	`keep-ties`:	Private structures

O
	`order-by-fn`:	Private structures

S
	`score`:	Private structures
	`size`:	Private structures
	`size`:	Private structures
	`Slot, best`:	Private structures
	`Slot, items`:	Private structures
	`Slot, keep`:	Private structures
	`Slot, keep-ties`:	Private structures
	`Slot, order-by-fn`:	Private structures
	`Slot, score`:	Private structures
	`Slot, size`:	Private structures
	`Slot, size`:	Private structures
	`Special Variable, current-best-tracker`:	Private special variables

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

A.4 Data types

Jump to:	B F G I M O P R S T

	Index Entry	Section

B
	`best-item-list`:	Private structures
	`best-tracker`:	Private structures

F
	`File, globals.lisp`:	The track-best/src/globals․lisp file
	`File, insert.lisp`:	The track-best/src/insert․lisp file
	`File, methods.lisp`:	The track-best/src/methods․lisp file
	`File, package.lisp`:	The track-best/src/package․lisp file
	`File, readme.md`:	The track-best/readme․md file
	`File, track-best.asd`:	The track-best/track-best․asd file
	`File, track-best.lisp`:	The track-best/src/track-best․lisp file
	`File, types.lisp`:	The track-best/src/types․lisp file

G
	`globals.lisp`:	The track-best/src/globals․lisp file

I
	`insert.lisp`:	The track-best/src/insert․lisp file

M
	`methods.lisp`:	The track-best/src/methods․lisp file
	`Module, src`:	The track-best/src module

O
	`order-by-fn`:	Private types

P
	`Package, track-best`:	The track-best package
	`package.lisp`:	The track-best/src/package․lisp file

R
	`readme.md`:	The track-best/readme․md file

S
	`src`:	The track-best/src module
	`Structure, best-item-list`:	Private structures
	`Structure, best-tracker`:	Private structures
	`System, track-best`:	The track-best system

T
	`track-best`:	The track-best system
	`track-best`:	The track-best package
	`track-best.asd`:	The track-best/track-best․asd file
	`track-best.lisp`:	The track-best/src/track-best․lisp file
	`Type, order-by-fn`:	Private types
	`types.lisp`:	The track-best/src/types․lisp file

The track-best Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 track-best

3 Modules

3.1 track-best/src

4 Files

4.1 Lisp

4.1.1 track-best/track-best.asd

4.1.2 track-best/src/package.lisp

4.1.3 track-best/src/types.lisp

4.1.4 track-best/src/globals.lisp

4.1.5 track-best/src/insert.lisp

4.1.6 track-best/src/methods.lisp

4.1.7 track-best/src/track-best.lisp

4.2 Static

4.2.1 track-best/README.md

5 Packages

5.1 track-best

6 Definitions

6.1 Public Interface

6.1.1 Macros

6.1.2 Ordinary functions

6.2 Internals

6.2.1 Special variables

6.2.2 Ordinary functions

6.2.3 Structures

6.2.4 Types

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `track-best`

3.1 `track-best/src`

4.1.1 `track-best/track-best.asd`

4.1.2 `track-best/src/package.lisp`

4.1.3 `track-best/src/types.lisp`

4.1.4 `track-best/src/globals.lisp`

4.1.5 `track-best/src/insert.lisp`

4.1.6 `track-best/src/methods.lisp`

4.1.7 `track-best/src/track-best.lisp`

4.2.1 `track-best/README.md`

5.1 `track-best`