repa-3.4.1.2: High performance, regular, shape polymorphic parallel arrays.

Data.Array.Repa.Eval

Description

Low level interface to parallel array filling operators.

Synopsis

# Element types

class Elt a where Source #

Element types that can be used with the blockwise filling functions.

This class is mainly used to define the touch method. This is used internally in the imeplementation of Repa to prevent let-binding from being floated inappropriately by the GHC simplifier. Doing a seq sometimes isn't enough, because the GHC simplifier can erase these, and still move around the bindings.

Methods

touch :: a -> IO () Source #

Place a demand on a value at a particular point in an IO computation.

touch :: (Generic a, GElt (Rep a)) => a -> IO () Source #

Place a demand on a value at a particular point in an IO computation.

zero :: a Source #

Generic zero value, helpful for debugging.

zero :: (Generic a, GElt (Rep a)) => a Source #

Generic zero value, helpful for debugging.

one :: a Source #

Generic one value, helpful for debugging.

one :: (Generic a, GElt (Rep a)) => a Source #

Generic one value, helpful for debugging.

Instances

 Source # Methodstouch :: Bool -> IO () Source # Source # Methodstouch :: Double -> IO () Source # Source # Methodstouch :: Float -> IO () Source # Source # Methodstouch :: Int -> IO () Source # Source # Methodstouch :: Int8 -> IO () Source # Source # Methodstouch :: Int16 -> IO () Source # Source # Methodstouch :: Int32 -> IO () Source # Source # Methodstouch :: Int64 -> IO () Source # Source # Methodstouch :: Word -> IO () Source # Source # Methodstouch :: Word8 -> IO () Source # Source # Methodstouch :: Word16 -> IO () Source # Source # Methodstouch :: Word32 -> IO () Source # Source # Methodstouch :: Word64 -> IO () Source # (Elt a, Elt b) => Elt (a, b) Source # Methodstouch :: (a, b) -> IO () Source #zero :: (a, b) Source #one :: (a, b) Source # (Elt a, Elt b, Elt c) => Elt (a, b, c) Source # Methodstouch :: (a, b, c) -> IO () Source #zero :: (a, b, c) Source #one :: (a, b, c) Source # (Elt a, Elt b, Elt c, Elt d) => Elt (a, b, c, d) Source # Methodstouch :: (a, b, c, d) -> IO () Source #zero :: (a, b, c, d) Source #one :: (a, b, c, d) Source # (Elt a, Elt b, Elt c, Elt d, Elt e) => Elt (a, b, c, d, e) Source # Methodstouch :: (a, b, c, d, e) -> IO () Source #zero :: (a, b, c, d, e) Source #one :: (a, b, c, d, e) Source # (Elt a, Elt b, Elt c, Elt d, Elt e, Elt f) => Elt (a, b, c, d, e, f) Source # Methodstouch :: (a, b, c, d, e, f) -> IO () Source #zero :: (a, b, c, d, e, f) Source #one :: (a, b, c, d, e, f) Source #

# Parallel array filling

class Target r e where Source #

Class of manifest array representations that can be constructed in parallel.

Minimal complete definition

Associated Types

data MVec r e Source #

Mutable version of the representation.

Methods

newMVec :: Int -> IO (MVec r e) Source #

Allocate a new mutable array of the given size.

unsafeWriteMVec :: MVec r e -> Int -> e -> IO () Source #

Write an element into the mutable array.

unsafeFreezeMVec :: sh -> MVec r e -> IO (Array r sh e) Source #

Freeze the mutable array into an immutable Repa array.

deepSeqMVec :: MVec r e -> a -> a Source #

Ensure the strucure of a mutable array is fully evaluated.

touchMVec :: MVec r e -> IO () Source #

Ensure the array is still live at this point. Needed when the mutable array is a ForeignPtr with a finalizer.

Instances

 Storable e => Target F e Source # Filling foreign buffers. Associated Typesdata MVec F e :: * Source # MethodsnewMVec :: Int -> IO (MVec F e) Source #unsafeWriteMVec :: MVec F e -> Int -> e -> IO () Source #unsafeFreezeMVec :: sh -> MVec F e -> IO (Array F sh e) Source #deepSeqMVec :: MVec F e -> a -> a Source #touchMVec :: MVec F e -> IO () Source # Unbox e => Target U e Source # Filling of unboxed vector arrays. Associated Typesdata MVec U e :: * Source # MethodsnewMVec :: Int -> IO (MVec U e) Source #unsafeWriteMVec :: MVec U e -> Int -> e -> IO () Source #unsafeFreezeMVec :: sh -> MVec U e -> IO (Array U sh e) Source #deepSeqMVec :: MVec U e -> a -> a Source #touchMVec :: MVec U e -> IO () Source # Source # Filling of boxed vector arrays. Associated Typesdata MVec V e :: * Source # MethodsnewMVec :: Int -> IO (MVec V e) Source #unsafeWriteMVec :: MVec V e -> Int -> e -> IO () Source #unsafeFreezeMVec :: sh -> MVec V e -> IO (Array V sh e) Source #deepSeqMVec :: MVec V e -> a -> a Source #touchMVec :: MVec V e -> IO () Source #

