The filtered-functions Reference Manual

Table of Contents

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

The filtered-functions Reference Manual

This is the filtered-functions Reference Manual, version 0.2.0, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:38:43 2018 GMT+0.


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

1 Introduction

Filtered Functions

Filtered functions provide an extension of CLOS generic function invocation that add a simple preprocessing step before the actual method dispatch is performed and thus enable the use of arbitrary predicates for selecting and applying methods. See Filtered Dispatch for a paper that introduces and explains filtered functions in detail.

Filtered functions are also provided by Quicklisp.

Filtered functions depend on Closer to MOP, and are therefore only supported by the Common Lisp implementations that are supported by that library.

New in version 0.2.0:


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 filtered-functions

Author

Pascal Costanza

License

MIT-style license

Description

Filtered functions provide an extension of generic function invocation that add a simple preprocessing step before the actual method dispatch is performed and thus enable the use of arbitrary predicates for selecting and applying methods.

Version

0.2.0

Dependency

closer-mop

Source

filtered-functions.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 filtered-functions.asd

Location

filtered-functions.asd

Systems

filtered-functions (system)


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

3.1.2 filtered-functions/filtered-functions-packages.lisp

Parent

filtered-functions (system)

Location

filtered-functions-packages.lisp

Packages

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

3.1.3 filtered-functions/filtered-functions.lisp

Dependency

filtered-functions-packages.lisp (file)

Parent

filtered-functions (system)

Location

filtered-functions.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 filtered-functions-user

Source

filtered-functions-packages.lisp (file)

Use List

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

4.2 filtered-functions

Source

filtered-functions-packages.lisp (file)

Use List

closer-common-lisp

Used By List

filtered-functions-user

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Macros

Macro: define-filtered-function NAME (&rest LAMBDA-LIST) &body OPTIONS
Package

filtered-functions

Source

filtered-functions.lisp (file)


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

5.1.2 Generic functions

Generic Function: generic-function-filter-expression GF
Package

filtered-functions

Source

filtered-functions.lisp (file)

Methods
Method: generic-function-filter-expression (SIMPLE-FILTERED-FUNCTION simple-filtered-function)

automatically generated reader method

Method: generic-function-filter-expression (GF generic-function)
Generic Function: generic-function-filters FF
Generic Function: (setf generic-function-filters) NEW-FILTERS FF
Package

filtered-functions

Source

filtered-functions.lisp (file)

Methods
Method: generic-function-filters (FF filtered-function)
Generic Function: method-filter METHOD
Package

filtered-functions

Source

filtered-functions.lisp (file)

Methods
Method: method-filter (FILTERED-METHOD filtered-method)

automatically generated reader method

Method: method-filter (METHOD method)

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

5.1.3 Method combinations

Long Method Combination: filtered ()
Package

filtered-functions

Source

filtered-functions.lisp (file)


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

5.1.4 Classes

Class: filtered-function ()
Package

filtered-functions

Source

filtered-functions.lisp (file)

Direct superclasses

standard-generic-function (class)

Direct methods
  • remove-method (method)
  • add-method (method)
  • compute-discriminating-function (method)
  • compute-applicable-methods (method)
  • compute-applicable-methods-using-classes (method)
  • generic-function-filters (method)
  • generic-function-filters (method)
  • reinitialize-instance (method)
  • initialize-instance (method)
  • %filter-groups (method)
Direct slots
Slot: filter-groups
Initform

(quote nil)

Readers

%filter-groups (generic function)

Class: filtered-method ()
Package

filtered-functions

Source

filtered-functions.lisp (file)

Direct superclasses

standard-method (class)

Direct methods
Direct slots
Slot: filter
Readers

method-filter (generic function)

Class: simple-filtered-function ()
Package

filtered-functions

Source

filtered-functions.lisp (file)

Direct superclasses

standard-generic-function (class)

Direct methods
Direct slots
Slot: filter-expression
Initargs

:filter-expression

Readers

generic-function-filter-expression (generic function)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *generic-functions*
Package

filtered-functions

