Get the size of a mutable array.

Since: 0.1.0

O(1) - Lookup an element in the mutable array. Returns Nothing when index is out of bounds.

Since: 0.1.0

O(1) - Same as read, but throws IndexOutOfBoundsException on an invalid index.

Since: 0.4.0

O(1) - Same as read, but throws IndexOutOfBoundsException on an invalid index.

Since: 0.1.0

O(1) - Write an element into the cell of a mutable array. Returns False when index is out of bounds.

Since: 0.1.0

O(1) - Write an element into the cell of a mutable array. Same as write function in case of an out of bounds index it is noop, but unlike write, there is no information is returned about was the writing of element successful or not. In other words, just like writeM, but doesn't throw an exception.

Since: 0.4.4

O(1) - Same as write, but throws IndexOutOfBoundsException on an invalid index.

Since: 0.4.0

O(1) - Same as write, but lives in IO and throws IndexOutOfBoundsException on invalid index.

Since: 0.1.0

O(1) - Modify an element in the cell of a mutable array with a supplied action. Returns the previous value, if index was not out of bounds.

Since: 0.1.0

O(1) - Same as modify, except that neither the previous value, nor any information on whether the modification was successful are returned. In other words, just like modifyM_, but doesn't throw an exception.

Since: 0.4.4

O(1) - Modify an element in the cell of a mutable array with a supplied action. Throws an IndexOutOfBoundsException exception for invalid index and returns the previous value otherwise.

Since: 0.4.0

O(1) - Same as modifyM, but discard the returned element

Examples

>>> :set -XTypeApplications
>>> import Control.Monad.ST
>>> import Data.Massiv.Array
>>> runST $ new @P @Ix1 @Int (Sz1 3) >>= (\ma -> modifyM_ ma (pure . (+10)) 1 >> freezeS ma)
Array P Seq (Sz1 3)
  [ 0, 10, 0 ]

Since: 0.4.0

O(1) - Same as modify, but throws an error if index is out of bounds.

Since: 0.1.0

O(1) - Same as swapM, but instead of throwing an exception returns Nothing when either one of the indices is out of bounds and Just elements under those indices otherwise.

Since: 0.1.0

O(1) - Same as swap, but instead of returning Nothing it does nothing. In other words, it is similar to swapM_, but does not throw any exceptions.

Since: 0.4.4

O(1) - Swap two elements in a mutable array under the supplied indices. Throws an IndexOutOfBoundsException when either one of the indices is out of bounds and elements under those indices otherwise.

Since: 0.4.0

O(1) - Same as swapM, but discard the returned elements

Since: 0.4.0

O(1) - Same as swap, but throws an IndexOutOfBoundsException on invalid indices.

Since: 0.1.0

O(n) - Initialize a new mutable array. All elements will be set to some default value. For boxed arrays in will be a thunk with Uninitialized exception, while for others it will be simply zeros.

Examples

>>> import Data.Massiv.Array
>>> marr <- new (Sz2 2 6) :: IO (MArray RealWorld P Ix2 Int)
>>> freeze Seq marr
Array P Seq (Sz (2 :. 6))
  [ [ 0, 0, 0, 0, 0, 0 ]
  , [ 0, 0, 0, 0, 0, 0 ]
  ]

>>> :set -XTypeApplications
>>> new @P @Ix2 @Int (Sz2 2 6) >>= freezeS
Array P Seq (Sz (2 :. 6))
  [ [ 0, 0, 0, 0, 0, 0 ]
  , [ 0, 0, 0, 0, 0, 0 ]
  ]
>>> new @B @_ @Int (Sz2 2 6) >>= (`readM` 1)
*** Exception: Uninitialized

Since: 0.1.0

O(n) - Make a mutable copy of a pure array. Keep in mind that both freeze and thaw trigger a copy of the full array.

Example

>>> import Data.Massiv.Array
>>> :set -XTypeApplications
>>> arr <- fromListsM @U @Ix2 @Double Par [[12,21],[13,31]]
>>> marr <- thaw arr
>>> modify marr (pure . (+ 10)) (1 :. 0)
Just 13.0
>>> freeze Par marr
Array U Par (Sz (2 :. 2))
  [ [ 12.0, 21.0 ]
  , [ 23.0, 31.0 ]
  ]

