The cl-ca Reference Manual

This is the cl-ca Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 03:46:10 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-ca

cellular automaton library

Author

Lukas Epple <>

License

Public Domain

Version

0.0.1

Source

cl-ca.asd.

Child Components

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/cl-ca.asd

Source

cl-ca.asd.

Parent Component

cl-ca (system).

ASDF Systems

cl-ca.


3.1.2 cl-ca/packages.lisp

Source

cl-ca.asd.

Parent Component

cl-ca (system).

Packages

cl-ca.


3.1.3 cl-ca/cl-ca.lisp

Dependency

packages.lisp (file).

Source

cl-ca.asd.

Parent Component

cl-ca (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-ca

cellular automaton library

Source

packages.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary 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.

Function: get-automaton (pos)

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

Package

cl-ca.

Source

cl-ca.lisp.

Function: get-dimensions ()
Package

cl-ca.

Source

cl-ca.lisp.

Function: moore-neighbors (pos dim)

calculates the moore neighbors of an automaton

Package

cl-ca.

Source

cl-ca.lisp.

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.

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.

Function: set-automaton (pos state fun)

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

Package

cl-ca.

Source

cl-ca.lisp.

Function: set-dimensions (dim)

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

Package

cl-ca.

Source

cl-ca.lisp.

Function: von-neumann-neighbors (pos dim)

calculates the von Neumann neighbors of an automaton

Package

cl-ca.

Source

cl-ca.lisp.


5.2 Internals


5.2.1 Ordinary 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.

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.


Appendix A Indexes


A.1 Concepts


A.3 Variables