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 Wed May 15 07:08:54 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 track-best

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

Author

Patrick Stein <>

License

Free

Version

0.1.20220124

Source

track-best.asd.

Child Components

3 Modules

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


3.1 track-best/src

Source

track-best.asd.

Parent Component

track-best (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 track-best/track-best.asd

Source

track-best.asd.

Parent Component

track-best (system).

ASDF Systems

track-best.


4.1.2 track-best/src/package.lisp

Source

track-best.asd.

Parent Component

src (module).

Packages

track-best.


4.1.3 track-best/src/types.lisp

Dependency

package.lisp (file).

Source

track-best.asd.

Parent Component

src (module).

Internals

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


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


4.1.6 track-best/src/methods.lisp

Dependency

insert.lisp (file).

Source

track-best.asd.

Parent Component

src (module).

Public Interface

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


4.2 Static


4.2.1 track-best/README.md

Source

track-best.asd.

Parent Component

track-best (system).


5 Packages

Packages are listed by definition order.


5.1 track-best

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


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.


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.


6.2 Internals


6.2.1 Special variables

Special Variable: *current-best-tracker*

The current best-tracker instance.

Package

track-best.

Source

globals.lisp.


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.


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.


6.2.4 Types

Type: order-by-fn ()
Package

track-best.

Source

types.lisp.


Appendix A Indexes


A.1 Concepts


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


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