Community
Modules 24

Control.Monad.Trans.Writer.CPS

experimental

The strict WriterT monad transformer, which adds collection of outputs (such as a count or string output) to a given monad.

This monad transformer provides only limited access to the output during the computation. For more general access, use Control.Monad.Trans.State instead.

This version builds its output strictly and uses continuation-passing-style to achieve constant space usage. This transformer can be used as a drop-in replacement for Control.Monad.Trans.Writer.Strict.

The Writer monad

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 m >>= k combines the outputs of the subcomputations using mappend (also known as <>):

<<images/bind-WriterT.svg>>

writer :: (Monoid w, Monad m) => (a, w) -> WriterT w m a

Construct a writer computation from a (result, output) pair. (The inverse of runWriter.)

runWriter :: (Monoid w) => Writer w a -> (a, w)

Unwrap a writer computation as a (result, output) pair. (The inverse of writer.)

execWriter :: (Monoid w) => Writer w a -> w

Extract the output from a writer computation.

  • execWriter m = snd (runWriter m)

mapWriter :: (Monoid w, Monoid w') => ((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)

The WriterT monad transformer

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 m >>= k combines the outputs of the subcomputations using mappend (also known as <>):

<<images/bind-WriterT.svg>>

writerT :: (Functor m, Monoid w) => m (a, w) -> WriterT w m a

Construct a writer computation from a (result, output) computation. (The inverse of runWriterT.)

runWriterT :: (Monoid w) => WriterT w m a -> m (a, w)

Unwrap a writer computation. (The inverse of writerT.)

execWriterT :: (Monad m, Monoid w) => WriterT w m a -> m w

Extract the output from a writer computation.

  • execWriterT m = liftM snd (runWriterT m)

mapWriterT :: (Monad n, Monoid w, Monoid w') => (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)

Writer operations

tell :: (Monoid w, Monad m) => w -> WriterT w m ()

tell w is an action that produces the output w.

listen :: (Monoid w, Monad m) => WriterT w m a -> WriterT w m (a, w)

listen m is an action that executes the action m and adds its output to the value of the computation.

  • runWriterT (listen m) = liftM (\ (a, w) -> ((a, w), w)) (runWriterT m)

listens :: (Monoid w, Monad m) => (w -> b) -> WriterT w m a -> WriterT w m (a, b)

listens f m is an action that executes the action m and adds the result of applying f to the output to the value of the computation.

  • listens f m = liftM (id *** f) (listen m)

  • runWriterT (listens f m) = liftM (\ (a, w) -> ((a, f w), w)) (runWriterT m)

pass :: (Monoid w, Monoid w', Monad m) => WriterT w m (a, w -> w') -> WriterT w' m a

pass m is an action that executes the action m, which returns a value and a function, and returns the value, applying the function to the output.

  • runWriterT (pass m) = liftM (\ ((a, f), w) -> (a, f w)) (runWriterT m)

censor :: (Monoid w, Monad m) => (w -> w) -> WriterT w m a -> WriterT w m a

censor f m is an action that executes the action m and applies the function f to its output, leaving the return value unchanged.

  • censor f m = pass (liftM (\ x -> (x,f)) m)

  • runWriterT (censor f m) = liftM (\ (a, w) -> (a, f w)) (runWriterT m)

Lifting other operations

liftCallCC :: CallCC m (a, w) (b, w) -> CallCC (WriterT w m) a b

Uniform lifting of a callCC operation to the new monad. The uniformity property (see Control.Monad.Signatures) implies that the lifted callCC discards any output from the body on entering the saved continuation.

liftCatch :: Catch e m (a, w) -> Catch e (WriterT w m) a

Lift a catchE operation to the new monad. The uniformity property (see Control.Monad.Signatures) implies that the lifted catchE discards any output from the body on entering the handler.

Instances

10
  • instance (Generic w, Generic m, Generic a) => Generic (WriterT w m a)
  • instance (Functor m) => Functor (WriterT w m)
  • instance (Functor m, Monad m) => Applicative (WriterT w m)
  • instance (Functor m, MonadPlus m) => Alternative (WriterT w m)
  • instance (Monad m) => Monad (WriterT w m)
  • instance (Fail.MonadFail m) => Fail.MonadFail (WriterT w m)
  • instance (Functor m, MonadPlus m) => MonadPlus (WriterT w m)
  • instance (MonadFix m) => MonadFix (WriterT w m)
  • instance MonadTrans (WriterT w)
  • instance (MonadIO m) => MonadIO (WriterT w m)
Maintainer
R.Paterson@city.ac.uk
Portability
portable
Copyright
(c) Daniel Mendler 2016, (c) Andy Gill 2001, (c) Oregon Graduate Institute of Science and Technology, 2001
License
BSD-style (see the file LICENSE)
Build record and source files

Community contribution. The service has not verified this documentation.

Target: Linux on x86-64. Some inferred types and resolved links are not available.

Generator: aihc-haddock-858b1951-web-1

Metadata snapshot: ac77ab7d2b1e88487eeab41661abedb7bfb8bc846deb92e7874c08d166bff65d

Open the dependency plan · Download the documentation model

Import a package

Enter a package name and an exact version from Hackage. The site contains imported versions only.