Merge pull request #411 from andreasabel/evalState

Add `evalState(T)`

Author: aspiwack

linear-base.cabal

@@ -183,7 +183,8 @@ test-suite examples
         base,
         linear-base,
         tasty,
-        tasty-hedgehog,
+        tasty-hedgehog < 1.2,
+          -- tasty-hedgehog deprecates 'testProperty' in test/Test/Data/Destination.hs
         hedgehog,
         storable-tuple,
         vector,

src/Control/Functor/Linear.hs

@@ -48,11 +48,13 @@ module Control.Functor.Linear
     State,
     state,
     runState,
+    evalState,
     execState,
     mapState,
     withState,
     StateT (..),
     runStateT,
+    evalStateT,
     execStateT,
     mapStateT,
     withStateT,

src/Control/Functor/Linear/Internal/State.hs

@@ -21,6 +21,8 @@ module Control.Functor.Linear.Internal.State
     runState,
     mapStateT,
     mapState,
+    evalStateT,
+    evalState,
     execStateT,
     execState,
     withStateT,
@@ -36,6 +38,7 @@ import qualified Control.Monad.Trans.State.Strict as NonLinear
 import Data.Functor.Identity
 import qualified Data.Functor.Linear.Internal.Applicative as Data
 import qualified Data.Functor.Linear.Internal.Functor as Data
+import qualified Data.Tuple.Linear as Linear
 import Data.Unrestricted.Linear.Internal.Consumable
 import Data.Unrestricted.Linear.Internal.Dupable
 import Prelude.Linear.Internal
@@ -80,6 +83,11 @@ withStateT r (StateT f) = StateT (f . r)
 execStateT :: Functor m => StateT s m () %1 -> s %1 -> m s
 execStateT f = fmap (\((), s) -> s) . (runStateT f)
 
+-- | Use with care!
+--   This consumes the final state, so might be costly at runtime.
+evalStateT :: (Functor m, Consumable s) => StateT s m a %1 -> s %1 -> m a
+evalStateT f = fmap Linear.fst . runStateT f
+
 mapState :: ((a, s) %1 -> (b, s)) %1 -> State s a %1 -> State s b
 mapState f = mapStateT (Identity . f . runIdentity')
 
@@ -89,6 +97,11 @@ withState = withStateT
 execState :: State s () %1 -> s %1 -> s
 execState f = runIdentity' . execStateT f
 
+-- | Use with care!
+--   This consumes the final state, so might be costly at runtime.
+evalState :: Consumable s => State s a %1 -> s %1 -> a
+evalState f = runIdentity' . evalStateT f
+
 modify :: Applicative m => (s %1 -> s) %1 -> StateT s m ()
 modify f = state $ \s -> ((), f s)
 

src/Data/Tuple/Linear.hs

@@ -1,7 +1,7 @@
 {-# LANGUAGE LinearTypes #-}
 {-# LANGUAGE NoImplicitPrelude #-}
 
--- | This module provides linear functions commonly used on tuples
+-- | This module provides linear functions commonly used on tuples.
 module Data.Tuple.Linear
   ( fst,
     snd,
@@ -11,8 +11,8 @@ module Data.Tuple.Linear
   )
 where
 
-import Data.Unrestricted.Linear
-import Prelude.Linear.Internal
+import Data.Unrestricted.Linear.Internal.Consumable
+import Prelude.Linear.Internal (curry, uncurry)
 
 fst :: Consumable b => (a, b) %1 -> a
 fst (a, b) = lseq b a

src/Data/Unrestricted/Linear.hs

@@ -22,8 +22,8 @@
 -- If a type is 'Consumable', you can __consume__ it in a linear function that
 -- doesn't need that value to produce it's result:
 --
--- > first :: Consumable b => (a,b) %1-> a
--- > first (a,b) = withConsume (consume b) a
+-- > fst :: Consumable b => (a,b) %1-> a
+-- > fst (a,b) = withConsume (consume b) a
 -- >   where
 -- >     withConsume :: () %1-> a %1-> a
 -- >     withConsume () x = x