Source

filtered-functions.lisp (file)


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

5.2.2 Functions

Function: check-filters FF FILTERS
Package

filtered-functions

Source

filtered-functions.lisp (file)


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

5.2.3 Generic functions

Generic Function: %filter-groups OBJECT
Package

filtered-functions

Methods
Method: %filter-groups (FILTERED-FUNCTION filtered-function)

automatically generated reader method

Source

filtered-functions.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L  
Index Entry  Section

F
File, Lisp, filtered-functions.asd: The filtered-functions<dot>asd file
File, Lisp, filtered-functions/filtered-functions-packages.lisp: The filtered-functions/filtered-functions-packages<dot>lisp file
File, Lisp, filtered-functions/filtered-functions.lisp: The filtered-functions/filtered-functions<dot>lisp file
filtered-functions.asd: The filtered-functions<dot>asd file
filtered-functions/filtered-functions-packages.lisp: The filtered-functions/filtered-functions-packages<dot>lisp file
filtered-functions/filtered-functions.lisp: The filtered-functions/filtered-functions<dot>lisp file

L
Lisp File, filtered-functions.asd: The filtered-functions<dot>asd file
Lisp File, filtered-functions/filtered-functions-packages.lisp: The filtered-functions/filtered-functions-packages<dot>lisp file
Lisp File, filtered-functions/filtered-functions.lisp: The filtered-functions/filtered-functions<dot>lisp file

Jump to:   F   L  

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

A.2 Functions

Jump to:   %   (  
C   D   F   G   M  
Index Entry  Section

%
%filter-groups: Internal generic functions
%filter-groups: Internal generic functions

(
(setf generic-function-filters): Exported generic functions

C
check-filters: Internal functions

D
define-filtered-function: Exported macros

F
Function, check-filters: Internal functions

G
Generic Function, %filter-groups: Internal generic functions
Generic Function, (setf generic-function-filters): Exported generic functions
Generic Function, generic-function-filter-expression: Exported generic functions
Generic Function, generic-function-filters: Exported generic functions
Generic Function, method-filter: Exported generic functions
generic-function-filter-expression: Exported generic functions
generic-function-filter-expression: Exported generic functions
generic-function-filter-expression: Exported generic functions
generic-function-filters: Exported generic functions
generic-function-filters: Exported generic functions

M
Macro, define-filtered-function: Exported macros
Method, %filter-groups: Internal generic functions
Method, generic-function-filter-expression: Exported generic functions
Method, generic-function-filter-expression: Exported generic functions
Method, generic-function-filters: Exported generic functions
Method, method-filter: Exported generic functions
Method, method-filter: Exported generic functions
method-filter: Exported generic functions
method-filter: Exported generic functions
method-filter: Exported generic functions

Jump to:   %   (  
C   D   F   G   M  

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

A.3 Variables

Jump to:   *  
F   S  
Index Entry  Section

*
*generic-functions*: Internal special variables

F
filter: Exported classes
filter-expression: Exported classes
filter-groups: Exported classes

S
Slot, filter: Exported classes
Slot, filter-expression: Exported classes
Slot, filter-groups: Exported classes
Special Variable, *generic-functions*: Internal special variables

Jump to:   *  
F   S  

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

A.4 Data types

Jump to:   C   F   L   M   P   S  
Index Entry  Section

C
Class, filtered-function: Exported classes
Class, filtered-method: Exported classes
Class, simple-filtered-function: Exported classes

F
filtered: Exported method combinations
filtered-function: Exported classes
filtered-functions: The filtered-functions system
filtered-functions: The filtered-functions package
filtered-functions-user: The filtered-functions-user package
filtered-method: Exported classes

L
Long Method Combination, filtered: Exported method combinations

M
Method Combination, Long, filtered: Exported method combinations

P
Package, filtered-functions: The filtered-functions package
Package, filtered-functions-user: The filtered-functions-user package

S
simple-filtered-function: Exported classes
System, filtered-functions: The filtered-functions system

Jump to:   C   F   L   M   P   S