The convolution-kernel Reference Manual

This is the convolution-kernel Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:20:20 2022 GMT+0.

1 Introduction

convolution-kernel

Overview

An implementation of a kernel useful for convolution-like cellular transformations across a grid.

Install

(ql:quickload :convolution-kernel)

License

Licensed under the MIT License.

2 Systems

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

convolution-kernel

2.1 `convolution-kernel`

An implementation of a kernel useful for convolution-like cellular transformations across a grid.

Author

Michael Fiano <mail@mfiano.net>

Home Page

https://git.mfiano.net/mfiano/convolution-kernel

License

MIT

Version

0.1.0

Dependencies

tile-grid (system).
mfiano-utils (system).

Source

convolution-kernel.asd.

Child Components

package.lisp (file).
convolution-kernel.lisp (file).

3 Files

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

Lisp

3.1 Lisp

convolution-kernel/convolution-kernel.asd
convolution-kernel/package.lisp
convolution-kernel/convolution-kernel.lisp

3.1.1 `convolution-kernel/convolution-kernel.asd`

Source: convolution-kernel.asd.
Parent Component: convolution-kernel (system).
ASDF Systems: convolution-kernel.

3.1.2 `convolution-kernel/package.lisp`

Source: convolution-kernel.asd.
Parent Component: convolution-kernel (system).
Packages: convolution-kernel.

3.1.3 `convolution-kernel/convolution-kernel.lisp`

Dependency

package.lisp (file).

Source

convolution-kernel.asd.

Parent Component

convolution-kernel (system).

Public Interface

add-properties (method).
align (function).
cell-contains-p (method).
collect (function).
convolve (function).
count (function).
detect (function).
do-kernel (macro).
find (function).
flood-fill (function).
make-kernel (function).
map (function).
origin (function).
process (function).
remove-properties (method).
reshape (function).
resolve (function).

Internals

%make-kernel (function).
%resolve (macro).
*shapes* (special variable).
default-mapper (macro).
define-shape (macro).
do/+ (macro).
do/ellipse (macro).
do/rect (macro).
do/x (macro).
grid (reader).
(setf grid) (writer).
kernel (structure).
kernel-p (function).
map/+ (function).
map/ellipse (function).
map/rect (function).
map/x (function).
mapper (reader).
(setf mapper) (writer).
max-x (reader).
(setf max-x) (writer).
max-y (reader).
(setf max-y) (writer).
min-x (reader).
(setf min-x) (writer).
min-y (reader).
(setf min-y) (writer).
register-shape (function).
shape (reader).
(setf shape) (writer).
x (reader).
(setf x) (writer).
y (reader).
(setf y) (writer).

4 Packages

Packages are listed by definition order.

convolution-kernel

4.1 `convolution-kernel`

Source

package.lisp.

Use List

common-lisp.

Public Interface

align (function).
collect (function).
convolve (function).
count (function).
detect (function).
do-kernel (macro).
find (function).
flood-fill (function).
make-kernel (function).
map (function).
origin (function).
process (function).
reshape (function).
resolve (function).

Internals

%make-kernel (function).
%resolve (macro).
*shapes* (special variable).
default-mapper (macro).
define-shape (macro).
do/+ (macro).
do/ellipse (macro).
do/rect (macro).
do/x (macro).
grid (reader).
(setf grid) (writer).
kernel (structure).
kernel-p (function).
map/+ (function).
map/ellipse (function).
map/rect (function).
map/x (function).
mapper (reader).
(setf mapper) (writer).
max-x (reader).
(setf max-x) (writer).
max-y (reader).
(setf max-y) (writer).
min-x (reader).
(setf min-x) (writer).
min-y (reader).
(setf min-y) (writer).
register-shape (function).
shape (reader).
(setf shape) (writer).
x (reader).
(setf x) (writer).
y (reader).
(setf y) (writer).

5 Definitions

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

Public Interface
Internals

5.1.1 Macros

Macro: do-kernel ((kernel cell) &body body) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

