-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A framework for safe, programmable, speculative parallelism
--   
--   A framework for safe, programmable, speculative parallelism, loosely
--   based on
--   <a>http://research.microsoft.com/pubs/118795/pldi026-vaswani.pdf</a>
@package speculation
@version 0.0.1

module Control.Concurrent.Speculation

-- | Evaluate a function using a cheap guess at the argument in parallel
--   with forcing the argument.
--   
--   This is one way to induce parallelism in an otherwise sequential task.
--   If the argument has already been evaluated, we avoid sparking the
--   parallel computation.
spec :: (Eq a) => a -> (a -> b) -> a -> b

-- | Returns a guess as to whether or not a value has been evaluated. This
--   is an impure function that relies on GHC internals and will return
--   false negatives, but (hopefully) no false positives.
evaluated :: a -> Bool

-- | Compute a right biased fold. The estimator function provides a guess
--   at the value of the suffix
specFoldr :: (Speculative f, Eq b) => (Int -> b) -> (a -> b -> b) -> b -> f a -> b

-- | Compute a left-biased fold. The estimator function provides a guess at
--   the value of the prefix
specFoldl :: (Speculative f, Eq b) => (Int -> b) -> (b -> a -> b) -> b -> f a -> b
class (Foldable f) => Speculative f
specFoldr1 :: (Speculative f, Eq a) => (Int -> a) -> (a -> a -> a) -> f a -> a
specFoldrN :: (Speculative f, Eq b) => Int -> (Int -> b) -> (a -> b -> b) -> b -> f a -> b
specFoldl1 :: (Speculative f, Eq a) => (Int -> a) -> (a -> a -> a) -> f a -> a
specFoldlN :: (Speculative f, Eq b) => Int -> (Int -> b) -> (b -> a -> b) -> b -> f a -> b
newtype WrappedFoldable f a
WrappedFoldable :: f a -> WrappedFoldable f a
getWrappedFoldable :: WrappedFoldable f a -> f a
newtype WithoutSpeculation f a
WithoutSpeculation :: f a -> WithoutSpeculation f a
getWithoutSpeculation :: WithoutSpeculation f a -> f a
instance (Functor f) => Functor (WithoutSpeculation f)
instance (Foldable f) => Foldable (WithoutSpeculation f)
instance (Traversable f) => Traversable (WithoutSpeculation f)
instance (Functor f) => Functor (WrappedFoldable f)
instance (Foldable f) => Foldable (WrappedFoldable f)
instance (Traversable f) => Traversable (WrappedFoldable f)
instance (Typeable1 f, Data (f a), Data a) => Data (WithoutSpeculation f a)
instance (Foldable f) => Speculative (WithoutSpeculation f)
instance (Typeable1 f) => Typeable1 (WithoutSpeculation f)
instance (Typeable1 f, Data (f a), Data a) => Data (WrappedFoldable f a)
instance (Typeable1 f) => Typeable1 (WrappedFoldable f)
instance (Foldable f) => Speculative (WrappedFoldable f)
instance Speculative Seq
instance Speculative IntMap
instance Speculative (Map a)
instance Speculative Set
instance (Ix i) => Speculative (Array i)
instance Speculative Maybe
instance Speculative []