Since: 0.1.0

Same as thaw, but restrict computation to sequential only.

Example

>>> import Data.Massiv.Array
>>> :set -XOverloadedLists
>>> thawS @P @Ix1 @Double [1..10]
>>> marr <- thawS @P @Ix1 @Double [1..10]
>>> writeM marr 5 100
>>> freezeS marr
Array P Seq (Sz1 10)
  [ 1.0, 2.0, 3.0, 4.0, 5.0, 100.0, 7.0, 8.0, 9.0, 10.0 ]

Since: 0.3.0

O(n) - Yield an immutable copy of the mutable array. Note that mutable representations have to be the same.

Example

>>> import Data.Massiv.Array
>>> marr <- new @P @_ @Int (Sz2 2 6)
>>> forM_ (range Seq 0 (Ix2 1 4)) $ \ix -> write marr ix 9
>>> freeze Seq marr
Array P Seq (Sz (2 :. 6))
  [ [ 9, 9, 9, 9, 0, 0 ]
  , [ 0, 0, 0, 0, 0, 0 ]
  ]

Since: 0.1.0

Same as freeze, but do the copy of supplied muable array sequentially. Also, unlike freeze that has to be done in IO, freezeS can be used with ST.

Since: 0.3.0

Just like makeMArrayS, but also accepts computation strategy and runs in IO.

Since: 0.3.0

Just like makeMArrayLinearS, but also accepts computation strategy and runs in IO.

Since: 0.3.0

Create a mutable array using an index aware generating action.

Since: 0.3.0

Same as makeMArrayS, but index supplied to the action is row-major linear index.

Since: 0.3.0

Create a new array by supplying an action that will fill the new blank mutable array. Use createArray if you'd like to keep the result of the filling function.

Examples

>>> :set -XTypeApplications
>>> import Data.Massiv.Array
>>> createArray_ @P @_ @Int Seq (Sz1 2) (\ s marr -> scheduleWork s (writeM marr 0 10) >> scheduleWork s (writeM marr 1 11))
Array P Seq (Sz1 2)
  [ 10, 11 ]

Since: 0.3.0

Just like createArray_, but together with Array it returns results of scheduled filling actions.

Since: 0.3.0

Create a new array by supplying an action that will fill the new blank mutable array. Use createArrayS if you'd like to keep the result of the filling function.

Examples

>>> :set -XTypeApplications
>>> import Data.Massiv.Array
>>> createArrayS_ @P @_ @Int (Sz1 2) (\ marr -> write marr 0 10 >> write marr 1 12)
Array P Seq (Sz1 2)
  [ 10, 12 ]

Since: 0.3.0

Just like createArray_, but together with Array it returns the result of the filling action.

Since: 0.3.0

Just like createArrayS_, but restricted to ST.

Since: 0.3.0

Just like createArrayS, but restricted to ST.

Since: 0.2.6

Just like generateArrayS, except this generator will respect the supplied computation strategy, and for that reason it is restricted to IO.

Since: 0.2.6

Just like generateArray, except generating action will receive a row-major linear index.

Since: 0.3.0

Sequentially generate a pure array. Much like makeArray creates a pure array this function will use Mutable interface to generate a pure Array in the end, except that computation strategy is set to Seq. Element producing function no longer has to be pure but is a stateful action, becuase it is restricted to PrimMonad thus allows for sharing the state between computation of each element.

Examples

