The simple-guess Reference Manual

This is the simple-guess Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:53:47 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 simple-guess

Defines a simple extensible protocol for computing a guess using advisors.

Author

Jean-Philippe Paradis <>

License

Unlicense

Version

1.0

Source

simple-guess.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 simple-guess/simple-guess.asd

Source

simple-guess.asd.

Parent Component

simple-guess (system).

ASDF Systems

simple-guess.


3.1.2 simple-guess/package.lisp

Source

simple-guess.asd.

Parent Component

simple-guess (system).

Packages

simple-guess.


3.1.3 simple-guess/core.lisp

Dependency

package.lisp (file).

Source

simple-guess.asd.

Parent Component

simple-guess (system).

Public Interface

3.1.4 simple-guess/mixins.lisp

Dependency

core.lisp (file).

Source

simple-guess.asd.

Parent Component

simple-guess (system).

Public Interface

3.1.5 simple-guess/advisors.lisp

Dependency

mixins.lisp (file).

Source

simple-guess.asd.

Parent Component

simple-guess (system).

Public Interface

3.1.6 simple-guess/macros.lisp

Dependency

advisors.lisp (file).

Source

simple-guess.asd.

Parent Component

simple-guess (system).

Public Interface

4 Packages

Packages are listed by definition order.


4.1 simple-guess

Source

package.lisp.

Use List

common-lisp.

Public Interface

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *make-advisor-function*
Package

simple-guess.

Source

advisors.lisp.


5.1.2 Ordinary functions

Function: constant-advisor (advice)
Package

simple-guess.

Source

advisors.lisp.

Function: eager-advisor (&rest advisors)
Package

simple-guess.

Source

advisors.lisp.

Function: make-advisor (advisor-class &rest initargs)
Package

simple-guess.

Source

advisors.lisp.

Function: query-variant-advisor (advisor query-transformer)
Package

simple-guess.

Source

advisors.lisp.

Function: query-variants-advisor (advisor query-transformers &key group)
Package

simple-guess.

Source

macros.lisp.


5.1.3 Generic functions

Generic Reader: advice (object)
Package

simple-guess.

Methods
Reader Method: advice ((constant-advisor constant-advisor))

automatically generated reader method

Source

advisors.lisp.

Target Slot

%advice.

Generic Reader: advisor (object)
Package

simple-guess.

Methods
Reader Method: advisor ((advisor-mixin advisor-mixin))

automatically generated reader method

Source

mixins.lisp.

Target Slot

%advisors.

Generic Reader: advisors (object)
Package

simple-guess.

Methods
Reader Method: advisors ((advisors-mixin advisors-mixin))

automatically generated reader method

Source

mixins.lisp.

Target Slot

%advisors.

Generic Function: compute-expansion (macro-advisor)
Package

simple-guess.

Source

macros.lisp.

Methods
Method: compute-expansion ((advisor query-variants-advisor))
Generic Reader: expansion (macro-advisor)
Package

simple-guess.

Source

macros.lisp.

Methods
Reader Method: expansion ((standard-macro-advisor standard-macro-advisor))

automatically generated reader method

Target Slot

%expansion.

Generic Reader: grouping-function (object)
Package

simple-guess.

Methods
Reader Method: grouping-function ((query-variants-advisor query-variants-advisor))

automatically generated reader method

Source

macros.lisp.

Target Slot

%grouping-function.

Generic Function: inquire (manager advisor &rest query &key &allow-other-keys)
Package

simple-guess.

Source

core.lisp.

Methods
Method: inquire ((manager manager) (advisor macro-advisor) &rest query)
Source

macros.lisp.

Method: inquire ((manager manager) (advisor query-variant-advisor) &rest query)
Source

advisors.lisp.

Method: inquire ((manager manager) (advisor eager-advisor) &rest query)
Source

advisors.lisp.

Method: inquire ((manager manager) (advisor constant-advisor) &rest query)
Source

advisors.lisp.

Generic Reader: query-transformer (object)
Package

simple-guess.

Methods
Reader Method: query-transformer ((query-variant-advisor query-variant-advisor))

automatically generated reader method

Source

advisors.lisp.

Target Slot

%query-transformer.

Generic Reader: query-transformers (object)
Package

simple-guess.

Methods
Reader Method: query-transformers ((query-variants-advisor query-variants-advisor))

automatically generated reader method

Source

macros.lisp.

Target Slot

%query-transformers.


5.1.4 Standalone methods

Method: shared-initialize :after ((macro standard-macro-advisor) slot-names &rest initargs)
Source

macros.lisp.


5.1.5 Classes

Class: advisor
Package

simple-guess.

Source

core.lisp.

Direct subclasses
Class: advisor-mixin
Package

simple-guess.

Source

mixins.lisp.

Direct subclasses
Direct methods

advisor.

Direct slots
Slot: %advisors
Type

simple-guess:advisor

Initform

(error "~s is required." :advisor)

Initargs

:advisor

Readers

advisor.

Writers

This slot is read-only.

Class: advisors-mixin
Package

simple-guess.

Source

mixins.lisp.

Direct subclasses

eager-advisor.

Direct methods

advisors.

Direct slots
Slot: %advisors
Type

list

Initform

(error "~s is required." :advisors)

Initargs

:advisors

Readers

advisors.

Writers

This slot is read-only.

Class: constant-advisor
Package

simple-guess.

Source

advisors.lisp.

Direct superclasses

advisor.

