Copyright  (c) Michael Szvetits 2024 

License  BSD3 (see the file LICENSE) 
Maintainer  typedbyte@qualified.name 
Stability  stable 
Portability  portable 
Safe Haskell  SafeInferred 
Language  GHC2021 
This module exports STbased types and functions needed to create cells, manipulate their data and wire them up for data propagation.
Synopsis
 data Propagation s
 undo :: Propagation s > ST s ()
 succeeded :: Propagation s > Bool
 data Cell s a
 data Change a
 = Changed a
  Unchanged a
  Incompatible
 cell :: a > (a > a > Change a) > ST s (Cell s a)
 readCell :: Cell s a > ST s a
 writeCell :: a > Cell s a > ST s (Propagation s)
 label :: (a > [b]) > (b > a) > [Cell s a] > ST s [[b]]
 connect :: Cell s a > Cell s b > (a > ST s b) > ST s ()
 sync :: Cell s a > Cell s a > ST s ()
 syncWith :: (a > b) > (b > a) > Cell s a > Cell s b > ST s ()
 propagate :: Cell s a > ST s (Propagation s)
 propagateMany :: [Cell s a] > ST s (Propagation s)
 plus :: Num a => Cell s a > Cell s a > Cell s a > ST s ()
 minus :: Num a => Cell s a > Cell s a > Cell s a > ST s ()
 times :: Num a => Cell s a > Cell s a > Cell s a > ST s ()
 timesWith :: Num a => (a > a > a) > Cell s a > Cell s a > Cell s a > ST s ()
 abs :: Num a => Cell s a > Cell s a > ST s ()
 absWith :: Num a => (a > a) > Cell s a > Cell s a > ST s ()
 negate :: Num a => Cell s a > Cell s a > ST s ()
 signum :: Num a => Cell s a > Cell s a > ST s ()
 signumWith :: Num a => (a > a) > Cell s a > Cell s a > ST s ()
Networks
data Propagation s Source #
The result of a propagation which allows to rollback changes and inspect its success.
undo :: Propagation s > ST s () Source #
An action that reverts all cell changes of a propagation (both direct and transitive ones).
succeeded :: Propagation s > Bool Source #
True
if the propagation was successful (i.e., it did not lead to a
cell change that is Incompatible
), otherwise False
.
Note that unsuccessful propagations are not automatically reverted. Use
undo
to do this.
Cells
The type of a cell holding a value of type a
. The type parameter s
serves to keep the internal states of different cell networks separate from
each other (see ST
for details).
Represents a potential change of a cell value.
Changed a  Indicates that a cell value has been changed to the new value 
Unchanged a  Indicates that a cell value did not change, i.e. needs no propagation. 
Incompatible  Indicates that a new cell value contradicts the one that is already stored in the cell. 
:: a  The initial value of the cell. 
> (a > a > Change a)  A function that describes how to join an existing cell value with a new one that the cell has received via propagation. 
> ST s (Cell s a)  The newly constructed cell. 
Constructs a new cell with a given initial value and a function which defines how to react if a new value is about to be written to the cell.
writeCell :: a > Cell s a > ST s (Propagation s) Source #
Writes a new value to a specific cell and starts to propagate potential changes through the network of connected cells.
:: (a > [b])  A function which extracts testable values from a cell content. 
> (b > a)  A function which translates a testable value into a value which can be written back to the cell. 
> [Cell s a]  The set of cells for which the values are enumerated. 
> ST s [[b]]  Returns all valid assignments for the given cells. 
If the content of a Cell s a
is an accumulation of multiple values [b]
,
and every value b
itself can be used as content a
for the cell, then we
can write every value b
one after another to the cell and check if the
network converges to a successful state.
As a result, we can enumerate all possible combinations of valid values for a given set of cells. This is often used in constraint solving algorithms.
Connections
:: Cell s a  The source cell. 
> Cell s b  The target cell. 
> (a > ST s b)  A function that describes how the value for the target cell is constructed, based on the value of the source cell. 
> ST s ()  Note that no propagation takes place (i.e., no

Connects a source cell to a target cell in order to propagate changes from the source to the target.
Note that newly connected cells do not start to propagate changes
immediately after wiring up. Use propagate
or propagateMany
to do this.
sync :: Cell s a > Cell s a > ST s () Source #
Connects and synchronizes two cells, i.e. new values are propagated from
the source to the target cell, and vice versa. Short form of syncWith
id
id
.
Note that newly connected cells do not start to propagate changes
immediately after wiring up. Use propagate
or propagateMany
to do this.
syncWith :: (a > b) > (b > a) > Cell s a > Cell s b > ST s () Source #
Connects and synchronizes two cells using two translation functions f
and g
, i.e. new values are propagated from the source to the target cell
using f
, and vice versa using g
.
Note that newly connected cells do not start to propagate changes
immediately after wiring up. Use propagate
or propagateMany
to do this.
propagate :: Cell s a > ST s (Propagation s) Source #
Propagates the value of a specific cell to its connected cells in a
transitive manner. The propagation ends if no more cell changes occur or if
an Incompatible
cell value change is encountered.
propagateMany :: [Cell s a] > ST s (Propagation s) Source #
Propagates the values of specific cells to their connected cells in a
transitive manner. The propagation ends if no more cell changes occur or if
an Incompatible
cell value change is encountered.
Numeric
plus :: Num a => Cell s a > Cell s a > Cell s a > ST s () Source #
plus a b c
connects three cells using the following propagation schema:
a + b
is propagated toc
ifa
orb
changes.c  b
is propagated toa
ifb
orc
changes.c  a
is propagated tob
ifa
orc
changes.
minus :: Num a => Cell s a > Cell s a > Cell s a > ST s () Source #
minus a b c
connects three cells using the following propagation schema:
a  b
is propagated toc
ifa
orb
changes.b + c
is propagated toa
ifb
orc
changes.a  c
is propagated tob
ifa
orc
changes.
times :: Num a => Cell s a > Cell s a > Cell s a > ST s () Source #
times a b c
connects three cells using the following propagation schema:
a * b
is propagated toc
ifa
orb
changes.
timesWith :: Num a => (a > a > a) > Cell s a > Cell s a > Cell s a > ST s () Source #
timesWith divOp a b c
connects three cells using the following propagation schema:
a * b
is propagated toc
ifa
orb
changes.divOp c b
is propagated toa
ifb
orc
changes.divOp c a
is propagated tob
ifa
orc
changes.
abs :: Num a => Cell s a > Cell s a > ST s () Source #
abs a b
connects two cells using the following propagation schema:
a
is propagated tob
ifa
changes.
absWith :: Num a => (a > a) > Cell s a > Cell s a > ST s () Source #
absWith inv a b
connects two cells using the following propagation schema:
a
is propagated tob
ifa
changes.inv b
is propagated toa
ifb
changes.
negate :: Num a => Cell s a > Cell s a > ST s () Source #
negate a b
connects two cells using the following propagation schema:
a
is propagated tob
ifa
changes.b
is propagated toa
ifb
changes.