#ifdef __GLASGOW_HASKELL__
-- | The lazy state-transformer monad.
--- The first parameter is used solely to keep the states of different
--- invocations of 'runST' separate from each other and from invocations
--- of 'Control.Monad.ST.stToIO'. In the first case the type parameter
--- is not instantiated; in the second it is 'RealWorld'.
+-- A computation of type @'ST' s a@ transforms an internal state indexed
+-- by @s@, and returns a value of type @a@.
+-- The @s@ parameter is either
+--
+-- * an unstantiated type variable (inside invocations of 'runST'), or
+--
+-- * 'RealWorld' (inside invocations of 'stToIO').
+--
+-- It serves to keep the internal states of different invocations of
+-- 'runST' separate from each other and from invocations of 'stToIO'.
newtype ST s a = ST (State s -> (a, State s))
data State s = S# (State# s)
{-# NOINLINE runST #-}
-- | Return the value computed by a state transformer computation.
--- The @forall@ is a technical device to ensure that the state used
--- by the 'ST' computation is inaccessible to the rest of the program.
+-- The @forall@ ensures that the internal state used by the 'ST'
+-- computation is inaccessible to the rest of the program.
runST :: (forall s. ST s a) -> a
runST st = case st of ST the_st -> let (r,_) = the_st (S# realWorld#) in r
-- | Allow the result of a state transformer computation to be used (lazily)
-- inside the computation.
--- Note that if @f@ is strict, @'fixST' f@ will diverge.
+-- Note that if @f@ is strict, @'fixST' f = _|_@.
fixST :: (a -> ST s a) -> ST s a
fixST m = ST (\ s ->
let
unsafeIOToST = strictToLazyST . ST.unsafeIOToST
-- | A monad transformer embedding lazy state transformers in the 'IO'
--- monad. The 'RealWorld' parameter is a technical device to keep the
--- state used by such computations separate from those inside 'runST'.
+-- monad. The 'RealWorld' parameter indicates that the internal state
+-- used by the 'ST' computation is a special one supplied by the 'IO'
+-- monad, and thus distinct from those used by invocations of 'runST'.
stToIO :: ST RealWorld a -> IO a
stToIO = ST.stToIO . lazyToStrictST
#ifdef __HADDOCK__
\begin{code}
--- | A placeholder argument for the 'Control.Monad.ST.ST' type constructor,
--- to mark a state embedded in the 'Prelude.IO' monad by
+-- | A special argument for the 'Control.Monad.ST.ST' type constructor,
+-- indexing a state embedded in the 'Prelude.IO' monad by
-- 'Control.Monad.ST.stToIO'.
data RealWorld
\end{code}
-- Coercions between IO and ST
-- | A monad transformer embedding strict state transformers in the 'IO'
--- monad. The 'RealWorld' parameter is a technical device to keep the
--- state used by such computations separate from those inside 'runST'.
+-- monad. The 'RealWorld' parameter indicates that the internal state
+-- used by the 'ST' computation is a special one supplied by the 'IO'
+-- monad, and thus distinct from those used by invocations of 'runST'.
stToIO :: ST RealWorld a -> IO a
stToIO (ST m) = IO m
\begin{code}
-- | The strict state-transformer monad.
--- The first parameter is used solely to keep the states of different
--- invocations of 'runST' separate from each other and from invocations
--- of 'Control.Monad.ST.stToIO'. In the first case the type parameter
--- is not instantiated; in the second it is 'RealWorld'.
+-- A computation of type @'ST' s a@ transforms an internal state indexed
+-- by @s@, and returns a value of type @a@.
+-- The @s@ parameter is either
+--
+-- * an unstantiated type variable (inside invocations of 'runST'), or
+--
+-- * 'RealWorld' (inside invocations of 'Control.Monad.ST.stToIO').
+--
+-- It serves to keep the internal states of different invocations
+-- of 'runST' separate from each other and from invocations of
+-- 'Control.Monad.ST.stToIO'.
newtype ST s a = ST (STRep s a)
type STRep s a = State# s -> (# State# s, a #)
-- | Allow the result of a state transformer computation to be used (lazily)
-- inside the computation.
--- Note that if @f@ is strict, @'fixST' f@ will diverge.
+-- Note that if @f@ is strict, @'fixST' f = _|_@.
fixST :: (a -> ST s a) -> ST s a
fixST k = ST $ \ s ->
let ans = liftST (k r) s
-- module. Regrettably delicate. runST is behaving like a wrapper.
-- | Return the value computed by a state transformer computation.
--- The @forall@ is a technical device to ensure that the state used
--- by the 'ST' computation is inaccessible to the rest of the program.
+-- The @forall@ ensures that the internal state used by the 'ST'
+-- computation is inaccessible to the rest of the program.
runST :: (forall s. ST s a) -> a
runST st = runSTRep (case st of { ST st_rep -> st_rep })