The petri Reference Manual

This is the petri Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:32:59 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 petri

An implementation of Petri nets

Author

Michał "phoe" Herda <>

License

MIT

Version

0.0.1

Dependencies
  • alexandria (system).
  • closer-mop (system).
  • 1am (system).
  • split-sequence (system).
  • phoe-toolbox/bag (system).
Source

petri.asd.

Child Component

petri.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 petri/petri.asd

Source

petri.asd.

Parent Component

petri (system).

ASDF Systems

petri.


3.1.2 petri/petri.lisp

Source

petri.asd.

Parent Component

petri (system).

Packages

petri.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 petri

Source

petri.lisp.

Use List
  • alexandria.
  • closer-mop.
  • common-lisp.
  • phoe-toolbox/bag.
  • split-sequence.
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 Macros

Macro: petri-net (() &body forms)
Package

petri.

Source

petri.lisp.


5.1.2 Ordinary functions

Function: bag-names (petri-net)
Package

petri.

Source

petri.lisp.

Function: bag-of (petri-net name)
Package

petri.

Source

petri.lisp.

Function: (setf bag-of) (petri-net name)
Package

petri.

Source

petri.lisp.

Function: make-petri-net (bags transitions)
Package

petri.

Source

petri.lisp.

Function: petri-net-error (control &rest args)
Package

petri.

Source

petri.lisp.


5.1.3 Standalone methods

Method: initialize-instance :after ((petri-net petri-net) &key bags transitions)
Source

petri.lisp.

Method: initialize-instance :after ((transition transition) &key)
Source

petri.lisp.

Method: print-object ((petri-net petri-net) stream)
Source

petri.lisp.

Method: print-object ((transition transition) stream)
Source

petri.lisp.


5.1.4 Conditions

Condition: petri-net-error
Package

petri.

Source

petri.lisp.

Direct superclasses

error.

Direct subclasses
Condition: simple-petri-net-error
Package

petri.

Source

petri.lisp.

Direct superclasses

5.1.5 Classes

Class: petri-net
Package

petri.

Source

petri.lisp.

Direct superclasses

funcallable-standard-object.

Direct methods
Direct Default Initargs
InitargValue
:bags(make-hash-table)
:transitions(quote nil)
Direct slots
Slot: %bags
Readers

bags.

Writers

(setf bags).

Slot: %transitions
Readers

transitions.

Writers

(setf transitions).


5.2 Internals


5.2.1 Macros

Macro: %petri-net (constructor &body forms)
Package

petri.

Source

petri.lisp.


5.2.2 Ordinary functions

Function: bag-form-p (thing)
Package

petri.

Source

petri.lisp.

Function: edges-bags-from (edges function-form)
Package

petri.

Source

petri.lisp.

Function: edges-bags-to (edges function-form)
Package

petri.

Source

petri.lisp.

Function: edges-objects (edges)
Package

petri.

Source

petri.lisp.

Function: find-ready-transition (petri-net)
Package

petri.

Source

petri.lisp.

Function: form-edges (form)
Package

petri.

Source

petri.lisp.

Function: function-form-p (thing)
Package

petri.

Source

petri.lisp.

Function: inhibitor-bag-form-p (thing)
Package

petri.

Source

petri.lisp.

Function: make-bags (&rest symbols)
Package

petri.

Source

petri.lisp.

Function: make-output-hash-table (transition)
Package

petri.

Source

petri.lisp.

Function: make-transition (from to callback &optional class)
Package

petri.

Source

petri.lisp.

Function: no-one-element-lists (x)
Package

petri.

Source

petri.lisp.

Function: transition-not-ready (bag requested-count actual-count)
Package

petri.

Source

petri.lisp.

Function: transition-not-ready-report (condition stream)
Package

petri.

Source

petri.lisp.

Function: transition-ready-p (transition petri-net &optional errorp)
Package

petri.

Source

petri.lisp.

Function: validate-output-hash-table (output transition)
Package

petri.

Source

petri.lisp.

Function: wildcard-bag-form-p (thing)
Package

petri.

Source

petri.lisp.


5.2.3 Generic functions

Generic Reader: actual-count (condition)
Package

petri.

Methods
Reader Method: actual-count ((condition transition-not-ready))
Source

petri.lisp.

Target Slot

%actual-count.

Generic Reader: bags (object)
Package

petri.

Methods
Reader Method: bags ((petri-net petri-net))

automatically generated reader method

Source

petri.lisp.

Target Slot

%bags.

Generic Writer: (setf bags) (object)
Package

petri.

Methods
Writer Method: (setf bags) ((petri-net petri-net))

automatically generated writer method

Source

petri.lisp.

Target Slot

%bags.

Generic Reader: bags-from (object)
Package

petri.

Methods
Reader Method: bags-from ((transition transition))

automatically generated reader method