class (Source r1 e, Shape sh) => Load r1 sh e where Source #

Compute all elements defined by an array and write them to a manifest target representation.

Note that instances require that the source array to have a delayed representation such as D or C. If you want to use a pre-existing manifest array as the source then delay it first.

Minimal complete definition

Methods

loadS :: Target r2 e => Array r1 sh e -> MVec r2 e -> IO () Source #

Fill an entire array sequentially.

loadP :: Target r2 e => Array r1 sh e -> MVec r2 e -> IO () Source #

Fill an entire array in parallel.

Instances

class (Source r1 e, Shape sh) => LoadRange r1 sh e where Source #

Compute a range of elements defined by an array and write them to a fillable representation.

Minimal complete definition

Methods

loadRangeS :: Target r2 e => Array r1 sh e -> MVec r2 e -> sh -> sh -> IO () Source #

Fill a range of an array sequentially.

loadRangeP :: Target r2 e => Array r1 sh e -> MVec r2 e -> sh -> sh -> IO () Source #

Fill a range of an array in parallel.

Instances

 Elt e => LoadRange D DIM2 e Source # Compute a range of elements in a rank-2 array. MethodsloadRangeS :: Target r2 e => Array D DIM2 e -> MVec r2 e -> DIM2 -> DIM2 -> IO () Source #loadRangeP :: Target r2 e => Array D DIM2 e -> MVec r2 e -> DIM2 -> DIM2 -> IO () Source # Elt e => LoadRange C DIM2 e Source # Compute a range of elements in a rank-2 array. MethodsloadRangeS :: Target r2 e => Array C DIM2 e -> MVec r2 e -> DIM2 -> DIM2 -> IO () Source #loadRangeP :: Target r2 e => Array C DIM2 e -> MVec r2 e -> DIM2 -> DIM2 -> IO () Source # (Shape sh, LoadRange r1 sh e) => LoadRange (S r1) sh e Source # MethodsloadRangeS :: Target r2 e => Array (S r1) sh e -> MVec r2 e -> sh -> sh -> IO () Source #loadRangeP :: Target r2 e => Array (S r1) sh e -> MVec r2 e -> sh -> sh -> IO () Source #

fromList :: (Shape sh, Target r e) => sh -> [e] -> Array r sh e Source #

O(n). Construct a manifest array from a list.

# Converting between representations

computeS :: (Load r1 sh e, Target r2 e) => Array r1 sh e -> Array r2 sh e Source #

Sequential computation of array elements.

computeP :: (Load r1 sh e, Target r2 e, Source r2 e, Monad m) => Array r1 sh e -> m (Array r2 sh e) Source #

Parallel computation of array elements.

• The source array must have a delayed representation like D, C or P, and the result a manifest representation like U or F.
• If you want to copy data between manifest representations then use copyP instead.
• If you want to convert a manifest array back to a delayed representation then use delay instead.

suspendedComputeP :: (Load r1 sh e, Target r2 e) => Array r1 sh e -> Array r2 sh e Source #

Suspended parallel computation of array elements.

This version creates a thunk that will evaluate the array on demand. If you force it when another parallel computation is already running then you will get a runtime warning and evaluation will be sequential. Use deepSeqArray and now to ensure that each array is evaluated before proceeding to the next one.

If unsure then just use the monadic version computeP. This one ensures that each array is fully evaluated before continuing.

copyS :: (Source r1 e, Load D sh e, Target r2 e) => Array r1 sh e -> Array r2 sh e Source #

Sequential copying of arrays.

copyP :: (Source r1 e, Source r2 e, Load D sh e, Target r2 e, Monad m) => Array r1 sh e -> m (Array r2 sh e) Source #

Parallel copying of arrays.

• This is a wrapper that delays an array before calling computeP.
• You can use it to copy manifest arrays between representations.

suspendedCopyP :: (Source r1 e, Load D sh e, Target r2 e) => Array r1 sh e -> Array r2 sh e Source #

Suspended parallel copy of array elements.

now :: (Shape sh, Source r e, Monad m) => Array r sh e -> m (Array r sh e) Source #

Monadic version of deepSeqArray.

Forces an suspended array computation to be completed at this point in a monadic computation.

 do  let arr2 = suspendedComputeP arr1
...
arr3 <- now \$ arr2
...


# Chunked filling