5.1.2 Ordinary functions

Function: align (kernel cell) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Function: collect (kernel test) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Function: convolve (kernel func &optional test) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Function: count (kernel func) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Function: detect (kernel func &optional count) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Function: find (kernel test) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Function: flood-fill (kernel cell test visited) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Function: make-kernel (grid shape &key x y min-x max-x min-y max-y) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Function: map (kernel func) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Function: origin (kernel) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Function: process (kernel processor &key items test generator) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Function: reshape (kernel shape) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Function: resolve (kernel x y) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

5.1.3 Standalone methods

Method: add-properties :around ((cell kernel) type &rest properties) ¶

Package: tile-grid.
Source: convolution-kernel.lisp.

Method: cell-contains-p :around ((cell kernel) type property) ¶

Package: tile-grid.
Source: convolution-kernel.lisp.

Method: remove-properties :around ((cell kernel) type &rest properties) ¶

Package: tile-grid.
Source: convolution-kernel.lisp.

5.2 Internals

Special variables
Macros
Ordinary functions
Structures

5.2.1 Special variables

Special Variable: *shapes* ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

5.2.2 Macros

Macro: %resolve (grid ox oy x y) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Macro: default-mapper (test) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Macro: define-shape (shape () &body body) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Macro: do/+ ((kernel cell) &body body) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Macro: do/ellipse ((kernel cell) &body body) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Macro: do/rect ((kernel cell) &body body) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Macro: do/x ((kernel cell) &body body) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

5.2.3 Ordinary functions

Function: %make-kernel (shape grid x y mapper min-x max-x min-y max-y) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Reader: grid (instance) ¶

Writer: (setf grid) (instance) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.
Target Slot: grid.

Function: kernel-p (object) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Function: map/+ (kernel func) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Function: map/ellipse (kernel func) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Function: map/rect (kernel func) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Function: map/x (kernel func) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Reader: mapper (instance) ¶

Writer: (setf mapper) (instance) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.
Target Slot: mapper.

Reader: max-x (instance) ¶

Writer: (setf max-x) (instance) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.
Target Slot: max-x.

Reader: max-y (instance) ¶

Writer: (setf max-y) (instance) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.
Target Slot: max-y.

Reader: min-x (instance) ¶

Writer: (setf min-x) (instance) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.
Target Slot: min-x.

Reader: min-y (instance) ¶

Writer: (setf min-y) (instance) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.
Target Slot: min-y.

Function: register-shape (name mapper) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.

Reader: shape (instance) ¶

Writer: (setf shape) (instance) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.
Target Slot: shape.

Reader: x (instance) ¶

Writer: (setf x) (instance) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.
Target Slot: x.

Reader: y (instance) ¶

Writer: (setf y) (instance) ¶

Package: convolution-kernel.
Source: convolution-kernel.lisp.
Target Slot: y.

5.2.4 Structures

Structure: kernel ¶

Package

convolution-kernel.

Source

convolution-kernel.lisp.

Direct superclasses

structure-object.

Direct methods

add-properties.
cell-contains-p.
remove-properties.

Direct slots

Slot: shape ¶

Type: keyword
Initform: :rect
Readers: shape.
Writers: (setf shape).

Slot: grid ¶

Type: tile-grid:grid
Initform: (tile-grid::%make-grid)
Readers: grid.
Writers: (setf grid).

Slot: x ¶

Type: mfiano-utils:ub32
Initform: 0
Readers: x.
Writers: (setf x).

Slot: y ¶

Type: mfiano-utils:ub32
Initform: 0
Readers: y.
Writers: (setf y).

Slot: min-x ¶

Type: mfiano-utils:ub32
Initform: 0
Readers: min-x.
Writers: (setf min-x).

Slot: max-x ¶

Type: mfiano-utils:ub32
Initform: 1
Readers: max-x.
Writers: (setf max-x).

Slot: min-y ¶

Type: mfiano-utils:ub32
Initform: 0
Readers: min-y.
Writers: (setf min-y).

