Interface ComonadStore<S, W>

A dual of Monad, the framework of computing neighbor states in parallel.

All instances of the comonad c must satisfy the following laws:

Duplicate then extract: For all x; c.extract(c.duplicate(x)) equals to x,
Extract as identity of map: For all x; c.map(c.extract)(c.duplicate(x)) equals to x,
Duplicate as identity of map: For all x; c.duplicate(c.duplicate(x)) equals to c.map(c.duplicate)(c.duplicate(x)).

Type Parameters

S
W

Hierarchy

Comonad<W>
- ComonadStore

Index

Properties

duplicate extract map peek pos

Properties

`Readonly` duplicate

duplicate: (<A>(wa) => Instance<Apply1<W, Instance<Apply1<W, A>>>>)

Type declaration

- <A>(wa): Instance<Apply1<W, Instance<Apply1<W, A>>>>
- Computes the surrounding states from a source object wa.
  Type Parameters
  - A
  Parameters
  - wa: Instance<Apply1<W, A>>
    The wrapped object about type A.
  Returns Instance<Apply1<W, Instance<Apply1<W, A>>>>
  The surrounding states of wa.

`Readonly` extract

extract: (<A>(wa) => A)

Type declaration

- <A>(wa): A
- Extracts the internal state of type A.
  Type Parameters
  - A
  Parameters
  - wa: Instance<Apply1<W, A>>
    The wrapped object about type A.
  Returns A
  The value of type A.

`Readonly` map

map: (<T, U>(fn) => ((t) => Instance<Apply1<W, U>>))

Type declaration

- <T, U>(fn): ((t) => Instance<Apply1<W, U>>)
- Maps the function fn onto F structure.
  Type Parameters
  - T
  - U
  Parameters
  - fn: ((t) => U)
    The function to be mapped.
    - (t): U
      Parameters
      t: T
      Returns U
  Returns ((t) => Instance<Apply1<W, U>>)
  The mapped function.
  - - (t): Instance<Apply1<W, U>>
    - Parameters
      t: Instance<Apply1<W, T>>
      Returns Instance<Apply1<W, U>>

`Readonly` peek

peek: ((position) => (<A>(store) => A))

Type declaration

- (position): (<A>(store) => A)
- Parameters
  - position: S
  Returns (<A>(store) => A)
  - - <A>(store): A
    - Type Parameters
      A
      Parameters
      store: Get1<W, A>
      Returns A

`Readonly` pos

pos: (<A>(store) => S)

Type declaration

- <A>(store): S
- Type Parameters
  - A
  Parameters
  - store: Get1<W, A>
  Returns S

Generated using TypeDoc