Updates for RC

Author: garyb

README.md

@@ -8,21 +8,26 @@ Monad and comonad transformers based on [mtl](http://hackage.haskell.org/package
 
 ## Documentation
 
+- [Control.Monad.Trans](docs/Control.Monad.Trans.md)
+- [Control.Comonad.Trans](docs/Control.Comonad.Trans.md)
+
 ### Monad Transformers
 
-- [MonadTrans](docs/Control.Monad.Trans.md)
-- [Errors](docs/Control.Monad.Error.md)
-- [Exceptions](docs/Monad/Except.md)
-- [Maybe](docs/Control.Monad.Maybe.md)
-- [State](docs/Control.Monad.State.md)
-- [Writer](docs/Control.Monad.Writer.md)
-- [Reader](docs/Control.Monad.Reader.md)
-- [Reader/Writer/State](docs/Control.Monad.RWS.md)
-- [CPS](docs/Control.Monad.Cont.md)
+- [Control.Monad.Cont](docs/Control.Monad.Cont.md) (Continuations)
+
+- [Control.Monad.Error](docs/Control.Monad.Error.md)
+- [Control.Monad.Except](docs/Control.Monad.Except.md)
+
+- [Control.Monad.List.Trans](docs/Control.Monad.List.Trans.md)
+- [Control.Monad.Maybe.Trans](docs/Control.Monad.Maybe.Trans.md)
+
+- [Control.Monad.Reader](docs/Control.Monad.Reader.md)
+- [Control.Monad.Writer](docs/Control.Monad.Writer.md)
+- [Control.Monad.State](docs/Control.Monad.State.md)
+- [Control.Monad.RWS](docs/Control.Monad.RWS.md) (Reader/Writer/State)
 
 ### Comonad Transformers
 
-- [ComonadTrans](docs/Control.Comonad.Trans.md)
-- [Environment](docs/Control.Comonad.Env.md)
-- [Store](docs/Control.Comonad.Store.md)
-- [Cowriter](docs/Control.Comonad.Traced.md)
+- [Control.Comonad.Env](docs/Control.Comonad.Env.md) (Environment or "Coreader")
+- [Control.Comonad.Store](docs/Control.Comonad.Store.md) (or "Costate")
+- [Control.Comonad.Traced](docs/Control.Comonad.Traced.md) (or "Cowriter")

bower.json

@@ -31,9 +31,11 @@
     "package.json"
   ],
   "dependencies": {
-    "purescript-tailrec": "~0.3.0"
+    "purescript-lazy": "^0.4.0",
+    "purescript-tailrec": "^0.3.0",
+    "purescript-unfoldable": "^0.4.0"
   },
   "devDependencies": {
-    "purescript-console": "~0.1.0"
+    "purescript-console": "^0.1.0"
   }
 }

docs/Control.Comonad.Env.md

@@ -1,3 +1,90 @@
+## Module Control.Comonad.Env
+
+This module defines the `Env` comonad.
+
+#### `Env`
+
+``` purescript
+type Env e = EnvT e Identity
+```
+
+The `Env` comonad is a synonym for the `EnvT` comonad transformer, applied
+to the `Identity` monad.
+
+#### `runEnv`
+
+``` purescript
+runEnv :: forall e a. Env e a -> Tuple e a
+```
+
+Unwrap a value in the `Env` comonad.
+
+#### `withEnv`
+
+``` purescript
+withEnv :: forall e1 e2 a. (e1 -> e2) -> Env e1 a -> Env e2 a
+```
+
+Change the environment type in an `Env` computation.
+
+#### `mapEnv`
+
+``` purescript
+mapEnv :: forall e a b. (a -> b) -> Env e a -> Env e b
+```
+
+Change the data type in an `Env` computation.
+
+#### `env`
+
+``` purescript
+env :: forall e a. e -> a -> Env e a
+```
+
+Create a value in context in the `Env` comonad.
+
+
+## Module Control.Comonad.Env.Class
+
+This module defines the `ComonadEnv` type class and its instances.
+
+#### `ComonadEnv`
+
+``` purescript
+class (Comonad w) <= ComonadEnv e w where
+  ask :: forall a. w a -> e
+  local :: forall a. (e -> e) -> w a -> w a
+```
+
+The `ComonadEnv` type class represents those monads which support a global environment via
+`ask` and `local`.
+
+- `ask` reads the current environment from the context.
+- `local` changes the value of the global environment.
+
+An implementation is provided for `EnvT`.
+
+Laws:
+
+- `ask (local f x) = f (ask x)`
+- `extract (local _ x) = extract a`
+- `extend g (local f x) = extend (g <<< local f) x` 
+
+##### Instances
+``` purescript
+instance comonadEnvTuple :: ComonadEnv e (Tuple e)
+instance comonadEnvEnvT :: (Comonad w) => ComonadEnv e (EnvT e w)
+```
+
+#### `asks`
+
+``` purescript
+asks :: forall e1 e2 w a. (ComonadEnv e1 w) => (e1 -> e2) -> w e1 -> e2
+```
+
+Get a value which depends on the environment.
+
+
 ## Module Control.Comonad.Env.Trans
 
 This module defines the environment comonad transformer, `EnvT`.