Direct methods
Direct slots
Slot: %advice
Initargs

:advice

Readers

advice.

Writers

This slot is read-only.

Class: eager-advisor
Package

simple-guess.

Source

advisors.lisp.

Direct superclasses
Direct methods

inquire.

Class: macro-advisor
Package

simple-guess.

Source

macros.lisp.

Direct superclasses

advisor.

Direct subclasses

standard-macro-advisor.

Direct methods

inquire.

Class: manager
Package

simple-guess.

Source

core.lisp.

Direct methods
Class: query-variant-advisor
Package

simple-guess.

Source

advisors.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: %query-transformer
Initform

(error "~s is required." :query-transformer)

Initargs

:query-transformer

Readers

query-transformer.

Writers

This slot is read-only.

Class: query-variants-advisor
Package

simple-guess.

Source

macros.lisp.

Direct superclasses
Direct methods
Direct slots
Slot: %query-transformers
Type

list

Initform

(error "~s is required." :query-transformers)

Initargs

:query-transformers

Readers

query-transformers.

Writers

This slot is read-only.

Slot: %grouping-function
Type

(or function symbol)

Initform

(function simple-guess:eager-advisor)

Initargs

:grouping-function

Readers

grouping-function.

Writers

This slot is read-only.

Class: standard-macro-advisor
Package

simple-guess.

Source

macros.lisp.

Direct superclasses

macro-advisor.

Direct subclasses

query-variants-advisor.

Direct methods
Direct slots
Slot: %expansion
Type

simple-guess:advisor

Readers

expansion.

Writers

This slot is read-only.


5.2 Internals


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   C   E   F   G   I   M   Q   S  
Index Entry  Section

A
advice: Public generic functions
advice: Public generic functions
advisor: Public generic functions
advisor: Public generic functions
advisors: Public generic functions
advisors: Public generic functions

C
compute-expansion: Public generic functions
compute-expansion: Public generic functions
constant-advisor: Public ordinary functions

E
eager-advisor: Public ordinary functions
expansion: Public generic functions
expansion: Public generic functions

F
Function, constant-advisor: Public ordinary functions
Function, eager-advisor: Public ordinary functions
Function, make-advisor: Public ordinary functions
Function, query-variant-advisor: Public ordinary functions
Function, query-variants-advisor: Public ordinary functions

G
Generic Function, advice: Public generic functions
Generic Function, advisor: Public generic functions
Generic Function, advisors: Public generic functions
Generic Function, compute-expansion: Public generic functions
Generic Function, expansion: Public generic functions
Generic Function, grouping-function: Public generic functions
Generic Function, inquire: Public generic functions
Generic Function, query-transformer: Public generic functions
Generic Function, query-transformers: Public generic functions
grouping-function: Public generic functions
grouping-function: Public generic functions

I
inquire: Public generic functions
inquire: Public generic functions
inquire: Public generic functions
inquire: Public generic functions
inquire: Public generic functions

M
make-advisor: Public ordinary functions
Method, advice: Public generic functions
Method, advisor: Public generic functions
Method, advisors: Public generic functions
Method, compute-expansion: Public generic functions
Method, expansion: Public generic functions
Method, grouping-function: Public generic functions
Method, inquire: Public generic functions
Method, inquire: Public generic functions
Method, inquire: Public generic functions
Method, inquire: Public generic functions
Method, query-transformer: Public generic functions
Method, query-transformers: Public generic functions
Method, shared-initialize: Public standalone methods

Q
query-transformer: Public generic functions
query-transformer: Public generic functions
query-transformers: Public generic functions
query-transformers: Public generic functions
query-variant-advisor: Public ordinary functions
query-variants-advisor: Public ordinary functions

S
shared-initialize: Public standalone methods


A.4 Data types

Jump to:   A   C   E   F   M   P   Q   S  
Index Entry  Section

A
advisor: Public classes
advisor-mixin: Public classes
advisors-mixin: Public classes
advisors.lisp: The simple-guess/advisors․lisp file

C
Class, advisor: Public classes
Class, advisor-mixin: Public classes
Class, advisors-mixin: Public classes
Class, constant-advisor: Public classes
Class, eager-advisor: Public classes
Class, macro-advisor: Public classes
Class, manager: Public classes
Class, query-variant-advisor: Public classes
Class, query-variants-advisor: Public classes
Class, standard-macro-advisor: Public classes
constant-advisor: Public classes
core.lisp: The simple-guess/core․lisp file

E
eager-advisor: Public classes

F
File, advisors.lisp: The simple-guess/advisors․lisp file
File, core.lisp: The simple-guess/core․lisp file
File, macros.lisp: The simple-guess/macros․lisp file
File, mixins.lisp: The simple-guess/mixins․lisp file
File, package.lisp: The simple-guess/package․lisp file
File, simple-guess.asd: The simple-guess/simple-guess․asd file

M
macro-advisor: Public classes
macros.lisp: The simple-guess/macros․lisp file
manager: Public classes
mixins.lisp: The simple-guess/mixins․lisp file

P
Package, simple-guess: The simple-guess package
package.lisp: The simple-guess/package․lisp file

Q
query-variant-advisor: Public classes
query-variants-advisor: Public classes

S
simple-guess: The simple-guess system
simple-guess: The simple-guess package
simple-guess.asd: The simple-guess/simple-guess․asd file
standard-macro-advisor: Public classes
System, simple-guess: The simple-guess system