Source

petri.lisp.

Target Slot

%bags-from.

Generic Writer: (setf bags-from) (object)
Package

petri.

Methods
Writer Method: (setf bags-from) ((transition transition))

automatically generated writer method

Source

petri.lisp.

Target Slot

%bags-from.

Generic Reader: bags-to (object)
Package

petri.

Methods
Reader Method: bags-to ((transition transition))

automatically generated reader method

Source

petri.lisp.

Target Slot

%bags-to.

Generic Writer: (setf bags-to) (object)
Package

petri.

Methods
Writer Method: (setf bags-to) ((transition transition))

automatically generated writer method

Source

petri.lisp.

Target Slot

%bags-to.

Generic Function: call-callback (transition input output)
Package

petri.

Source

petri.lisp.

Methods
Method: call-callback ((transition transition) (input hash-table) (output hash-table))
Generic Reader: callback (object)
Package

petri.

Methods
Reader Method: callback ((transition transition))

automatically generated reader method

Source

petri.lisp.

Target Slot

%callback.

Generic Writer: (setf callback) (object)
Package

petri.

Methods
Writer Method: (setf callback) ((transition transition))

automatically generated writer method

Source

petri.lisp.

Target Slot

%callback.

Generic Reader: condition-bag (condition)
Package

petri.

Methods
Reader Method: condition-bag ((condition transition-not-ready))
Source

petri.lisp.

Target Slot

%bag.

Generic Function: make-petri-net-funcallable-function (petri-net)
Package

petri.

Source

petri.lisp.

Methods
Method: make-petri-net-funcallable-function ((petri-net petri-net))
Generic Function: make-transition-funcallable-function (transition)
Package

petri.

Source

petri.lisp.

Methods
Method: make-transition-funcallable-function ((transition transition))
Generic Function: petri-net-transition-constructor (petri-net)
Package

petri.

Source

petri.lisp.

Methods
Method: petri-net-transition-constructor ((petri-net petri-net))
Generic Function: populate-input (transition petri-net &optional skip-validation-p)
Package

petri.

Source

petri.lisp.

Methods
Method: populate-input ((transition transition) (petri-net petri-net) &optional skip-validation-p)
Generic Function: populate-output (transition petri-net output)
Package

petri.

Source

petri.lisp.

Methods
Method: populate-output ((transition transition) (petri-net petri-net) (output hash-table))
Generic Reader: requested-count (condition)
Package

petri.

Methods
Reader Method: requested-count ((condition transition-not-ready))
Source

petri.lisp.

Target Slot

%requested-count.

Generic Reader: transitions (object)
Package

petri.

Methods
Reader Method: transitions ((petri-net petri-net))

automatically generated reader method

Source

petri.lisp.

Target Slot

%transitions.

Generic Writer: (setf transitions) (object)
Package

petri.

Methods
Writer Method: (setf transitions) ((petri-net petri-net))

automatically generated writer method

Source

petri.lisp.

Target Slot

%transitions.


5.2.4 Conditions

Condition: transition-not-ready
Package

petri.

Source

petri.lisp.

Direct superclasses

petri-net-error.

Direct methods
Direct Default Initargs
InitargValue
:bag(required-argument bag)
:actual-count(required-argument actual-count)
:requested-count(required-argument requested-count)
Direct slots
Slot: %requested-count
Initargs

:requested-count

Readers

requested-count.

Writers

This slot is read-only.

Slot: %actual-count
Initargs

:actual-count

Readers

actual-count.

Writers

This slot is read-only.

Slot: %bag
Initargs

:bag

Readers

condition-bag.

Writers

This slot is read-only.


5.2.5 Classes

Class: transition
Package

petri.

Source

petri.lisp.

Direct superclasses

funcallable-standard-object.

Direct methods
Direct Default Initargs
InitargValue
:bags-from(make-hash-table)
:bags-to(make-hash-table)
:callback(required-argument callback)
Direct slots
Slot: %bags-from
Initargs

:bags-from

Readers

bags-from.

Writers

(setf bags-from).

Slot: %bags-to
Initargs

:bags-to

Readers

bags-to.

Writers

(setf bags-to).

Slot: %callback
Initargs

:callback

Readers

callback.

Writers

(setf callback).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   B   C   E   F   G   I   M   N   P   R   T   V   W  
Index Entry  Section

%
%petri-net: Private macros

