Module

Control.Comonad.Store

This module defines the Store comonad.

type Store s = StoreT s Identity

The Store comonad is a synonym for the StoreT comonad transformer, applied to the Identity monad.

runStore :: forall a s. Store s a -> Tuple (s -> a) s

Unwrap a value in the Store comonad.

store :: forall a s. (s -> a) -> s -> Store s a

Create a value in context in the Store comonad.

Re-exports from Control.Comonad.Store.Class

class (Comonad w) <= ComonadStore s w | w -> s where

The ComonadStore type class represents those monads which support local position information via pos and peek.

An implementation is provided for StoreT.

Laws:

For example:

blur :: forall w. (ComonadStore Number w) -> w Number -> w Number
blur = extend \r -> (peeks (\n -> n - 1) r + peeks (\n -> n + 1) r) / 2)

seeks :: forall w a s. ComonadStore s w => (s -> s) -> w a -> w a

Reposition the focus at the specified position, which depends on the current position.

seek :: forall w a s. ComonadStore s w => s -> w a -> w a

Reposition the focus at the specified position.

peeks :: forall w a s. ComonadStore s w => (s -> s) -> w a -> a

Extract a value from a position which depends on the current position.

experiment :: forall s w a f. ComonadStore s w => Functor f => (s -> f s) -> w a -> f a

Extract a collection of values from positions which depend on the current position.

newtype StoreT s w a

The store comonad transformer.

This comonad transformer extends the context of a value in the base comonad so that the value depends on a position of type s.

The ComonadStore type class describes the operations supported by this comonad.

runStoreT :: forall a w s. StoreT s w a -> Tuple (w (s -> a)) s

Unwrap a value in the StoreT comonad.