(NOTE: This module reexports a default Par scheduler. A generic interface can be found in Control.Monad.Par.Class and other schedulers, sometimes with different capabilities, can be found in Control.Monad.Par.Scheds.)

The monad-par package provides a family of Par monads, for speeding up pure computations using parallel processors. They cannot be used for speeding up computations that use IO (for that, see Control.Concurrent). The result of a given Par computation is always the same - ie. it is deterministic, but the computation may be performed more quickly if there are processors available to share the work.

For example, the following program fragment computes the values of (f x) and (g x) in parallel, and returns a pair of their results:

  runPar $ do
      fx <- spawn (return (f x))  -- start evaluating (f x)
      gx <- spawn (return (g x))  -- start evaluating (g x)
      a <- get fx       -- wait for fx
      b <- get gx       -- wait for gx
      return (a,b)      -- return results

Par can be used for specifying pure parallel computations in which the order of the computation is not known beforehand. The programmer specifies how information flows from one part of the computation to another, but not the order in which computations will be evaluated at runtime. Information flow is described using variables called IVars, which support put and get operations. For example, suppose you have a problem that can be expressed as a network with four nodes, where b and c require the value of a, and d requires the value of b and c:

                       a
                      / \               
                     b   c             
                      \ /  
                       d

Then you could express this in the Par monad like this:

   runPar $ do
       [a,b,c,d] <- sequence [new,new,new,new]
       fork $ do x <- get a; put b (x+1)
       fork $ do x <- get a; put c (x+2)
       fork $ do x <- get b; y <- get c; put d (x+y)
       fork $ do put a (3 :: Int)
       get d

The result of the above computation is always 9. The get operation waits until its input is available; multiple puts to the same IVar are not allowed, and result in a runtime error. Values stored in IVars are usually fully evaluated (although there are ways provided to pass lazy values if necessary).

In the above example, b and c will be evaluated in parallel. In practice the work involved at each node is too small here to see the benefits of parallelism though: typically each node should involve much more work. The granularity is completely under your control - too small and the overhead of the Par monad will outweigh any parallelism benefits, whereas if the nodes are too large then there might not be enough parallelism to use all the available processors.

Unlike Control.Parallel, in Control.Monad.Par parallelism is not combined with laziness, so sharing and granulairty are completely under the control of the programmer. New units of parallel work are only created by fork and a few other combinators.

The implementation is based on a work-stealing scheduler that divides the work as evenly as possible between the available processors at runtime.

For more information on the programming model, please see these sources:

• The wikitutorial (<http:www.haskell.orghaskellwiki/Par_Monad:_A_Parallelism_Tutorial>) * The original paper (http://www.cs.indiana.edu/~rrnewton/papers/haskell2011_monad-par.pdf) * Tutorial slides (http://community.haskell.org/~simonmar/slides/CUFP.pdf) * Other slides: http://www.cs.ox.ac.uk/ralf.hinze/WG2.8/28/slides/simon.pdf, http://www.cs.indiana.edu/~rrnewton/talks/2011_HaskellSymposium_ParMonad.pdf

forks a computation to happen in parallel. The forked computation may exchange values with other computations using IVars.

creates a new IVar

creates a new IVar that contains a value

creates a new IVar that contains a value (head-strict only)

read the value in an IVar. get can only return when the value has been written by a prior or parallel put to the same IVar.

put a value into a IVar. Multiple puts to the same IVar are not allowed, and result in a runtime error.

put fully evaluates its argument, which therefore must be an instance of NFData. The idea is that this forces the work to happen when we expect it, rather than being passed to the consumer of the IVar and performed later, which often results in less parallelism than expected.

Sometimes partial strictness is more appropriate: see put_.

like put, but only head-strict rather than fully-strict.

Like fork, but returns a IVar that can be used to query the result of the forked computataion. Therefore spawn provides futures or promises.

  spawn p = do
    r <- new
    fork (p >>= put r)
    return r

Like spawn, but the result is only head-strict, not fully-strict.

Spawn a pure (rather than monadic) computation. Fully-strict.

  spawnP = spawn . return

This module also reexports the Combinator library for backwards compatibility with version 0.1.

(0.3) Reexport NFData for fully-strict operators.