(
(setf bag-of): Public ordinary functions
(setf bags): Private generic functions
(setf bags): Private generic functions
(setf bags-from): Private generic functions
(setf bags-from): Private generic functions
(setf bags-to): Private generic functions
(setf bags-to): Private generic functions
(setf callback): Private generic functions
(setf callback): Private generic functions
(setf transitions): Private generic functions
(setf transitions): Private generic functions

A
actual-count: Private generic functions
actual-count: Private generic functions

B
bag-form-p: Private ordinary functions
bag-names: Public ordinary functions
bag-of: Public ordinary functions
bags: Private generic functions
bags: Private generic functions
bags-from: Private generic functions
bags-from: Private generic functions
bags-to: Private generic functions
bags-to: Private generic functions

C
call-callback: Private generic functions
call-callback: Private generic functions
callback: Private generic functions
callback: Private generic functions
condition-bag: Private generic functions
condition-bag: Private generic functions

E
edges-bags-from: Private ordinary functions
edges-bags-to: Private ordinary functions
edges-objects: Private ordinary functions

F
find-ready-transition: Private ordinary functions
form-edges: Private ordinary functions
Function, (setf bag-of): Public ordinary functions
Function, bag-form-p: Private ordinary functions
Function, bag-names: Public ordinary functions
Function, bag-of: Public ordinary functions
Function, edges-bags-from: Private ordinary functions
Function, edges-bags-to: Private ordinary functions
Function, edges-objects: Private ordinary functions
Function, find-ready-transition: Private ordinary functions
Function, form-edges: Private ordinary functions
Function, function-form-p: Private ordinary functions
Function, inhibitor-bag-form-p: Private ordinary functions
Function, make-bags: Private ordinary functions
Function, make-output-hash-table: Private ordinary functions
Function, make-petri-net: Public ordinary functions
Function, make-transition: Private ordinary functions
Function, no-one-element-lists: Private ordinary functions
Function, petri-net-error: Public ordinary functions
Function, transition-not-ready: Private ordinary functions
Function, transition-not-ready-report: Private ordinary functions
Function, transition-ready-p: Private ordinary functions
Function, validate-output-hash-table: Private ordinary functions
Function, wildcard-bag-form-p: Private ordinary functions
function-form-p: Private ordinary functions

G
Generic Function, (setf bags): Private generic functions
Generic Function, (setf bags-from): Private generic functions
Generic Function, (setf bags-to): Private generic functions
Generic Function, (setf callback): Private generic functions
Generic Function, (setf transitions): Private generic functions
Generic Function, actual-count: Private generic functions
Generic Function, bags: Private generic functions
Generic Function, bags-from: Private generic functions
Generic Function, bags-to: Private generic functions
Generic Function, call-callback: Private generic functions
Generic Function, callback: Private generic functions
Generic Function, condition-bag: Private generic functions
Generic Function, make-petri-net-funcallable-function: Private generic functions
Generic Function, make-transition-funcallable-function: Private generic functions
Generic Function, petri-net-transition-constructor: Private generic functions
Generic Function, populate-input: Private generic functions
Generic Function, populate-output: Private generic functions
Generic Function, requested-count: Private generic functions
Generic Function, transitions: Private generic functions

I
inhibitor-bag-form-p: Private ordinary functions
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods

M
Macro, %petri-net: Private macros
Macro, petri-net: Public macros
make-bags: Private ordinary functions
make-output-hash-table: Private ordinary functions
make-petri-net: Public ordinary functions
make-petri-net-funcallable-function: Private generic functions
make-petri-net-funcallable-function: Private generic functions
make-transition: Private ordinary functions
make-transition-funcallable-function: Private generic functions
make-transition-funcallable-function: Private generic functions
Method, (setf bags): Private generic functions
Method, (setf bags-from): Private generic functions
Method, (setf bags-to): Private generic functions
Method, (setf callback): Private generic functions
Method, (setf transitions): Private generic functions
Method, actual-count: Private generic functions
Method, bags: Private generic functions
Method, bags-from: Private generic functions
Method, bags-to: Private generic functions
Method, call-callback: Private generic functions
Method, callback: Private generic functions
Method, condition-bag: Private generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, make-petri-net-funcallable-function: Private generic functions
Method, make-transition-funcallable-function: Private generic functions
Method, petri-net-transition-constructor: Private generic functions
Method, populate-input: Private generic functions
Method, populate-output: Private generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, requested-count: Private generic functions
Method, transitions: Private generic functions

N
no-one-element-lists: Private ordinary functions

P
petri-net: Public macros
petri-net-error: Public ordinary functions
petri-net-transition-constructor: Private generic functions
petri-net-transition-constructor: Private generic functions
populate-input: Private generic functions
populate-input: Private generic functions
populate-output: Private generic functions
populate-output: Private generic functions
print-object: Public standalone methods
print-object: Public standalone methods

R
requested-count: Private generic functions
requested-count: Private generic functions

T
transition-not-ready: Private ordinary functions
transition-not-ready-report: Private ordinary functions
transition-ready-p: Private ordinary functions
transitions: Private generic functions
transitions: Private generic functions

V
validate-output-hash-table: Private ordinary functions

W
wildcard-bag-form-p: Private ordinary functions