The defmemo Reference Manual

Table of Contents

The defmemo Reference Manual

This is the defmemo Reference Manual, version 1.5, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 10:07:35 2019 GMT+0.

1 Introduction

Defmemo

Defmemo is a generic defun form, performing memoization over calls to such defined function. It supports arbitrary lambda lists and multiple return values. (optimize speed)-friendly, otherwise it might have been implemented as in Peter Norvig's PAIP. Preserves arguments and documentation. Memoizing hash table is stored under property :memo of defmemo'ed function.

Usage

Three functions are exported: defmemo (like defun), get-memo and clear-memo (defmemo'ed symbol). Clear-memo is not needed on implementations supporting weak hash tables (via trivial-garbage).

(defmemo fib (n)
  (if (<= n 1)
      1
      (+ (fib (- n 1))
         (fib (- n 2)))))

(fib 100)
; => 573147844013817084101

(get-memo 'fib)
; => #<hash-table :TEST equal :COUNT 101 :WEAKNESS :key>

(hash-table-count (clear-memo 'fib))
; => 0

2 Systems

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

2.1 defmemo

Author

Orivej Desh <orivej@gmx.fr>

License

Unlicense <http://unlicense.org/UNLICENSE>

Description

Memoizing defun

Version

1.5

Dependencies

• alexandria
• trivial-garbage

Source

defmemo.asd (file)

Components

• package.lisp (file)
• defmemo.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 defmemo.asd

Location

defmemo.asd

Systems

defmemo (system)

3.1.2 defmemo/package.lisp

Parent

defmemo (system)

Location

package.lisp

Packages

defmemo

3.1.3 defmemo/defmemo.lisp

Dependency

package.lisp (file)

Parent

defmemo (system)

Location

defmemo.lisp

Exported Definitions

• clear-memo (function)
• defmemo (macro)
• get-memo (function)
• (setf get-memo) (function)

Internal Definitions

flat-arglist (function)

4 Packages

Packages are listed by definition order.

4.1 defmemo

Source

package.lisp (file)

Use List

• trivial-garbage
• alexandria.1.0.0
• common-lisp

Exported Definitions

• clear-memo (function)
• defmemo (macro)
• get-memo (function)
• (setf get-memo) (function)

Internal Definitions

flat-arglist (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: defmemo NAME ARGS &body BODY

Construct defun with body wrapped into memoizing hash table. Put the latter under :memo property of name.

Package

defmemo

Source

defmemo.lisp (file)

5.1.2 Functions

Function: clear-memo SYMBOL

Reset memoizing hash table.

Package

defmemo

Source

defmemo.lisp (file)

Function: get-memo SYMBOL

Get memoizing hash table.

Package

defmemo

Source

defmemo.lisp (file)

Writer

(setf get-memo) (function)

Function: (setf get-memo) VALUE SYMBOL

Replace memoizing hash of symbol with value.

Package

defmemo

Source

defmemo.lisp (file)

Reader

get-memo (function)

5.2 Internal definitions

5.2.1 Functions

Function: flat-arglist ARGS

Convert ordinary lambda list into funcallable list.

Package

defmemo

Source

defmemo.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types