The memoize Reference Manual

Table of Contents

The memoize Reference Manual

This is the memoize Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 18:42:07 2020 GMT+0.

1 Systems

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

1.1 memoize

Source

memoize.asd (file)

Component

memoize.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 memoize.asd

Location

memoize.asd

Systems

memoize (system)

2.1.2 memoize/memoize.lisp

Parent

memoize (system)

Location

memoize.lisp

Packages

org.tfeb.hax.memoize

Exported Definitions

• clear-memoized-function (function)
• clear-memoized-functions (function)
• def-memoized-function (macro)
• function-memoized-p (function)
• memoize-function (function)
• memoized-labels (macro)
• unmemoize-function (function)
• unmemoize-functions (function)

Internal Definitions

• *memoized-functions* (special variable)
• make-memo (function)

3 Packages

Packages are listed by definition order.

3.1 org.tfeb.hax.memoize

Source

memoize.lisp (file)

Use List

common-lisp

Exported Definitions

• clear-memoized-function (function)
• clear-memoized-functions (function)
• def-memoized-function (macro)
• function-memoized-p (function)
• memoize-function (function)
• memoized-labels (macro)
• unmemoize-function (function)
• unmemoize-functions (function)

Internal Definitions

• *memoized-functions* (special variable)
• make-memo (function)

4 Definitions

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

4.1 Exported definitions

4.1.1 Macros

Macro: def-memoized-function FNSPEC ARGS &body BOD

Define a memoized function.
FNSPEC is either the name of the function, or a list suitable as an arglist for MEMOIZE-FUNCTION. ARGS & BOD are passed off to DEFUN.

This will declare FNSPEC NOTINLINE, which may be necessary to prevent good compilers optimizing away self calls & stuff like that.

Package

org.tfeb.hax.memoize

Source

memoize.lisp (file)

Macro: memoized-labels (&rest LABDEFS) &body BOD

A version of LABELS that memoizes the local functions. See MEMOIZE-FUNCTION and DEF-MEMOIZED-FUNCTION. If code that uses this is compiled (either by COMPILE or COMPILE-FILE, then the table of memoized results will be unique, if interpreted then a new table may be generated for each use. The function ‘names’ are generalised in the same way as for DEF-MEMOIZED-FUNCTION.

Package

org.tfeb.hax.memoize

Source

memoize.lisp (file)

4.1.2 Functions

Function: clear-memoized-function FN-NAME

Clear memoized results for FN-NAME

Package

org.tfeb.hax.memoize

Source

memoize.lisp (file)

Function: clear-memoized-functions ()

Clear memoized results for all functions

Package

org.tfeb.hax.memoize

Source

memoize.lisp (file)

Function: function-memoized-p FN-NAME

Is FN-NAME memoized?

Package

org.tfeb.hax.memoize

Source

memoize.lisp (file)

Function: memoize-function FN-NAME &key KEY TEST

Memoize FN-NAME, a symbol, causing its results to be stashed.
KEY is a function which is given the arglist of FN-NAME, and should return a key to hash on for memoizing. TEST is a function which the test for the ashtable.
See Norvig P269-275.

Note this function may not work on self-recursive functions because the compiler can optimize away self-calls in various ways. DEF-MEMOIZED-FUNCTION should work for those cases as it is careful to ensure the function can not be inlined like this.

Package

org.tfeb.hax.memoize

Source

memoize.lisp (file)

Function: unmemoize-function FN-NAME

Remove memoization for FN-NAME

Package

org.tfeb.hax.memoize

Source

memoize.lisp (file)

Function: unmemoize-functions ()

Unmemoize all functions

Package

org.tfeb.hax.memoize

Source

memoize.lisp (file)

4.2 Internal definitions

4.2.1 Special variables

Special Variable: *memoized-functions*

Package

org.tfeb.hax.memoize

Source

memoize.lisp (file)

4.2.2 Functions

Function: make-memo FN KEY TEST

Package

org.tfeb.hax.memoize

Source

memoize.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types