Control.Concurrent.Speculation

Speculative application

spec :: Eq a => a -> (a -> b) -> a -> b

spec g f a evaluates f g while forcing a, if g == a then f g is returned. Otherwise f a is evaluated.

Furthermore, if the argument has already been evaluated, we avoid sparking the parallel computation at all.

If a good guess at the value of a is available, this is one way to induce parallelism in an otherwise sequential task.

However, if the guess isn't available more cheaply than the actual answer, then this saves no work and if the guess is wrong, you risk evaluating the function twice.

 spec a f a = f $! a

The best-case timeline looks like:

 [---- f g ----]
    [----- a -----]
 [-- spec g f a --]

The worst-case timeline looks like:

 [---- f g ----]
    [----- a -----]
                  [---- f a ----]
 [------- spec g f a -----------]

Compare these to the timeline of f $! a:

 [---- a -----]
              [---- f a ----]

spec' :: Eq a => a -> (a -> b) -> a -> b

Unlike spec, this version does not check to see if the argument has already been evaluated. This can save a small amount of work when you know the argument will always require computation.

specBy :: (a -> a -> Bool) -> a -> (a -> b) -> a -> b

spec with a user defined comparison function

specBy' :: (a -> a -> Bool) -> a -> (a -> b) -> a -> b

spec' with a user defined comparison function

specOn :: Eq c => (a -> c) -> a -> (a -> b) -> a -> b

spec comparing by projection onto another type

specOn' :: Eq c => (a -> c) -> a -> (a -> b) -> a -> b

spec' comparing by projection onto another type

Speculative application with transactional rollback

specSTM :: Eq a => a -> (a -> STM b) -> a -> STM b

specSTM g f a evaluates f g while forcing a, if g == a then f g is returned. Otherwise the side-effects of the current STM transaction are rolled back and f a is evaluated.

If the argument a is already evaluated, we don't bother to perform f g at all.

If a good guess at the value of a is available, this is one way to induce parallelism in an otherwise sequential task.

However, if the guess isn't available more cheaply than the actual answer then this saves no work, and if the guess is wrong, you risk evaluating the function twice.

 specSTM a f a = f $! a

The best-case timeline looks like:

 [------ f g ------]
     [------- a -------]
 [--- specSTM g f a ---]

The worst-case timeline looks like:

 [------ f g ------] 
     [------- a -------]
                       [-- rollback --]
                                      [------ f a ------]     
 [------------------ spec g f a ------------------------]

Compare these to the timeline of f $! a:

 [------- a -------]
                   [------ f a ------]

specSTM' :: Eq a => a -> (a -> STM b) -> a -> STM b

Unlike specSTM, specSTM' doesn't check if the argument has already been evaluated.

specOnSTM :: Eq c => (a -> c) -> a -> (a -> STM b) -> a -> STM b

specBySTM . on (==)'

specOnSTM' :: Eq c => (a -> c) -> a -> (a -> STM b) -> a -> STM b

specBySTM' . on (==)'

specBySTM :: (a -> a -> Bool) -> a -> (a -> STM b) -> a -> STM b

specSTM using a user defined comparison function

specBySTM' :: (a -> a -> Bool) -> a -> (a -> STM b) -> a -> STM b

specSTM' using a user defined comparison function

Codensity STM speculation

specCSTM :: Eq a => a -> (a -> CSTM b) -> a -> CSTM b

specCSTM' :: Eq a => a -> (a -> CSTM b) -> a -> CSTM b

Unlike specSTM, specSTM' doesn't check if the argument has already been evaluated.

specOnCSTM :: Eq c => (a -> c) -> a -> (a -> CSTM b) -> a -> CSTM b

specByCSTM . on (==)'

specOnCSTM' :: Eq c => (a -> c) -> a -> (a -> CSTM b) -> a -> CSTM b

specByCSTM' . on (==)'

specByCSTM :: (a -> a -> Bool) -> a -> (a -> CSTM b) -> a -> CSTM b

specSTM using a user defined comparison function

specByCSTM' :: (a -> a -> Bool) -> a -> (a -> CSTM b) -> a -> CSTM b

specCSTM' using a user defined comparison function

type CSTM = Codensity STM

Codensity

newtype Codensity f a

Constructors

Codensity

Fields

runCodensity :: forall r. (a -> f r) -> f r

Instances

Monad (Codensity f)

Functor (Codensity f)

Applicative (Codensity f)

liftCodensity :: Monad m => m a -> Codensity m a

lowerCodensity :: Monad m => Codensity m a -> m a