The simple-guess Reference Manual

Table of Contents

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

The simple-guess Reference Manual

This is the simple-guess Reference Manual, version 1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Nov 04 15:14:33 2020 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Project's home: https://www.hexstreamsoft.com/libraries/simple-guess/


simple-guess defines a simple extensible protocol for computing a guess using advisors.


This library is in the Public Domain.
See the UNLICENSE file for details.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


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

2.1 simple-guess

Author

Jean-Philippe Paradis <hexstream@hexstreamsoft.com>

License

Unlicense

Description

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

Version

1.0

Source

simple-guess.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


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

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 simple-guess.asd

Location

simple-guess.asd

Systems

simple-guess (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 simple-guess/package.lisp

Parent

simple-guess (system)

Location

package.lisp

Packages

simple-guess


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 simple-guess/core.lisp

Dependency

package.lisp (file)

Parent

simple-guess (system)

Location

core.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 simple-guess/mixins.lisp

Dependency

core.lisp (file)

Parent

simple-guess (system)

Location

mixins.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 simple-guess/advisors.lisp

Dependency

mixins.lisp (file)

Parent

simple-guess (system)

Location

advisors.lisp

Exported Definitions

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

3.1.6 simple-guess/macros.lisp

Dependency

advisors.lisp (file)

Parent

simple-guess (system)

Location

macros.lisp

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


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

4.1 simple-guess

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *make-advisor-function*
Package

simple-guess

Source

advisors.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: constant-advisor ADVICE
Package

simple-guess

Source

advisors.lisp (file)

Function: eager-advisor &rest ADVISORS
Package

simple-guess

Source

advisors.lisp (file)

Function: make-advisor ADVISOR-CLASS &rest INITARGS
Package

simple-guess

Source

advisors.lisp (file)

Function: query-variant-advisor ADVISOR QUERY-TRANSFORMER
Package

simple-guess

Source

advisors.lisp (file)

Function: query-variants-advisor ADVISOR QUERY-TRANSFORMERS &key GROUP
Package

simple-guess

Source

macros.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Generic functions

Generic Function: advice OBJECT
Package

simple-guess

Methods
Method: advice (CONSTANT-ADVISOR constant-advisor)

automatically generated reader method

Source

advisors.lisp (file)

Generic Function: advisor OBJECT
Package

simple-guess

Methods
Method: advisor (ADVISOR-MIXIN advisor-mixin)

automatically generated reader method

Source

mixins.lisp (file)

Generic Function: advisors OBJECT
Package

simple-guess

Methods
Method: advisors (ADVISORS-MIXIN advisors-mixin)

automatically generated reader method

Source

mixins.lisp (file)

Generic Function: compute-expansion MACRO-ADVISOR
Package

simple-guess

Source

macros.lisp (file)

Methods
Method: compute-expansion (ADVISOR query-variants-advisor)
Generic Function: expansion MACRO-ADVISOR
Package

simple-guess

Source

macros.lisp (file)

Methods
Method: expansion (STANDARD-MACRO-ADVISOR standard-macro-advisor)

automatically generated reader method

Generic Function: grouping-function OBJECT
Package

simple-guess

Methods
Method: grouping-function (QUERY-VARIANTS-ADVISOR query-variants-advisor)

automatically generated reader method

Source

macros.lisp (file)

Generic Function: inquire MANAGER ADVISOR &rest QUERY &key &allow-other-keys
Package

simple-guess

Source

core.lisp (file)

Methods
Method: inquire (MANAGER manager) (ADVISOR macro-advisor) &rest QUERY
Source

macros.lisp (file)

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

advisors.lisp (file)

Method: inquire (MANAGER manager) (ADVISOR eager-advisor) &rest QUERY
Source

advisors.lisp (file)

Method: inquire (MANAGER manager) (ADVISOR constant-advisor) &rest QUERY
Source

advisors.lisp (file)

Generic Function: query-transformer OBJECT
Package

simple-guess

Methods
Method: query-transformer (QUERY-VARIANT-ADVISOR query-variant-advisor)

automatically generated reader method

Source

advisors.lisp (file)

Generic Function: query-transformers OBJECT
Package

simple-guess

Methods
Method: query-transformers (QUERY-VARIANTS-ADVISOR query-variants-advisor)

automatically generated reader method

Source

macros.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Classes

Class: advisor ()
Package

simple-guess

Source

core.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Class: advisor-mixin ()
Package

simple-guess

Source

mixins.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods

advisor (method)

Direct slots
Slot: %advisors
Type

simple-guess:advisor

Initargs

:advisor

Initform

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

Readers

advisor (generic function)

Class: advisors-mixin ()
Package

simple-guess

Source

mixins.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

eager-advisor (class)

Direct methods

advisors (method)

Direct slots
Slot: %advisors
Type

list

Initargs

:advisors

Initform

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

Readers

advisors (generic function)

Class: constant-advisor ()
Package

simple-guess

Source

advisors.lisp (file)

Direct superclasses

advisor (class)

Direct methods
Direct slots
Slot: %advice
Initargs

:advice

Readers

advice (generic function)

Class: eager-advisor ()
Package

simple-guess

Source

advisors.lisp (file)

Direct superclasses
Direct methods

inquire (method)

Class: macro-advisor ()
Package

simple-guess

Source

macros.lisp (file)

Direct superclasses

advisor (class)

Direct subclasses

standard-macro-advisor (class)

Direct methods

inquire (method)

Class: manager ()
Package

simple-guess

Source

core.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Class: query-variant-advisor ()
Package

simple-guess

Source

advisors.lisp (file)

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

:query-transformer

Initform

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

Readers

query-transformer (generic function)

Class: query-variants-advisor ()
Package

simple-guess

Source

macros.lisp (file)

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

list

Initargs

:query-transformers

Initform

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

Readers

query-transformers (generic function)

Slot: %grouping-function
Type

(or function symbol)

Initargs

:grouping-function

Initform

(function simple-guess:eager-advisor)

Readers

grouping-function (generic function)

Class: standard-macro-advisor ()
Package

simple-guess

Source

macros.lisp (file)

Direct superclasses

macro-advisor (class)

Direct subclasses

query-variants-advisor (class)

Direct methods
  • shared-initialize (method)
  • expansion (method)
Direct slots
Slot: %expansion
Type

simple-guess:advisor

Readers

expansion (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   S  
Index Entry  Section

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

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

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

Jump to:   F   L   S  

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

A.2 Functions

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

A
advice: Exported generic functions
advice: Exported generic functions
advisor: Exported generic functions
advisor: Exported generic functions
advisors: Exported generic functions
advisors: Exported generic functions

C
compute-expansion: Exported generic functions
compute-expansion: Exported generic functions
constant-advisor: Exported functions

E
eager-advisor: Exported functions
expansion: Exported generic functions
expansion: Exported generic functions

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

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

I
inquire: Exported generic functions
inquire: Exported generic functions
inquire: Exported generic functions
inquire: Exported generic functions
inquire: Exported generic functions

M
make-advisor: Exported functions
Method, advice: Exported generic functions
Method, advisor: Exported generic functions
Method, advisors: Exported generic functions
Method, compute-expansion: Exported generic functions
Method, expansion: Exported generic functions
Method, grouping-function: Exported generic functions
Method, inquire: Exported generic functions
Method, inquire: Exported generic functions
Method, inquire: Exported generic functions
Method, inquire: Exported generic functions
Method, query-transformer: Exported generic functions
Method, query-transformers: Exported generic functions

Q
query-transformer: Exported generic functions
query-transformer: Exported generic functions
query-transformers: Exported generic functions
query-transformers: Exported generic functions
query-variant-advisor: Exported functions
query-variants-advisor: Exported functions

Jump to:   A   C   E   F   G   I   M   Q  

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

A.3 Variables

Jump to:   %   *  
S  
Index Entry  Section

%
%advice: Exported classes
%advisors: Exported classes
%advisors: Exported classes
%expansion: Exported classes
%grouping-function: Exported classes
%query-transformer: Exported classes
%query-transformers: Exported classes

*
*make-advisor-function*: Exported special variables

S
Slot, %advice: Exported classes
Slot, %advisors: Exported classes
Slot, %advisors: Exported classes
Slot, %expansion: Exported classes
Slot, %grouping-function: Exported classes
Slot, %query-transformer: Exported classes
Slot, %query-transformers: Exported classes
Special Variable, *make-advisor-function*: Exported special variables

Jump to:   %   *  
S  

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

A.4 Data types

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

A
advisor: Exported classes
advisor-mixin: Exported classes
advisors-mixin: Exported classes

C
Class, advisor: Exported classes
Class, advisor-mixin: Exported classes
Class, advisors-mixin: Exported classes
Class, constant-advisor: Exported classes
Class, eager-advisor: Exported classes
Class, macro-advisor: Exported classes
Class, manager: Exported classes
Class, query-variant-advisor: Exported classes
Class, query-variants-advisor: Exported classes
Class, standard-macro-advisor: Exported classes
constant-advisor: Exported classes

E
eager-advisor: Exported classes

M
macro-advisor: Exported classes
manager: Exported classes

P
Package, simple-guess: The simple-guess package

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

S
simple-guess: The simple-guess system
simple-guess: The simple-guess package
standard-macro-advisor: Exported classes
System, simple-guess: The simple-guess system

Jump to:   A   C   E   M   P   Q   S