Arguments

 :: Int Number of elements. -> (Int -> a -> IO ()) Update function to write into result buffer. -> (Int -> a) Fn to get the value at a given index. -> IO ()

Fill something sequentially.

• The array is filled linearly from start to finish.

Arguments

 :: Int Number of elements. -> (Int -> a -> IO ()) Update function to write into result buffer. -> (Int -> a) Fn to get the value at a given index. -> IO ()

Fill something in parallel.

• The array is split into linear chunks, and each thread linearly fills one chunk.

Arguments

 :: Int Number of elements. -> (Int -> a -> IO ()) Update fn to write into result buffer. -> (Int -> IO (Int -> IO a)) Create a fn to get the value at a given index. The first Int is the thread number, so you can do some per-thread initialisation. -> IO ()

Fill something in parallel, using a separate IO action for each thread.

• The array is split into linear chunks, and each thread linearly fills one chunk.

# Interleaved filling

Arguments

 :: Int Number of elements. -> (Int -> a -> IO ()) Update function to write into result buffer. -> (Int -> a) Fn to get the value at a given index. -> IO ()

Fill something in parallel.

• The array is split into linear chunks and each thread fills one chunk.

# Blockwise filling

Arguments

 :: Elt a => (Int -> a -> IO ()) Update function to write into result buffer. -> (DIM2 -> a) Function to evaluate the element at an index. -> Int# Width of the whole array. -> Int# x0 lower left corner of block to fill -> Int# y0 -> Int# w0 width of block to fill. -> Int# h0 height of block to fill. -> IO ()

Fill a block in a rank-2 array in parallel.

• Blockwise filling can be more cache-efficient than linear filling for rank-2 arrays.
• Coordinates given are of the filled edges of the block.
• We divide the block into columns, and give one column to each thread.
• Each column is filled in row major order from top to bottom.

Arguments

 :: (Int -> a -> IO ()) Update function to write into result buffer. -> (DIM2 -> a) Fn to get the value at the given index. -> Int# Width of the whole array. -> Int# x0 lower left corner of block to fill. -> Int# y0 -> Int# w0 width of block to fill -> Int# h0 height of block to fill -> IO ()

Fill a block in a rank-2 array, sequentially.

• Blockwise filling can be more cache-efficient than linear filling for rank-2 arrays.
• The block is filled in row major order from top to bottom.

# Cursored blockwise filling

Arguments

 :: Elt a => (Int -> a -> IO ()) Update function to write into result buffer. -> (DIM2 -> cursor) Make a cursor to a particular element. -> (DIM2 -> cursor -> cursor) Shift the cursor by an offset. -> (cursor -> a) Function to evaluate an element at the given index. -> Int# Width of the whole array. -> Int# x0 lower left corner of block to fill. -> Int# y0 -> Int# w0 width of block to fill -> Int# h0 height of block to fill -> IO ()

Fill a block in a rank-2 array, sequentially.

• Blockwise filling can be more cache-efficient than linear filling for rank-2 arrays.
• Using cursor functions can help to expose inter-element indexing computations to the GHC and LLVM optimisers.
• Coordinates given are of the filled edges of the block.
• The block is filled in row major order from top to bottom.

Arguments

 :: Elt a => (Int -> a -> IO ()) Update function to write into result buffer. -> (DIM2 -> cursor) Make a cursor to a particular element. -> (DIM2 -> cursor -> cursor) Shift the cursor by an offset. -> (cursor -> a) Function to evaluate the element at an index. -> Int# Width of the whole array. -> Int# x0 lower left corner of block to fill -> Int# y0 -> Int# w0 width of block to fill -> Int# h0 height of block to fill -> IO ()

Fill a block in a rank-2 array in parallel.

• Blockwise filling can be more cache-efficient than linear filling for rank-2 arrays.
• Using cursor functions can help to expose inter-element indexing computations to the GHC and LLVM optimisers.
• Coordinates given are of the filled edges of the block.
• We divide the block into columns, and give one column to each thread.
• Each column is filled in row major order from top to bottom.

# Chunked selection

Arguments

 :: Shape sh => (sh -> a -> IO ()) Update function to write into result. -> (sh -> Bool) See if this predicate matches. -> (sh -> a) .. and apply fn to the matching index -> sh Extent of indices to apply to predicate. -> IO Int Number of elements written to destination array.

Select indices matching a predicate.

• This primitive can be useful for writing filtering functions.

Arguments

 :: Unbox a => (Int -> Bool) See if this predicate matches. -> (Int -> a) -> Int -> IO [IOVector a]

Select indices matching a predicate, in parallel.

• This primitive can be useful for writing filtering functions.
• The array is split into linear chunks, with one chunk being given to each thread.
• The number of elements in the result array depends on how many threads you're running the program with.