Numeric.Dimensions.Fold

Fold a function over all dimensions provided dimension indices or offsets. The main purpose of this module is to fold or traverse flat data arrays following the shape of dimensions associated with them.

Documentation

overDim

Arguments

:: Monad m

=> Dims ds

Shape of a space

-> (Idxs ds -> Int -> a -> m a)

Function to call on each dimension

-> Int

Initial offset

-> Int

Offset step

-> a

Initial value

-> m a

Go over all dimensions keeping track of index and offset

overDim_

Arguments

:: Monad m

=> Dims ds

Shape of a space

-> (Idxs ds -> Int -> m ())

Function to call on each dimension

-> Int

Initial offset

-> Int

Offset step

-> m ()

Go over all dimensions keeping track of index and offset

overDimIdx

Arguments

:: Monad m

=> Dims ds

Shape of a space

-> (Idxs ds -> a -> m a)

Function to call on each dimension

-> a

Initial value

-> m a

Go over all dimensions keeping track of index

overDimIdx_

Arguments

:: Monad m

=> Dims ds

Shape of a space

-> (Idxs ds -> m ())

Function to call on each dimension

-> m ()

Go over all dimensions keeping track of index

overDimOff

Arguments

:: Monad m

=> Dims ds

Shape of a space

-> (Int -> a -> m a)

Function to call with each offset value

-> Int

Initial offset

-> Int

Offset step

-> a

Initial value

-> m a

Go over all dimensions keeping track of total offset

overDimOff_

Arguments

:: Monad m

=> Dims ds

Shape of a space

-> (Int -> m ())

Function to call with each offset value

-> Int

Initial offset

-> Int

Offset step

-> m ()

Go over all dimensions keeping track of total offset

overDimReverse

Arguments

:: Monad m

=> Dims ds

Shape of a space

-> (Idxs ds -> Int -> a -> m a)

Function to call on each dimension

-> Int

Initial offset

-> Int

Offset step (substracted from initial offset)

-> a

Initial value

-> m a

Go over all dimensions in reverse order keeping track of index and offset

overDimReverseIdx

Arguments

:: Monad m

=> Dims ds

Shape of a space

-> (Idxs ds -> a -> m a)

Function to call on each dimension

-> a

Initial value

-> m a

Go over all dimensions in reverse order keeping track of index

foldDim

Arguments

:: Dims ds

Shape of a space

-> (Idxs ds -> Int -> a -> a)

Function to call on each dimension

-> Int

Initial offset

-> Int

Offset step

-> a

Initial value

-> a

Fold over all dimensions keeping track of index and offset

foldDimIdx

Arguments

:: Dims ds

Shape of a space

-> (Idxs ds -> a -> a)

Function to call on each dimension

-> a

Initial value

-> a

Fold over all dimensions keeping track of index

foldDimOff

Arguments

:: Dims ds

Shape of a space

-> (Int -> a -> a)

Function to call on each dimension

-> Int

Initial offset

-> Int

Offset step

-> a

Initial value

-> a

Fold over all dimensions keeping track of total offset

foldDimReverse

Arguments

:: Dims ds

Shape of a space

-> (Idxs ds -> Int -> a -> a)

Function to call on each dimension

-> Int

Initial offset

-> Int

Offset step (substracted from initial offset)

-> a

Initial value

-> a

Fold over all dimensions in reverse order keeping track of index and offset

foldDimReverseIdx

Arguments

:: Dims ds

Shape of a space

-> (Idxs ds -> a -> a)

Function to call on each dimension

-> a

Initial value

-> a

Fold over all dimensions in reverse order keeping track of index

overDimPart

Arguments

:: (Dimensions ds, Monad m)

=> Idxs ds

Initial indices

-> Idxs ds

Final indices

-> (Idxs ds -> Int -> a -> m a)

Function to call on each dimension

-> Int

Initial offset (at index minBound :: Idxs ds) Note, this is not an offset value at initial indices.

-> Int

Offset step

-> a

initial value

-> m a

Traverse from the first index to the second index in each dimension. You can combine positive and negative traversal directions along different dimensions.

Note, initial and final indices are included in the range; the argument function is guaranteed to execute at least once.

overDimPartIdx

Arguments

:: Monad m

=> Idxs ds

Initial indices

-> Idxs ds

Final indices

-> (Idxs ds -> a -> m a)

Function to call on each dimension

-> a

initial value

-> m a

Traverse from the first index to the second index in each dimension. You can combine positive and negative traversal directions along different dimensions.

Note, initial and final indices are included in the range; the argument function is guaranteed to execute at least once.