@@ -9,6 +96,13 @@ newtype EnvT e w a
   = EnvT (Tuple e (w a))
 ```
 
+The environment comonad transformer.
+
+This comonad transformer extends the context of a value in the base comonad with a _global environment_ of
+type `e`.
+
+The `ComonadEnv` type class describes the operations supported by this comonad.
+
 ##### Instances
 ``` purescript
 instance functorEnvT :: (Functor w) => Functor (EnvT e w)
@@ -17,13 +111,6 @@ instance comonadEnvT :: (Comonad w) => Comonad (EnvT e w)
 instance comonadTransEnvT :: ComonadTrans (EnvT e)
 ```
 
-The environment comonad transformer.
-
-This comonad transformer extends the context of a value in the base comonad with a _global environment_ of
-type `e`.
-
-The `ComonadEnv` type class describes the operations supported by this comonad.
-
 #### `runEnvT`
 
 ``` purescript

docs/Control.Comonad.Store.md

@@ -0,0 +1,135 @@
+## Module Control.Comonad.Store
+
+This module defines the `Store` comonad.
+
+#### `Store`
+
+``` purescript
+type Store s a = StoreT s Identity a
+```
+
+The `Store` comonad is a synonym for the `StoreT` comonad transformer, applied
+to the `Identity` monad.
+
+#### `runStore`
+
+``` purescript
+runStore :: forall s a. Store s a -> Tuple (s -> a) s
+```
+
+Unwrap a value in the `Store` comonad.
+
+#### `store`
+
+``` purescript
+store :: forall s a. (s -> a) -> s -> Store s a
+```
+
+Create a value in context in the `Store` comonad.
+
+
+## Module Control.Comonad.Store.Class
+
+This module defines the `ComonadStore` type class and its instances.
+
+#### `ComonadStore`
+
+``` purescript
+class (Comonad w) <= ComonadStore s w where
+  pos :: forall a. w a -> s
+  peek :: forall a. s -> w a -> a
+```
+
+The `ComonadStore` type class represents those monads which support local position information via
+`pos` and `peek`.
+
+- `pos` reads the current position.
+- `peek` reads the value at the specified position in the specified context.
+
+An implementation is provided for `StoreT`.
+
+Laws:
+
+- `pos (extend _ x) = pos x`
+- `peek (pos x) x = extract x`
+
+For example:
+
+```purescript
+blur :: forall w. (ComonadStore Number w) -> w Number -> w Number
+blur = extend \r -> (peeks (\n -> n - 1) r + peeks (\n -> n + 1) r) / 2)
+```
+
+##### Instances
+``` purescript
+instance comonadStoreStoreT :: (Comonad w) => ComonadStore s (StoreT s w)
+```
+
+#### `experiment`
+
+``` purescript
+experiment :: forall f a w s. (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.
+
+#### `peeks`
+
+``` purescript
+peeks :: forall s a w. (ComonadStore s w) => (s -> s) -> w a -> a
+```
+
+Extract a value from a position which depends on the current position.
+
+#### `seek`
+
+``` purescript
+seek :: forall s a w. (ComonadStore s w, Extend w) => s -> w a -> w a
+```
+
+Reposition the focus at the specified position.
+
+#### `seeks`
+
+``` purescript
+seeks :: forall s a w. (ComonadStore s w, Extend w) => (s -> s) -> w a -> w a
+```
+
+Reposition the focus at the specified position, which depends on the current position.
+
+
+## Module Control.Comonad.Store.Trans
+
+This module defines the store comonad transformer, `StoreT`.
+
+#### `StoreT`
+
+``` purescript
+newtype StoreT s w a
+  = StoreT (Tuple (w (s -> a)) s)
+```
+
+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.
+
+##### Instances
+``` purescript
+instance functorStoreT :: (Functor w) => Functor (StoreT s w)
+instance extendStoreT :: (Extend w) => Extend (StoreT s w)
+instance comonadStoreT :: (Comonad w) => Comonad (StoreT s w)
+instance comonadTransStoreT :: ComonadTrans (StoreT s)
+```
+
+#### `runStoreT`
+
+``` purescript
+runStoreT :: forall s w a. StoreT s w a -> Tuple (w (s -> a)) s
+```
+
+Unwrap a value in the `StoreT` comonad.
+
+