monads-tf-0.1.0.2: Monad classes, using type families

Copyright(c) Andy Gill 2001, (c) Oregon Graduate Institute of Science and Technology, 2001
LicenseBSD-style (see the file LICENSE)
Maintainerross@soi.city.ac.uk
Stabilityexperimental
Portabilitynon-portable (type families)
Safe HaskellSafe
LanguageHaskell98

Control.Monad.Writer.Strict

Contents

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

MonadWriter class

class (Monoid (WriterType m), Monad m) => MonadWriter m where Source

Associated Types

type WriterType m Source

Methods

tell :: WriterType m -> m () Source

listen :: m a -> m (a, WriterType m) Source

pass :: m (a, WriterType m -> WriterType m) -> m a Source

listens :: MonadWriter m => (WriterType m -> b) -> m a -> m (a, b) Source

censor :: MonadWriter m => (WriterType m -> WriterType m) -> m a -> m a Source

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 >>= combines the outputs of the subcomputations using mappend.

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

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

execWriter :: Writer w a -> w

Extract the output from a writer computation.

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.

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 >>= combines the outputs of the subcomputations using mappend.

Constructors

WriterT 

Fields

runWriterT :: m (a, w)
 

Instances

Monoid w => MonadTrans (WriterT w) 
(Monoid w, Monad m) => Monad (WriterT w m) 
Functor m => Functor (WriterT w m) 
(Monoid w, MonadFix m) => MonadFix (WriterT w m) 
(Monoid w, Applicative m) => Applicative (WriterT w m) 
Foldable f => Foldable (WriterT w f) 
Traversable f => Traversable (WriterT w f) 
(Monoid w, Alternative m) => Alternative (WriterT w m) 
(Monoid w, MonadPlus m) => MonadPlus (WriterT w m) 
(Eq w, Eq1 m) => Eq1 (WriterT w m) 
(Ord w, Ord1 m) => Ord1 (WriterT w m) 
(Read w, Read1 m) => Read1 (WriterT w m) 
(Show w, Show1 m) => Show1 (WriterT w m) 
(Monoid w, MonadIO m) => MonadIO (WriterT w m) 
(Monoid w, MonadCont m) => MonadCont (WriterT w m) Source 
(Monoid w, MonadError m) => MonadError (WriterT w m) Source 
(Monoid w, MonadReader m) => MonadReader (WriterT w m) Source 
(Monoid w, MonadState m) => MonadState (WriterT w m) Source 
(Monoid w, Monad m) => MonadWriter (WriterT w m) Source 
(Eq w, Eq1 m, Eq a) => Eq (WriterT w m a) 
(Ord w, Ord1 m, Ord a) => Ord (WriterT w m a) 
(Read w, Read1 m, Read a) => Read (WriterT w m a) 
(Show w, Show1 m, Show a) => Show (WriterT w m a) 
type ErrorType (WriterT w m) = ErrorType m Source 
type EnvType (WriterT w m) = EnvType m Source 
type StateType (WriterT w m) = StateType m Source 
type WriterType (WriterT w m) = w Source 

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

Extract the output from a writer computation.

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.