Copyright	(c) Andy Gill 2001 (c) Oregon Graduate Institute of Science and Technology 2001
License	BSD-style (see the file libraries/base/LICENSE)
Maintainer	libraries@haskell.org
Stability	experimental
Portability	non-portable (multi-param classes, functional dependencies)
Safe Haskell	Safe
Language	Haskell2010

Control.Monad.Writer.Strict

Description

Strict writer monads.

Inspired by the paper /Functional Programming with Overloading and Higher-Order Polymorphism/, Mark P Jones (http://web.cecs.pdx.edu/~mpj/pubs/springschool.html) Advanced School of Functional Programming, 1995.

Synopsis

Documentation

module Control.Monad.Writer.Class

type Writer w = WriterT w Identity #

A writer monad parameterized by the type w of output to accumulate.

The return function produces the output mempty, while >>= combines the outputs of the subcomputations using mappend.

execWriter :: Writer w a -> w #

Extract the output from a writer computation.

```
execWriter m = snd (runWriter m)
```

mapWriter :: ((a, w) -> (b, w')) -> Writer w a -> Writer w' b #

Map both the return value and output of a computation using the given function.

runWriter (mapWriter f m) = f (runWriter m)

newtype WriterT w (m :: * -> *) a :: * -> (* -> *) -> * -> * #

A writer monad parameterized by:

w - the output to accumulate.
m - The inner monad.

The return function produces the output mempty, while >>= combines the outputs of the subcomputations using mappend.

Constructors

WriterT
Fields runWriterT :: m (a, w)

Instances

Monoid w => MonadTrans (WriterT w)
Methods lift :: Monad m => m a -> WriterT w m a #
(Monoid w, Monad m) => Monad (WriterT w m)
Methods (>>=) :: WriterT w m a -> (a -> WriterT w m b) -> WriterT w m b # (>>) :: WriterT w m a -> WriterT w m b -> WriterT w m b # return :: a -> WriterT w m a # fail :: String -> WriterT w m a #
Functor m => Functor (WriterT w m)
Methods fmap :: (a -> b) -> WriterT w m a -> WriterT w m b # (<$) :: a -> WriterT w m b -> WriterT w m a #
(Monoid w, MonadFix m) => MonadFix (WriterT w m)
Methods mfix :: (a -> WriterT w m a) -> WriterT w m a #
(Monoid w, MonadFail m) => MonadFail (WriterT w m)
Methods fail :: String -> WriterT w m a #
(Monoid w, Applicative m) => Applicative (WriterT w m)
Methods pure :: a -> WriterT w m a # (<>) :: WriterT w m (a -> b) -> WriterT w m a -> WriterT w m b # liftA2 :: (a -> b -> c) -> WriterT w m a -> WriterT w m b -> WriterT w m c # (>) :: WriterT w m a -> WriterT w m b -> WriterT w m b # (<*) :: WriterT w m a -> WriterT w m b -> WriterT w m a #
Foldable f => Foldable (WriterT w f)
Methods fold :: Monoid m => WriterT w f m -> m # foldMap :: Monoid m => (a -> m) -> WriterT w f a -> m # foldr :: (a -> b -> b) -> b -> WriterT w f a -> b # foldr' :: (a -> b -> b) -> b -> WriterT w f a -> b # foldl :: (b -> a -> b) -> b -> WriterT w f a -> b # foldl' :: (b -> a -> b) -> b -> WriterT w f a -> b # foldr1 :: (a -> a -> a) -> WriterT w f a -> a # foldl1 :: (a -> a -> a) -> WriterT w f a -> a # toList :: WriterT w f a -> [a] # null :: WriterT w f a -> Bool # length :: WriterT w f a -> Int # elem :: Eq a => a -> WriterT w f a -> Bool # maximum :: Ord a => WriterT w f a -> a # minimum :: Ord a => WriterT w f a -> a # sum :: Num a => WriterT w f a -> a # product :: Num a => WriterT w f a -> a #
Traversable f => Traversable (WriterT w f)
Methods traverse :: Applicative f => (a -> f b) -> WriterT w f a -> f (WriterT w f b) # sequenceA :: Applicative f => WriterT w f (f a) -> f (WriterT w f a) # mapM :: Monad m => (a -> m b) -> WriterT w f a -> m (WriterT w f b) # sequence :: Monad m => WriterT w f (m a) -> m (WriterT w f a) #
(Eq w, Eq1 m) => Eq1 (WriterT w m)
Methods liftEq :: (a -> b -> Bool) -> WriterT w m a -> WriterT w m b -> Bool #
(Ord w, Ord1 m) => Ord1 (WriterT w m)
Methods liftCompare :: (a -> b -> Ordering) -> WriterT w m a -> WriterT w m b -> Ordering #
(Read w, Read1 m) => Read1 (WriterT w m)
Methods liftReadsPrec :: (Int -> ReadS a) -> ReadS [a] -> Int -> ReadS (WriterT w m a) # liftReadList :: (Int -> ReadS a) -> ReadS [a] -> ReadS [WriterT w m a] # liftReadPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec (WriterT w m a) # liftReadListPrec :: ReadPrec a -> ReadPrec [a] -> ReadPrec [WriterT w m a] #
(Show w, Show1 m) => Show1 (WriterT w m)
Methods liftShowsPrec :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> Int -> WriterT w m a -> ShowS # liftShowList :: (Int -> a -> ShowS) -> ([a] -> ShowS) -> [WriterT w m a] -> ShowS #
(Monoid w, MonadZip m) => MonadZip (WriterT w m)
Methods mzip :: WriterT w m a -> WriterT w m b -> WriterT w m (a, b) # mzipWith :: (a -> b -> c) -> WriterT w m a -> WriterT w m b -> WriterT w m c # munzip :: WriterT w m (a, b) -> (WriterT w m a, WriterT w m b) #
(Monoid w, MonadIO m) => MonadIO (WriterT w m)
Methods liftIO :: IO a -> WriterT w m a #
(Monoid w, Alternative m) => Alternative (WriterT w m)
Methods empty :: WriterT w m a # (<\|>) :: WriterT w m a -> WriterT w m a -> WriterT w m a # some :: WriterT w m a -> WriterT w m [a] # many :: WriterT w m a -> WriterT w m [a] #
(Monoid w, MonadPlus m) => MonadPlus (WriterT w m)
Methods mzero :: WriterT w m a # mplus :: WriterT w m a -> WriterT w m a -> WriterT w m a #
(Monoid w, MonadState m) => MonadState (WriterT w m) Source #
Associated Types type StateType (WriterT w m :: * -> ) :: Source # Methods get :: WriterT w m (StateType (WriterT w m)) Source # put :: StateType (WriterT w m) -> WriterT w m () Source #
(Monoid w, MonadReader m) => MonadReader (WriterT w m) Source #
Associated Types type EnvType (WriterT w m :: * -> ) :: Source # Methods ask :: WriterT w m (EnvType (WriterT w m)) Source # local :: (EnvType (WriterT w m) -> EnvType (WriterT w m)) -> WriterT w m a -> WriterT w m a Source #
(Monoid w, MonadError m) => MonadError (WriterT w m) Source #
Associated Types type ErrorType (WriterT w m :: * -> ) :: Source # Methods throwError :: ErrorType (WriterT w m) -> WriterT w m a Source # catchError :: WriterT w m a -> (ErrorType (WriterT w m) -> WriterT w m a) -> WriterT w m a Source #
(Monoid w, MonadCont m) => MonadCont (WriterT w m) Source #
Methods callCC :: ((a -> WriterT w m b) -> WriterT w m a) -> WriterT w m a Source #
(Monoid w, Monad m) => MonadWriter (WriterT w m) Source #
Associated Types type WritType (WriterT w m :: * -> ) :: Source # Methods tell :: WritType (WriterT w m) -> WriterT w m () Source # listen :: WriterT w m a -> WriterT w m (a, WritType (WriterT w m)) Source # pass :: WriterT w m (a, WritType (WriterT w m) -> WritType (WriterT w m)) -> WriterT w m a Source #
(Eq w, Eq1 m, Eq a) => Eq (WriterT w m a)
Methods (==) :: WriterT w m a -> WriterT w m a -> Bool # (/=) :: WriterT w m a -> WriterT w m a -> Bool #
(Ord w, Ord1 m, Ord a) => Ord (WriterT w m a)
Methods compare :: WriterT w m a -> WriterT w m a -> Ordering # (<) :: WriterT w m a -> WriterT w m a -> Bool # (<=) :: WriterT w m a -> WriterT w m a -> Bool # (>) :: WriterT w m a -> WriterT w m a -> Bool # (>=) :: WriterT w m a -> WriterT w m a -> Bool # max :: WriterT w m a -> WriterT w m a -> WriterT w m a # min :: WriterT w m a -> WriterT w m a -> WriterT w m a #
(Read w, Read1 m, Read a) => Read (WriterT w m a)
Methods readsPrec :: Int -> ReadS (WriterT w m a) # readList :: ReadS [WriterT w m a] # readPrec :: ReadPrec (WriterT w m a) # readListPrec :: ReadPrec [WriterT w m a] #
(Show w, Show1 m, Show a) => Show (WriterT w m a)
Methods showsPrec :: Int -> WriterT w m a -> ShowS # show :: WriterT w m a -> String # showList :: [WriterT w m a] -> ShowS #
type StateType (WriterT w m) Source #
type StateType (WriterT w m) = StateType m
type EnvType (WriterT w m) Source #
type EnvType (WriterT w m) = EnvType m
type ErrorType (WriterT w m) Source #
type ErrorType (WriterT w m) = ErrorType m
type WritType (WriterT w m) Source #
type WritType (WriterT w m) = w

execWriterT :: Monad m => WriterT w m a -> m w #

Extract the output from a writer computation.

execWriterT m = liftM snd (runWriterT m)

mapWriterT :: (m (a, w) -> n (b, w')) -> WriterT w m a -> WriterT w' n b #

Map both the return value and output of a computation using the given function.

runWriterT (mapWriterT f m) = f (runWriterT m)

module Control.Monad

module Control.Monad.Fix

module Control.Monad.Trans

module Data.Monoid