Numeric.Dimensions.Traverse.ST

Map a function over all dimensions provided dimension indices or offsets. This module provides a variant of traversal that lives in ST monad.

Documentation

overDim

Arguments

:: Dim (ds :: [Nat])

-> (Idx ds -> Int# -> a -> ST s a)

function to map over each dimension

-> Int#

Initial offset

-> Int#

offset step

-> a

-> ST s a

Traverse over all dimensions keeping track of index and offset

overDim_

Arguments

:: Dim (ds :: [Nat])

-> (Idx ds -> Int# -> ST s ())

function to map over each dimension

-> Int#

Initial offset

-> Int#

offset step

-> ST s ()

Same as overDim#, but with no return value

overDimIdx :: Dim (ds :: [Nat]) -> (Idx ds -> a -> ST s a) -> a -> ST s a

Traverse over all dimensions keeping track of indices

overDimIdx_ :: Dim (ds :: [Nat]) -> (Idx ds -> ST s ()) -> ST s ()

Traverse over all dimensions keeping track of indices, with no return value

overDimOff

Arguments

:: Dim (ds :: [Nat])

-> (Idx ds -> Int# -> a -> ST s a)

function to map over each dimension

-> Int#

Initial offset

-> Int#

offset step

-> a

-> ST s a

Traverse over all dimensions keeping track of total offset

overDimOff_

Arguments

:: Dim (ds :: [Nat])

-> (Int# -> ST s ())

function to map over each dimension

-> Int#

Initial offset

-> Int#

offset step

-> ST s ()

Traverse over all dimensions keeping track of total offset, with not return value

overDimPart

Arguments

:: forall (ds :: [Nat]). Dimensions ds

=> Idx ds

-> Idx ds

-> (Idx ds -> Int# -> a -> ST s a)

function to map over each dimension

-> Int#

Initial offset

-> Int#

offset step

-> a

-> ST s a

Traverse from the first index to the second index in each dimension. Indices must be within Dim range, which is not checked. You can combine positive and negative traversal directions along different dimensions.

foldDim

Arguments

:: Dim (ds :: [Nat])

-> (Idx ds -> Int# -> a -> a)

function to map over each dimension

-> Int#

Initial offset

-> Int#

offset step

-> a

-> a

Fold over all dimensions keeping track of index and offset

foldDimIdx :: Dim (ds :: [Nat]) -> (Idx ds -> a -> a) -> a -> a

Fold all dimensions keeping track of indices

foldDimOff

Arguments

:: Dim (ds :: [Nat])

-> (Int# -> a -> a)

function to map over each dimension

-> Int#

Initial offset

-> Int#

offset step

-> a

-> a

Fold over all dimensions keeping track of total offset