>>> import Data.Massiv.Array
>>> import Data.IORef
>>> ref <- newIORef (0 :: Int)
>>> generateArrayS (Sz1 6) (\ i -> modifyIORef' ref (+i) >> print i >> pure i) :: IO (Array U Ix1 Int)
0
1
2
3
4
5
Array U Seq (Sz1 6)
  [ 0, 1, 2, 3, 4, 5 ]
>>> readIORef ref
15

Since: 0.2.6

Same as generateArray but with action that accepts row-major linear index.

Since: 0.3.0

Use per worker thread state while generating elements of the array. Very useful for things that are not thread safe.

Since: 0.3.4

Same as generateArrayWS, but use linear indexing instead.

Since: 0.3.4

Sequentially unfold an array from the left.

Examples

>>> import Data.Massiv.Array
>>> unfoldrPrimM_ (Sz1 10) (\a@(f0, f1) -> let fn = f0 + f1 in print a >> return (f0, (f1, fn))) (0, 1) :: IO (Array P Ix1 Int)
(0,1)
(1,1)
(1,2)
(2,3)
(3,5)
(5,8)
(8,13)
(13,21)
(21,34)
(34,55)
Array P Seq (Sz1 10)
  [ 0, 1, 1, 2, 3, 5, 8, 13, 21, 34 ]

Since: 0.3.0

Same as unfoldrPrimM_ but do the unfolding with index aware function.

Since: 0.3.0

Just like iunfoldrPrimM, but do the unfolding with index aware function.

Since: 0.3.0

Just like iunfoldrPrimM_, but also returns the final value of the accumulator.

Since: 0.3.0

Sequentially unfold an array from the left.

Examples

>>> import Data.Massiv.Array
>>> unfoldlPrimM_ (Sz1 10) (\a@(f0, f1) -> let fn = f0 + f1 in print a >> return ((f1, fn), f0)) (0, 1) :: IO (Array P Ix1 Int)
(0,1)
(1,1)
(1,2)
(2,3)
(3,5)
(5,8)
(8,13)
(13,21)
(21,34)
(34,55)
Array P Seq (Sz1 10)
  [ 34, 21, 13, 8, 5, 3, 2, 1, 1, 0 ]

Since: 0.3.0

Same as unfoldlPrimM_ but do the unfolding with index aware function.

Since: 0.3.0

Just like iunfoldlPrimM, but do the unfolding with index aware function.

Since: 0.3.0

Just like iunfoldlPrimM_, but also returns the final value of the accumulator.

Since: 0.3.0

Sequentially loop over a mutable array while modifying each element with an action.

Since: 0.4.0

Sequentially loop over a mutable array while reading each element and applying an action to it. There is no mutation to the array, unless the action itself modifies it.

Since: 0.4.0

Sequentially loop over a mutable array while modifying each element with an index aware action.

Since: 0.4.0

Sequentially loop over a mutable array while reading each element and applying an index aware action to it. There is no mutation to the array, unless the action itself modifies it.

Since: 0.4.0

Sequentially loop over a mutable array while modifying each element with an index aware action.

Since: 0.4.0

Sequentially loop over a mutable array while reading each element and applying a linear index aware action to it. There is no mutation to the array, unless the action itself modifies it.

Since: 0.4.0

Same as withMArray_, but allows to keep artifacts of scheduled tasks.

Since: 0.5.0

Create a copy of a pure array, mutate it in place and return its frozen version. The big difference between withMArrayS is that it's not only gonna respect the computation strategy supplied to it while making a copy, but it will also pass extra argumens to the action that suppose to modify the mutable copy of the source array. These two extra arguments are:

• Number of capabilities derived from the Computation strategy of the array.
• An action that can be used to schedule arbitrary number of jobs that will be executed in parallel.
• And, of course, the mutable array itself.

Since: 0.5.0

Create a copy of a pure array, mutate it in place and return its frozen version. The important benefit over doing a manual thawS followed by a freezeS is that an array will only be copied once.

Since: 0.5.0

Same as withMArrayS, but discards rhe element produced by the supplied action

Since: 0.5.0

Same as withMArrayS but in ST. This is not only pure, but also the safest way to do mutation to the array.

Since: 0.5.0

Same as withMArrayS but in ST. This is not only pure, but also the safest way to do mutation to the array.

Since: 0.5.0

Initialize mutable array to some default value.

Since: 0.3.0

Create new mutable array while initializing all elements to some default value.

Since: 0.3.0

RealWorld is deeply magical. It is primitive, but it is not unlifted (hence ptrArg). We never manipulate values of type RealWorld; it's only used in the type system, to parameterise State#.

Compute an Array while loading the results into the supplied mutable target array. Number of elements for arrays must agree, otherwise SizeElementsMismatchException exception is thrown.

Since: 0.1.3

Load a pure array into the newly created mutable array, while respecting computation startegy.

Since: 0.3.0

Load sequentially a pure array into the newly created mutable array.

Since: 0.3.0