Control.Monad.Module

Right monad Module type-class.

Most possible instances are omitted. The primary use-case for Module is to power ScopeH.

Documentation

class (Functor f, Monad m) => Module f m where

f is right m-module. (according to https://ncatlab.org/nlab/show/module+over+a+monad#modules definitions). We have Compose f m ~> f natural transformation.

Laws

fma >>== return    = fma
fma >>== (f >=> g) = (fma >>== f) >>== g

Properties

For all Monad m we can write associated instance Module m m where (>>==) = (>>=).

mjoin and >>== are equivalent in power:

fa >>== amb = mjoin (fmap amb fa)

Methods

(>>==) :: f a -> (a -> m b) -> f b infixl 1

Called action.

Instances

Functor f => Module f Identity

Defined in Control.Monad.Module

Methods

(>>==) :: f a -> (a -> Identity b) -> f b

Monad m => Module (Scope b m) m

Defined in Control.Monad.Module

Methods

(>>==) :: Scope b m a -> (a -> m b0) -> Scope b m b0

(Functor f, Monad m) => Module (ScopeH b f m) m

Defined in Bound.ScopeH

Methods

(>>==) :: ScopeH b f m a -> (a -> m b0) -> ScopeH b f m b0

(Monad f, Functor (t f)) => Module (ScopeT b t f) f

Defined in Bound.ScopeT

Methods

(>>==) :: ScopeT b t f a -> (a -> f b0) -> ScopeT b t f b0

mjoin :: Module f m => f (m a) -> f a

Module's join variant.

transAction :: (MonadTrans t, Monad m, Monad (t m)) => t m a -> (a -> m b) -> t m b

Module m (t m) action's implementation.

composeAction :: (Functor f, Monad m) => Compose f m a -> (a -> m b) -> Compose f m b

Module m (Compose f m) action's implementation.

class Module f m => LiftedModule f m where

An extension of Module allowing to lift m a info f a. As we have Monad m, this allows to have a pseudo-return for f: point . return :: a -> f a

Note: for f = t m for some MonadTrans t mlift = lift.

Since: 0.0.2

Methods

mlift :: m a -> f a

Instances

LiftedModule f m => LiftedModule (ScopeH b f m) m

Defined in Bound.ScopeH

Methods

mlift :: m a -> ScopeH b f m a

(Monad f, Monad (t f)) => LiftedModule (ScopeT b t f) f

Defined in Bound.ScopeT

Methods

mlift :: f a -> ScopeT b t f a