The parameterized-function Reference Manual

Table of Contents

The parameterized-function Reference Manual

This is the parameterized-function Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Feb 19 21:16:49 2020 GMT+0.

1 Introduction

                        PARAMETERIZED-FUNCTION
                        ======================

                           By Robert Smith

This package provides functions which can be parameterized, whose
parameters are dispatched at compile time.

Parameterized functions are defined by first declaring the "dispatch
function". For example, if we wanted a general multiply function that
gets dispatched at compile time, we might declare the following:

  (define-dispatch-function mult (xtype ytype) (x y))

Next, we can define several parameterized functions.

  (define-parameterized-function mult (:integer :integer) (x y)
    (* x y))

  (define-parameterized-function mult (:integer :string) (x y)
    (with-output-to-string (s)
      (loop :repeat x
            :do (write-string y s))))

  (define-parameterized-function mult (:string :integer) (y x)
    (with-output-to-string (s)
      (loop :repeat x
            :do (write-string y s))))

  (define-parameterized-function mult (:string :string) (x y)
    (concatenate 'string x y)))

If we call MULT with a constant (quoted) list as the first argument,
then it will be expanded, at compile time, to one of the above
definitions. If the first argument is not constant, then dispatch will
occur at runtime.

2 Systems

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

2.1 parameterized-function

Author

Robert Smith <quad@symbo1ics.com>

License

BSD 3-clause (See LICENSE)

Description

Compile-time parameterized functions.

Dependency

interface

Source

parameterized-function.asd (file)

Components

• license (file)
• package.lisp (file)
• parameterized-function.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 parameterized-function.asd

Location

parameterized-function.asd

Systems

parameterized-function (system)

3.1.2 parameterized-function/package.lisp

Dependency

license (file)

Parent

parameterized-function (system)

Location

package.lisp

Packages

parameterized-function

3.1.3 parameterized-function/parameterized-function.lisp

Dependency

package.lisp (file)

Parent

parameterized-function (system)

Location

parameterized-function.lisp

Exported Definitions

• *warn-about-dynamic-dispatch* (special variable)
• *warn-about-non-constant-parameters* (special variable)
• define-dispatch-function (macro)
• define-parameterized-function (macro)

Internal Definitions

• constant-quoted-list-p (function)
• dispatch-table-name (function)
• generate-name-from-parameters (function)
• undispatch-form (function)

3.2 Static

3.2.1 parameterized-function/LICENSE

Parent

parameterized-function (system)

Location

LICENSE

4 Packages

Packages are listed by definition order.

4.1 parameterized-function

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• *warn-about-dynamic-dispatch* (special variable)
• *warn-about-non-constant-parameters* (special variable)
• define-dispatch-function (macro)
• define-parameterized-function (macro)

Internal Definitions

• constant-quoted-list-p (function)
• dispatch-table-name (function)
• generate-name-from-parameters (function)
• undispatch-form (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *warn-about-dynamic-dispatch*

Enables run-time warnings when dynamic dispatch occurs.

Package

parameterized-function

Source

parameterized-function.lisp (file)

Special Variable: *warn-about-non-constant-parameters*

Enables compile-time warnings when dynamic dispatch will occur because of non-constant parameters.

Package

parameterized-function

Source

parameterized-function.lisp (file)

5.1.2 Macros

Macro: define-dispatch-function NAME (&rest PARAMETERS) (&rest ARGS) &key DOCUMENTATION

Package

parameterized-function

Source

parameterized-function.lisp (file)

Macro: define-parameterized-function NAME (&rest PARAMETERS) (&rest ARGS) &body BODY

Define a parameterized function named NAME whose parameter variables are PARAMETERS, whose lambda list is ARGS, and body is BODY.

Package

parameterized-function

Source

parameterized-function.lisp (file)

5.2 Internal definitions

5.2.1 Functions

Function: constant-quoted-list-p L &optional ENV

Package

parameterized-function

Source

parameterized-function.lisp (file)

Function: dispatch-table-name NAME

Package

parameterized-function

Source

parameterized-function.lisp (file)

Function: generate-name-from-parameters FN PARAMS &optional SUFFIX

Package

parameterized-function

Source

parameterized-function.lisp (file)

Function: undispatch-form FORM NEW-FUNCTION-NAME

Package

parameterized-function

Source

parameterized-function.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types