Slot: max-y ¶

Type: mfiano-utils:ub32
Initform: 1
Readers: max-y.
Writers: (setf max-y).

Slot: mapper ¶

Type: function
Initform: (constantly nil)
Readers: mapper.
Writers: (setf mapper).

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	% ( A C D F G K M O P R S X Y

	Index Entry	Section

%
	`%make-kernel`:	Private ordinary functions
	`%resolve`:	Private macros

(
	`(setf grid)`:	Private ordinary functions
	`(setf mapper)`:	Private ordinary functions
	`(setf max-x)`:	Private ordinary functions
	`(setf max-y)`:	Private ordinary functions
	`(setf min-x)`:	Private ordinary functions
	`(setf min-y)`:	Private ordinary functions
	`(setf shape)`:	Private ordinary functions
	`(setf x)`:	Private ordinary functions
	`(setf y)`:	Private ordinary functions

A
	`add-properties`:	Public standalone methods
	`align`:	Public ordinary functions

C
	`cell-contains-p`:	Public standalone methods
	`collect`:	Public ordinary functions
	`convolve`:	Public ordinary functions
	`count`:	Public ordinary functions

D
	`default-mapper`:	Private macros
	`define-shape`:	Private macros
	`detect`:	Public ordinary functions
	`do-kernel`:	Public macros
	`do/+`:	Private macros
	`do/ellipse`:	Private macros
	`do/rect`:	Private macros
	`do/x`:	Private macros

F
	`find`:	Public ordinary functions
	`flood-fill`:	Public ordinary functions
	`Function, %make-kernel`:	Private ordinary functions
	`Function, (setf grid)`:	Private ordinary functions
	`Function, (setf mapper)`:	Private ordinary functions
	`Function, (setf max-x)`:	Private ordinary functions
	`Function, (setf max-y)`:	Private ordinary functions
	`Function, (setf min-x)`:	Private ordinary functions
	`Function, (setf min-y)`:	Private ordinary functions
	`Function, (setf shape)`:	Private ordinary functions
	`Function, (setf x)`:	Private ordinary functions
	`Function, (setf y)`:	Private ordinary functions
	`Function, align`:	Public ordinary functions
	`Function, collect`:	Public ordinary functions
	`Function, convolve`:	Public ordinary functions
	`Function, count`:	Public ordinary functions
	`Function, detect`:	Public ordinary functions
	`Function, find`:	Public ordinary functions
	`Function, flood-fill`:	Public ordinary functions
	`Function, grid`:	Private ordinary functions
	`Function, kernel-p`:	Private ordinary functions
	`Function, make-kernel`:	Public ordinary functions
	`Function, map`:	Public ordinary functions
	`Function, map/+`:	Private ordinary functions
	`Function, map/ellipse`:	Private ordinary functions
	`Function, map/rect`:	Private ordinary functions
	`Function, map/x`:	Private ordinary functions
	`Function, mapper`:	Private ordinary functions
	`Function, max-x`:	Private ordinary functions
	`Function, max-y`:	Private ordinary functions
	`Function, min-x`:	Private ordinary functions
	`Function, min-y`:	Private ordinary functions
	`Function, origin`:	Public ordinary functions
	`Function, process`:	Public ordinary functions
	`Function, register-shape`:	Private ordinary functions
	`Function, reshape`:	Public ordinary functions
	`Function, resolve`:	Public ordinary functions
	`Function, shape`:	Private ordinary functions
	`Function, x`:	Private ordinary functions
	`Function, y`:	Private ordinary functions

G
	`grid`:	Private ordinary functions

K
	`kernel-p`:	Private ordinary functions

M
	`Macro, %resolve`:	Private macros
	`Macro, default-mapper`:	Private macros
	`Macro, define-shape`:	Private macros
	`Macro, do-kernel`:	Public macros
	`Macro, do/+`:	Private macros
	`Macro, do/ellipse`:	Private macros
	`Macro, do/rect`:	Private macros
	`Macro, do/x`:	Private macros
	`make-kernel`:	Public ordinary functions
	`map`:	Public ordinary functions
	`map/+`:	Private ordinary functions
	`map/ellipse`:	Private ordinary functions
	`map/rect`:	Private ordinary functions
	`map/x`:	Private ordinary functions
	`mapper`:	Private ordinary functions
	`max-x`:	Private ordinary functions
	`max-y`:	Private ordinary functions
	`Method, add-properties`:	Public standalone methods
	`Method, cell-contains-p`:	Public standalone methods
	`Method, remove-properties`:	Public standalone methods
	`min-x`:	Private ordinary functions
	`min-y`:	Private ordinary functions

O
	`origin`:	Public ordinary functions

P
	`process`:	Public ordinary functions

R
	`register-shape`:	Private ordinary functions
	`remove-properties`:	Public standalone methods
	`reshape`:	Public ordinary functions
	`resolve`:	Public ordinary functions

S
	`shape`:	Private ordinary functions

X
	`x`:	Private ordinary functions

Y
	`y`:	Private ordinary functions

Jump to:	% ( A C D F G K M O P R S X Y

A.3 Variables

Jump to:	* G M S X Y

	Index Entry	Section

*
	`shapes`:	Private special variables

G
	`grid`:	Private structures

M
	`mapper`:	Private structures
	`max-x`:	Private structures
	`max-y`:	Private structures
	`min-x`:	Private structures
	`min-y`:	Private structures

S
	`shape`:	Private structures
	`Slot, grid`:	Private structures
	`Slot, mapper`:	Private structures
	`Slot, max-x`:	Private structures
	`Slot, max-y`:	Private structures
	`Slot, min-x`:	Private structures
	`Slot, min-y`:	Private structures
	`Slot, shape`:	Private structures
	`Slot, x`:	Private structures
	`Slot, y`:	Private structures
	`Special Variable, shapes`:	Private special variables

X
	`x`:	Private structures

Y
	`y`:	Private structures

Jump to:	* G M S X Y

A.4 Data types

Jump to:	C F K P S

	Index Entry	Section

C
	`convolution-kernel`:	The convolution-kernel system
	`convolution-kernel`:	The convolution-kernel package
	`convolution-kernel.asd`:	The convolution-kernel/convolution-kernel․asd file
	`convolution-kernel.lisp`:	The convolution-kernel/convolution-kernel․lisp file

F
	`File, convolution-kernel.asd`:	The convolution-kernel/convolution-kernel․asd file
	`File, convolution-kernel.lisp`:	The convolution-kernel/convolution-kernel․lisp file
	`File, package.lisp`:	The convolution-kernel/package․lisp file

K
	`kernel`:	Private structures

P
	`Package, convolution-kernel`:	The convolution-kernel package
	`package.lisp`:	The convolution-kernel/package․lisp file

S
	`Structure, kernel`:	Private structures
	`System, convolution-kernel`:	The convolution-kernel system

Jump to:	C F K P S

The convolution-kernel Reference Manual

The convolution-kernel Reference Manual

Table of Contents

1 Introduction

convolution-kernel

Overview

Install

License

2 Systems

2.1 convolution-kernel

3 Files

3.1 Lisp

3.1.1 convolution-kernel/convolution-kernel.asd

3.1.2 convolution-kernel/package.lisp

3.1.3 convolution-kernel/convolution-kernel.lisp

4 Packages

4.1 convolution-kernel

5 Definitions

5.1 Public Interface

5.1.1 Macros

5.1.2 Ordinary functions

5.1.3 Standalone methods

5.2 Internals

5.2.1 Special variables

5.2.2 Macros

5.2.3 Ordinary functions

5.2.4 Structures

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `convolution-kernel`

3.1.1 `convolution-kernel/convolution-kernel.asd`

3.1.2 `convolution-kernel/package.lisp`

3.1.3 `convolution-kernel/convolution-kernel.lisp`

4.1 `convolution-kernel`