The cl-ca Reference Manual

Table of Contents

The cl-ca Reference Manual

This is the cl-ca Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Mar 25 17:08:07 2020 GMT+0.

1 Introduction

cl-ca: common lisp cellular automata

cl-ca is a common lisp library for implementing programs using cellular automata (e. g. Conway's game of life).

usage

There some example programs to introduce you.

Most functions also include a docstring.

architecture

cl-ca is build around three functions which access the hash table all automata are stored in. This hash-table is located in a closure, therefore only these functions can access it.

The functions are:

• set-automaton used to modify/add automata
• get-automaton used to get informations about an automaton (The Hacker's note: It is just a call to gethash)
• run-step walks over a specified part of the hash-table and calculates the new states of the automatons.

The data about the automata is stored this way in the hash-table:

(x . y) . (state function)

(the cons pair (x . y) is the key and the list ist the value)

The function gets called each step with the list representing the automaton itself and a list of lists representing its neighbors (more on that later). It must return a list representing itself (this one then gets put in the hash-table). This allows an automaton not only change its state but also to modify its behavior.

The functions moore-neighbors and von-neumann-neighbors implement neighborhood (See the corresponding Wikipedia articles: Moore Neighborhood and Von Neumann Neighborhood). One of these functions (or another one doing something reasonable in this context) should be passed to run-step and is used to calculate neighborhood then.

can I ql:quickload it?

Yes

2 Systems

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

2.1 cl-ca

Author

Lukas Epple <post@lukasepple.de>

License

Public Domain

Description

cellular automaton library

Version

0.0.1

Source

cl-ca.asd (file)

Components

• packages.lisp (file)
• cl-ca.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 cl-ca.asd

Location

cl-ca.asd

Systems

cl-ca (system)

3.1.2 cl-ca/packages.lisp

Parent

cl-ca (system)

Location

packages.lisp

Packages

cl-ca

3.1.3 cl-ca/cl-ca.lisp

Dependency

packages.lisp (file)

Parent

cl-ca (system)

Location

cl-ca.lisp

Exported Definitions

• create-automata (function)
• get-automaton (function)
• get-dimensions (function)
• moore-neighbors (function)
• print-automata (function)
• run-step (function)
• set-automaton (function)
• set-dimensions (function)
• von-neumann-neighbors (function)

Internal Definitions

• wrap-if-necessary (function)
• wrap-one-dim (function)

4 Packages

Packages are listed by definition order.

4.1 cl-ca

cellular automaton library

Source

packages.lisp (file)

Use List

common-lisp

Exported Definitions

• create-automata (function)
• get-automaton (function)
• get-dimensions (function)
• moore-neighbors (function)
• print-automata (function)
• run-step (function)
• set-automaton (function)
• set-dimensions (function)
• von-neumann-neighbors (function)

Internal Definitions

• wrap-if-necessary (function)
• wrap-one-dim (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: create-automata GEN-STATE FUN

adds the automata between from-pos to to-pos in a
2d grid. For the initial state it calls gen-state each time with the position as argument

Package

cl-ca

Source

cl-ca.lisp (file)

Function: get-automaton POS

gets an automaton from the hash table (in the closure)

Package

cl-ca

Source

cl-ca.lisp (file)

Function: get-dimensions ()

Package

cl-ca

Source

cl-ca.lisp (file)

Function: moore-neighbors POS DIM

calculates the moore neighbors of an automaton

Package

cl-ca

Source

cl-ca.lisp (file)

Function: print-automata CONVERSION-FUN

prints the automata between two positions. It uses a conversion function to determine which char to use

Package

cl-ca

Source

cl-ca.lisp (file)

Function: run-step NEIGHBORHOOD

runs the the simulation for one step. it invokes the automata in the 2d grid defined by set-dimensions

Package

cl-ca

Source

cl-ca.lisp (file)

Function: set-automaton POS STATE FUN

sets an automaton in the hash table (in the closure)

Package

cl-ca

Source

cl-ca.lisp (file)

Function: set-dimensions DIM

Sets the dimensions (bondaries) of the simulation (cons upperleft lowerright)

Package

cl-ca

Source

cl-ca.lisp (file)

Function: von-neumann-neighbors POS DIM

calculates the von Neumann neighbors of an automaton

Package

cl-ca

Source

cl-ca.lisp (file)

5.2 Internal definitions

5.2.1 Functions

Function: wrap-if-necessary POS DIM

Makes sure that pos is always between the boundaries of (car dim) and (cdr dim). Wraps pos if necessary

Package

cl-ca

Source

cl-ca.lisp (file)

Function: wrap-one-dim N MIN MAX

makes sure that a position is always in the boundary min - max and wraps it around if necessary

Package

cl-ca

Source

cl-ca.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types