The finite-state-machine Reference Manual

This is the finite-state-machine Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 20:40:20 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 finite-state-machine

An intuitive implementation of a finite state machine.

Author

Isoraķatheð Zorethan <>

License

MIT

Version

1.0.0

Source

finite-state-machine.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 finite-state-machine/finite-state-machine.asd

Source

finite-state-machine.asd.

Parent Component

finite-state-machine (system).

ASDF Systems

finite-state-machine.


3.1.3 finite-state-machine/finite-state-machine.lisp

Dependency

package.lisp (file).

Source

finite-state-machine.asd.

Parent Component

finite-state-machine (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 info.isoraqathedh.finite-state-machine

Source

package.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 Generic functions

Generic Function: acceptingp (state-machine)

Check if the STATE-MACHINE is in an accepting state.

Package

info.isoraqathedh.finite-state-machine.

Source

finite-state-machine.lisp.

Methods
Method: acceptingp ((fsm finite-state-machine))
Generic Function: next-state (state-machine event)

Name the correct next state of STATE-MACHINE given event EVENT.

Package

info.isoraqathedh.finite-state-machine.

Source

finite-state-machine.lisp.

Generic Function: next-state! (state-machine event)

Move to the correct next state of STATE-MACHINE given event EVENT.

Package

info.isoraqathedh.finite-state-machine.

Source

finite-state-machine.lisp.

Methods
Method: next-state! ((state-machine finite-state-machine) event)
Generic Function: previous-state (state-machine)

Peek at the previous state.

Package

info.isoraqathedh.finite-state-machine.

Source

finite-state-machine.lisp.

Methods
Method: previous-state ((fsm finite-state-machine))
Generic Function: previous-state! (state-machine)

Return the machine to a previous state.

Package

info.isoraqathedh.finite-state-machine.

Source

finite-state-machine.lisp.

Methods
Method: previous-state! ((fsm finite-state-machine))
Generic Function: state (state-machine)

Return the current state of the machine.

Package

info.isoraqathedh.finite-state-machine.

Source

finite-state-machine.lisp.

Methods
Method: state ((fsm finite-state-machine))
Generic Function: (setf state) (state-machine)

Set the new state of the state-machine.

Package

info.isoraqathedh.finite-state-machine.

Source

finite-state-machine.lisp.

Methods
Method: (setf state) ((state-machine finite-state-machine))
Generic Function: statep (state-machine possible-state)

Check if a POSSIBLE-STATE is a state in STATE-MACHINE.

Package

info.isoraqathedh.finite-state-machine.

Source

finite-state-machine.lisp.

Methods
Method: statep ((fsm finite-state-machine) possible-state)

5.1.2 Standalone methods

Method: initialize-instance :after ((instance finite-state-machine) &key states start-state)
Source

finite-state-machine.lisp.

Method: print-object ((object finite-state-machine) stream)
Source

finite-state-machine.lisp.


5.1.3 Classes

Class: finite-state-machine
Package

info.isoraqathedh.finite-state-machine.

Source

finite-state-machine.lisp.

Direct methods
Direct slots
Slot: all-states
Initargs

:states

Readers

states-of.

Writers

(setf states-of).

Slot: accepting-states
Initargs

:accepting-states

Readers

accepting-states.

Writers

(setf accepting-states).

Slot: state-history
Readers

state-history.

Writers

(setf state-history).

Slot: state=-test
Initform

(function eql)

Initargs

:test

Readers

state=-test.

Writers

(setf state=-test).


5.2 Internals


5.2.1 Generic functions

Generic Reader: accepting-states (object)
Package

info.isoraqathedh.finite-state-machine.

Methods
Reader Method: accepting-states ((finite-state-machine finite-state-machine))

automatically generated reader method

Source

finite-state-machine.lisp.

Target Slot

accepting-states.

Generic Writer: (setf accepting-states) (object)
Package

info.isoraqathedh.finite-state-machine.

Methods
Writer Method: (setf accepting-states) ((finite-state-machine finite-state-machine))

automatically generated writer method

Source

finite-state-machine.lisp.

Target Slot

accepting-states.

Generic Reader: state-history (object)
Package

info.isoraqathedh.finite-state-machine.

Methods
Reader Method: state-history ((finite-state-machine finite-state-machine))

automatically generated reader method

Source

finite-state-machine.lisp.

Target Slot

state-history.

Generic Writer: (setf state-history) (object)
Package

info.isoraqathedh.finite-state-machine.

Methods
Writer Method: (setf state-history) ((finite-state-machine finite-state-machine))

automatically generated writer method

Source

finite-state-machine.lisp.

Target Slot

state-history.

Generic Reader: state=-test (object)
Package

info.isoraqathedh.finite-state-machine.

Methods
Reader Method: state=-test ((finite-state-machine finite-state-machine))

automatically generated reader method

Source

finite-state-machine.lisp.

Target Slot

state=-test.

Generic Writer: (setf state=-test) (object)
Package

info.isoraqathedh.finite-state-machine.

Methods
Writer Method: (setf state=-test) ((finite-state-machine finite-state-machine))

automatically generated writer method

Source

finite-state-machine.lisp.

Target Slot

state=-test.

Generic Reader: states-of (object)
Package

info.isoraqathedh.finite-state-machine.

Methods
Reader Method: states-of ((finite-state-machine finite-state-machine))

automatically generated reader method

Source

finite-state-machine.lisp.

Target Slot

all-states.

Generic Writer: (setf states-of) (object)
Package

info.isoraqathedh.finite-state-machine.

Methods
Writer Method: (setf states-of) ((finite-state-machine finite-state-machine))

automatically generated writer method

Source

finite-state-machine.lisp.

Target Slot

all-states.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   G   I   M   N   P   S  
Index Entry  Section

(
(setf accepting-states): Private generic functions
(setf accepting-states): Private generic functions
(setf state): Public generic functions
(setf state): Public generic functions
(setf state-history): Private generic functions
(setf state-history): Private generic functions
(setf state=-test): Private generic functions
(setf state=-test): Private generic functions
(setf states-of): Private generic functions
(setf states-of): Private generic functions

A
accepting-states: Private generic functions
accepting-states: Private generic functions
acceptingp: Public generic functions
acceptingp: Public generic functions

G
Generic Function, (setf accepting-states): Private generic functions
Generic Function, (setf state): Public generic functions
Generic Function, (setf state-history): Private generic functions
Generic Function, (setf state=-test): Private generic functions
Generic Function, (setf states-of): Private generic functions
Generic Function, accepting-states: Private generic functions
Generic Function, acceptingp: Public generic functions
Generic Function, next-state: Public generic functions
Generic Function, next-state!: Public generic functions
Generic Function, previous-state: Public generic functions
Generic Function, previous-state!: Public generic functions
Generic Function, state: Public generic functions
Generic Function, state-history: Private generic functions
Generic Function, state=-test: Private generic functions
Generic Function, statep: Public generic functions
Generic Function, states-of: Private generic functions

I
initialize-instance: Public standalone methods

M
Method, (setf accepting-states): Private generic functions
Method, (setf state): Public generic functions
Method, (setf state-history): Private generic functions
Method, (setf state=-test): Private generic functions
Method, (setf states-of): Private generic functions
Method, accepting-states: Private generic functions
Method, acceptingp: Public generic functions
Method, initialize-instance: Public standalone methods
Method, next-state!: Public generic functions
Method, previous-state: Public generic functions
Method, previous-state!: Public generic functions
Method, print-object: Public standalone methods
Method, state: Public generic functions
Method, state-history: Private generic functions
Method, state=-test: Private generic functions
Method, statep: Public generic functions
Method, states-of: Private generic functions

N
next-state: Public generic functions
next-state!: Public generic functions
next-state!: Public generic functions

P
previous-state: Public generic functions
previous-state: Public generic functions
previous-state!: Public generic functions
previous-state!: Public generic functions
print-object: Public standalone methods

S
state: Public generic functions
state: Public generic functions
state-history: Private generic functions
state-history: Private generic functions
state=-test: Private generic functions
state=-test: Private generic functions
statep: Public generic functions
statep: Public generic functions
states-of: Private generic functions
states-of: Private generic functions