| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

The Functor, Monad and MonadPlus classes,
with some useful operations on monads.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Synopsis | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Functor and monad classes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

class Functor f where | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

class Monad m where | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

class Monad m => MonadPlus m where | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Functions | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Naming conventions | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

The functions in this library use the following naming conventions: - A postfix '
`M`' always stands for a function in the Kleisli category: The monad type constructor`m`is added to function results (modulo currying) and nowhere else. So, for example,
filter :: (a -> Bool) -> [a] -> [a] filterM :: (Monad m) => (a -> m Bool) -> [a] -> m [a] - A postfix '
`_`' changes the result type from`(m a)`to`(m ())`. Thus, for example:
sequence :: Monad m => [m a] -> m [a] sequence_ :: Monad m => [m a] -> m () - A prefix '
`m`' generalizes an existing function to a monadic form. Thus, for example:
sum :: Num a => [a] -> a msum :: MonadPlus m => [m a] -> m a | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Basic functions from the Prelude | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

mapM :: Monad m => (a -> m b) -> [a] -> m [b] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

is equivalent to mapM f.
sequence . map f | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

mapM_ :: Monad m => (a -> m b) -> [a] -> m () | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

is equivalent to mapM_ f.
sequence_ . map f | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

sequence :: Monad m => [m a] -> m [a] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Evaluate each action in the sequence from left to right, and collect the results. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

sequence_ :: Monad m => [m a] -> m () | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Evaluate each action in the sequence from left to right, and ignore the results. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

(=<<) :: Monad m => (a -> m b) -> m a -> m b | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Same as >>=, but with the arguments interchanged.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Generalisations of list functions | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

join :: Monad m => m (m a) -> m a | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

The join function is the conventional monad join operator. It is used to
remove one level of monadic structure, projecting its bound argument into the
outer level.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

msum :: MonadPlus m => [m a] -> m a | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

This generalizes the list-based concat function.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

filterM :: Monad m => (a -> m Bool) -> [a] -> m [a] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

This generalizes the list-based filter function.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

mapAndUnzipM :: Monad m => (a -> m (b, c)) -> [a] -> m ([b], [c]) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

The mapAndUnzipM function maps its first argument over a list, returning
the result as a pair of lists. This function is mainly used with complicated
data structures or a state-transforming monad.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

zipWithM :: Monad m => (a -> b -> m c) -> [a] -> [b] -> m [c] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

The zipWithM function generalizes zipWith to arbitrary monads.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

zipWithM_ :: Monad m => (a -> b -> m c) -> [a] -> [b] -> m () | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

zipWithM_ is the extension of zipWithM which ignores the final result.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

foldM :: Monad m => (a -> b -> m a) -> a -> [b] -> m a | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

The foldM f a1 [x1, x2, ..., xm ] == do a2 <- f a1 x1 a3 <- f a2 x2 ... f am xm If right-to-left evaluation is required, the input list should be reversed. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

foldM_ :: Monad m => (a -> b -> m a) -> a -> [b] -> m () | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Like foldM, but discards the result.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

replicateM :: Monad m => Int -> m a -> m [a] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

performs the action replicateM n actn times,
gathering the results.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

replicateM_ :: Monad m => Int -> m a -> m () | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Like replicateM, but discards the result.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Conditional execution of monadic expressions | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

guard :: MonadPlus m => Bool -> m () | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

is guard b if return ()b is True,
and mzero if b is False.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

when :: Monad m => Bool -> m () -> m () | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Conditional execution of monadic expressions. For example, when debug (putStr "Debugging\n") will output the string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

unless :: Monad m => Bool -> m () -> m () | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

The reverse of when.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Monadic lifting operators | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

liftM :: Monad m => (a1 -> r) -> m a1 -> m r | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Promote a function to a monad. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

liftM2 :: Monad m => (a1 -> a2 -> r) -> m a1 -> m a2 -> m r | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Promote a function to a monad, scanning the monadic arguments from left to right. For example, liftM2 (+) [0,1] [0,2] = [0,2,1,3] liftM2 (+) (Just 1) Nothing = Nothing | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

liftM3 :: Monad m => (a1 -> a2 -> a3 -> r) -> m a1 -> m a2 -> m a3 -> m r | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Promote a function to a monad, scanning the monadic arguments from
left to right (cf. liftM2).
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

liftM4 :: Monad m => (a1 -> a2 -> a3 -> a4 -> r) -> m a1 -> m a2 -> m a3 -> m a4 -> m r | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Promote a function to a monad, scanning the monadic arguments from
left to right (cf. liftM2).
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

liftM5 :: Monad m => (a1 -> a2 -> a3 -> a4 -> a5 -> r) -> m a1 -> m a2 -> m a3 -> m a4 -> m a5 -> m r | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Promote a function to a monad, scanning the monadic arguments from
left to right (cf. liftM2).
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

ap :: Monad m => m (a -> b) -> m a -> m b | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

In many situations, the return f `ap` x1 `ap` ... `ap` xn is equivalent to liftMn f x1 x2 ... xn | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||

Produced by Haddock version 0.7 |