Unboxed vectors of primitive types.

Mutable vectors of primitive types.

O(1) Yield the length of the vector.

O(1) Test whether a vector is empty.

O(1) Indexing.

O(1) Safe indexing.

O(1) First element.

O(1) Last element.

O(1) Unsafe indexing without bounds checking.

O(1) First element, without checking if the vector is empty.

O(1) Last element, without checking if the vector is empty.

O(1) Indexing in a monad.

The monad allows operations to be strict in the vector when necessary. Suppose vector copying is implemented like this:

copy mv v = ... write mv i (v ! i) ...

For lazy vectors, v ! i would not be evaluated which means that mv would unnecessarily retain a reference to v in each element written.

With indexM, copying can be implemented like this instead:

copy mv v = ... do
                  x <- indexM v i
                  write mv i x

Here, no references to v are retained because indexing (but not the element) is evaluated eagerly.

O(1) First element of a vector in a monad. See indexM for an explanation of why this is useful.

O(1) Last element of a vector in a monad. See indexM for an explanation of why this is useful.

O(1) Indexing in a monad, without bounds checks. See indexM for an explanation of why this is useful.

O(1) First element in a monad, without checking for empty vectors. See indexM for an explanation of why this is useful.

O(1) Last element in a monad, without checking for empty vectors. See indexM for an explanation of why this is useful.

O(1) Yield a slice of the vector without copying it. The vector must contain at least i+n elements.

O(1) Yield all but the last element without copying. The vector may not be empty.

O(1) Yield all but the first element without copying. The vector may not be empty.

O(1) Yield at the first n elements without copying. The vector may contain less than n elements, in which case it is returned unchanged.

O(1) Yield all but the first n elements without copying. The vector may contain less than n elements, in which case an empty vector is returned.

O(1) Yield the first n elements paired with the remainder, without copying.

Note that splitAt n v is equivalent to (take n v, drop n v), but slightly more efficient.

Since: 0.7.1

O(1) Yield the head and tail of the vector, or Nothing if the vector is empty.

Since: 0.12.2.0

O(1) Yield the last and init of the vector, or Nothing if the vector is empty.

Since: 0.12.2.0

O(1) Yield a slice of the vector without copying. The vector must contain at least i+n elements, but this is not checked.

O(1) Yield all but the last element without copying. The vector may not be empty, but this is not checked.

O(1) Yield all but the first element without copying. The vector may not be empty, but this is not checked.

O(1) Yield the first n elements without copying. The vector must contain at least n elements, but this is not checked.

O(1) Yield all but the first n elements without copying. The vector must contain at least n elements, but this is not checked.

O(1) The empty vector.

O(1) A vector with exactly one element.

O(n) A vector of the given length with the same value in each position.

O(n) Construct a vector of the given length by applying the function to each index.

O(n) Apply the function \(\max(n - 1, 0)\) times to an initial value, producing a vector of length \(\max(n, 0)\). The 0th element will contain the initial value, which is why there is one less function application than the number of elements in the produced vector.

\( \underbrace{x, f (x), f (f (x)), \ldots}_{\max(0,n)\rm{~elements}} \)

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.iterateN 0 undefined undefined :: VP.Vector Int
[]
>>> VP.iterateN 26 succ 'a'
"abcdefghijklmnopqrstuvwxyz"

Since: 0.7.1

O(n) Execute the monadic action the given number of times and store the results in a vector.

O(n) Construct a vector of the given length by applying the monadic action to each index.

O(n) Apply the monadic function \(\max(n - 1, 0)\) times to an initial value, producing a vector of length \(\max(n, 0)\). The 0th element will contain the initial value, which is why there is one less function application than the number of elements in the produced vector.

For a non-monadic version, see iterateN.

Since: 0.12.0.0

Execute the monadic action and freeze the resulting vector.

create (do { v <- new 2; write v 0 'a'; write v 1 'b'; return v }) = <a,b>

Execute the monadic action and freeze the resulting vectors.

O(n) Construct a vector by repeatedly applying the generator function to a seed. The generator function yields Just the next element and the new seed or Nothing if there are no more elements.

unfoldr (\n -> if n == 0 then Nothing else Just (n,n-1)) 10
 = <10,9,8,7,6,5,4,3,2,1>

O(n) Construct a vector with at most n elements by repeatedly applying the generator function to a seed. The generator function yields Just the next element and the new seed or Nothing if there are no more elements.

unfoldrN 3 (\n -> Just (n,n-1)) 10 = <10,9,8>

O(n) Construct a vector with exactly n elements by repeatedly applying the generator function to a seed. The generator function yields the next element and the new seed.

unfoldrExactN 3 (\n -> (n,n-1)) 10 = <10,9,8>

Since: 0.12.2.0

O(n) Construct a vector by repeatedly applying the monadic generator function to a seed. The generator function yields Just the next element and the new seed or Nothing if there are no more elements.

O(n) Construct a vector by repeatedly applying the monadic generator function to a seed. The generator function yields Just the next element and the new seed or Nothing if there are no more elements.

O(n) Construct a vector with exactly n elements by repeatedly applying the monadic generator function to a seed. The generator function yields the next element and the new seed.

Since: 0.12.2.0

O(n) Construct a vector with n elements by repeatedly applying the generator function to the already constructed part of the vector.

constructN 3 f = let a = f <> ; b = f <a> ; c = f <a,b> in <a,b,c>

O(n) Construct a vector with n elements from right to left by repeatedly applying the generator function to the already constructed part of the vector.

constructrN 3 f = let a = f <> ; b = f<a> ; c = f <b,a> in <c,b,a>

O(n) Yield a vector of the given length, containing the values x, x+1 etc. This operation is usually more efficient than enumFromTo.

enumFromN 5 3 = <5,6,7>

O(n) Yield a vector of the given length, containing the values x, x+y, x+y+y etc. This operations is usually more efficient than enumFromThenTo.

enumFromStepN 1 2 5 = <1,3,5,7,9>

O(n) Enumerate values from x to y.

WARNING: This operation can be very inefficient. If possible, use enumFromN instead.

O(n) Enumerate values from x to y with a specific step z.

WARNING: This operation can be very inefficient. If possible, use enumFromStepN instead.

O(n) Prepend an element.

O(n) Append an element.

O(m+n) Concatenate two vectors.

O(n) Concatenate all vectors in the list.

O(n) Yield the argument, but force it not to retain any extra memory, possibly by copying it.

This is especially useful when dealing with slices. For example:

force (slice 0 2 <huge vector>)

Here, the slice retains a reference to the huge vector. Forcing it creates a copy of just the elements that belong to the slice and allows the huge vector to be garbage collected.

O(m+n) For each pair (i,a) from the list of index/value pairs, replace the vector element at position i by a.

<5,9,2,7> // [(2,1),(0,3),(2,8)] = <3,9,8,7>

O(m+min(n1,n2)) For each index i from the index vector and the corresponding value a from the value vector, replace the element of the initial vector at position i by a.

update_ <5,9,2,7>  <2,0,2> <1,3,8> = <3,9,8,7>

Same as (//), but without bounds checking.

Same as update_, but without bounds checking.

O(m+n) For each pair (i,b) from the list, replace the vector element a at position i by f a b.

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.accum (+) (VP.fromList [1000,2000,3000 :: Int]) [(2,4),(1,6),(0,3),(1,10)]
[1003,2016,3004]

O(m+min(n1,n2)) For each index i from the index vector and the corresponding value b from the the value vector, replace the element of the initial vector at position i by f a b.

accumulate_ (+) <5,9,2> <2,1,0,1> <4,6,3,7> = <5+3, 9+6+7, 2+4>

Same as accum, but without bounds checking.

Same as accumulate_, but without bounds checking.

O(n) Reverse a vector.

O(n) Yield the vector obtained by replacing each element i of the index vector by xs!i. This is equivalent to map (xs!) is, but is often much more efficient.

backpermute <a,b,c,d> <0,3,2,3,1,0> = <a,d,c,d,b,a>

Same as backpermute, but without bounds checking.

Apply a destructive operation to a vector. The operation may be performed in place if it is safe to do so and will modify a copy of the vector otherwise (see New for details).

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> import qualified Data.Vector.Primitive.Mutable as MVP
>>> VP.modify (\v -> MVP.write v 0 'x') $ VP.replicate 4 'a'
"xaaa"

O(n) Map a function over a vector.

O(n) Apply a function to every element of a vector and its index.

Map a function over a vector and concatenate the results.

O(n) Apply the monadic action to all elements of the vector, yielding a vector of results.

O(n) Apply the monadic action to every element of a vector and its index, yielding a vector of results.

Since: 0.12.2.0

O(n) Apply the monadic action to all elements of a vector and ignore the results.

O(n) Apply the monadic action to every element of a vector and its index, ignoring the results.

Since: 0.12.2.0

O(n) Apply the monadic action to all elements of the vector, yielding a vector of results. Equivalent to flip mapM.

O(n) Apply the monadic action to all elements of a vector and ignore the results. Equivalent to flip mapM_.

O(n) Apply the monadic action to all elements of the vector and their indices, yielding a vector of results. Equivalent to flip imapM.

Since: 0.12.2.0

O(n) Apply the monadic action to all elements of the vector and their indices and ignore the results. Equivalent to flip imapM_.

Since: 0.12.2.0

O(min(m,n)) Zip two vectors with the given function.

Zip three vectors with the given function.

O(min(m,n)) Zip two vectors with a function that also takes the elements' indices.

Zip three vectors and their indices with the given function.

O(min(m,n)) Zip the two vectors with the monadic action and yield a vector of results.

O(min(m,n)) Zip the two vectors with a monadic action that also takes the element index and yield a vector of results.

Since: 0.12.2.0

O(min(m,n)) Zip the two vectors with the monadic action and ignore the results.

O(min(m,n)) Zip the two vectors with a monadic action that also takes the element index and ignore the results.

Since: 0.12.2.0

O(n) Drop all elements that do not satisfy the predicate.

O(n) Drop all elements that do not satisfy the predicate which is applied to the values and their indices.

O(n) Drop all elements that do not satisfy the monadic predicate.

O(n) Drop repeated adjacent elements. The first element in each group is returned.

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.uniq $ VP.fromList [1,3,3,200,3 :: Int]
[1,3,200,3]

O(n) Map the values and collect the Just results.

O(n) Map the indices/values and collect the Just results.

O(n) Apply the monadic function to each element of the vector and discard elements returning Nothing.

Since: 0.12.2.0

O(n) Apply the monadic function to each element of the vector and its index. Discard elements returning Nothing.

Since: 0.12.2.0

O(n) Yield the longest prefix of elements satisfying the predicate. The current implementation is not copy-free, unless the result vector is fused away.

O(n) Drop the longest prefix of elements that satisfy the predicate without copying.

O(n) Split the vector in two parts, the first one containing those elements that satisfy the predicate and the second one those that don't. The relative order of the elements is preserved at the cost of a sometimes reduced performance compared to unstablePartition.

O(n) Split the vector in two parts, the first one containing those elements that satisfy the predicate and the second one those that don't. The order of the elements is not preserved, but the operation is often faster than partition.

O(n) Split the vector into two parts, the first one containing the Left elements and the second containing the Right elements. The relative order of the elements is preserved.

Since: 0.12.1.0

O(n) Split the vector into the longest prefix of elements that satisfy the predicate and the rest without copying.

O(n) Split the vector into the longest prefix of elements that do not satisfy the predicate and the rest without copying.

O(n) Split a vector into a list of slices, using a predicate function.

The concatenation of this list of slices is equal to the argument vector, and each slice contains only equal elements, as determined by the equality predicate function.

Does not fuse.

>>> import qualified Data.Vector.Primitive as VP
>>> import           Data.Char (isUpper)
>>> VP.groupBy (\a b -> isUpper a == isUpper b) (VP.fromList "Mississippi River")
["M","ississippi ","R","iver"]

See also groupBy, group.

Since: 0.13.0.1

O(n) Split a vector into a list of slices of the input vector.

The concatenation of this list of slices is equal to the argument vector, and each slice contains only equal elements.

Does not fuse.

This is the equivalent of 'groupBy (==)'.

>>> import qualified Data.Vector.Primitive as VP
>>> VP.group (VP.fromList "Mississippi")
["M","i","ss","i","ss","i","pp","i"]

See also group.

Since: 0.13.0.1

O(n) Check if the vector contains an element.

O(n) Check if the vector does not contain an element (inverse of elem).

O(n) Yield Just the first element matching the predicate or Nothing if no such element exists.

O(n) Yield Just the index of the first element matching the predicate or Nothing if no such element exists.

O(n) Yield Just the index of the last element matching the predicate or Nothing if no such element exists.

Does not fuse.

O(n) Yield the indices of elements satisfying the predicate in ascending order.

O(n) Yield Just the index of the first occurrence of the given element or Nothing if the vector does not contain the element. This is a specialised version of findIndex.

O(n) Yield the indices of all occurrences of the given element in ascending order. This is a specialised version of findIndices.

O(n) Left fold.

O(n) Left fold on non-empty vectors.

O(n) Left fold with strict accumulator.

O(n) Left fold on non-empty vectors with strict accumulator.

O(n) Right fold.

O(n) Right fold on non-empty vectors.

O(n) Right fold with a strict accumulator.

O(n) Right fold on non-empty vectors with strict accumulator.

O(n) Left fold using a function applied to each element and its index.

O(n) Left fold with strict accumulator using a function applied to each element and its index.

O(n) Right fold using a function applied to each element and its index.

O(n) Right fold with strict accumulator using a function applied to each element and its index.

O(n) Map each element of the structure to a monoid and combine the results. It uses the same implementation as the corresponding method of the Foldable type cless. Note that it's implemented in terms of foldr and won't fuse with functions that traverse the vector from left to right (map, generate, etc.).

Since: 0.12.2.0

O(n) Like foldMap, but strict in the accumulator. It uses the same implementation as the corresponding method of the Foldable type class. Note that it's implemented in terms of foldl', so it fuses in most contexts.

Since: 0.12.2.0

O(n) Check if all elements satisfy the predicate.

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.all even $ VP.fromList [2, 4, 12 :: Int]
True
>>> VP.all even $ VP.fromList [2, 4, 13 :: Int]
False
>>> VP.all even (VP.empty :: VP.Vector Int)
True

O(n) Check if any element satisfies the predicate.

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.any even $ VP.fromList [1, 3, 7 :: Int]
False
>>> VP.any even $ VP.fromList [3, 2, 13 :: Int]
True
>>> VP.any even (VP.empty :: VP.Vector Int)
False

O(n) Compute the sum of the elements.

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.sum $ VP.fromList [300,20,1 :: Int]
321
>>> VP.sum (VP.empty :: VP.Vector Int)
0

O(n) Compute the product of the elements.

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.product $ VP.fromList [1,2,3,4 :: Int]
24
>>> VP.product (VP.empty :: VP.Vector Int)
1

O(n) Yield the maximum element of the vector. The vector may not be empty. In case of a tie, the first occurrence wins.

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.maximum $ VP.fromList [2, 1 :: Int]
2

O(n) Yield the maximum element of the vector according to the given comparison function. The vector may not be empty. In case of a tie, the first occurrence wins. This behavior is different from maximumBy which returns the last tie.

O(n) Yield the maximum element of the vector by comparing the results of a key function on each element. In case of a tie, the first occurrence wins. The vector may not be empty.

Since: 0.13.0.0

O(n) Yield the minimum element of the vector. The vector may not be empty. In case of a tie, the first occurrence wins.

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.minimum $ VP.fromList [2, 1 :: Int]
1

O(n) Yield the minimum element of the vector according to the given comparison function. The vector may not be empty. In case of a tie, the first occurrence wins.

O(n) Yield the minimum element of the vector by comparing the results of a key function on each element. In case of a tie, the first occurrence wins. The vector may not be empty.

Since: 0.13.0.0

O(n) Yield the index of the minimum element of the vector. The vector may not be empty.

O(n) Yield the index of the minimum element of the vector according to the given comparison function. The vector may not be empty.

O(n) Yield the index of the maximum element of the vector. The vector may not be empty.

O(n) Yield the index of the maximum element of the vector according to the given comparison function. The vector may not be empty. In case of a tie, the first occurrence wins.

O(n) Monadic fold.

O(n) Monadic fold using a function applied to each element and its index.

Since: 0.12.2.0

O(n) Monadic fold with strict accumulator.

O(n) Monadic fold with strict accumulator using a function applied to each element and its index.

Since: 0.12.2.0

O(n) Monadic fold over non-empty vectors.

O(n) Monadic fold over non-empty vectors with strict accumulator.

O(n) Monadic fold that discards the result.

O(n) Monadic fold that discards the result using a function applied to each element and its index.

Since: 0.12.2.0

O(n) Monadic fold with strict accumulator that discards the result.

O(n) Monadic fold with strict accumulator that discards the result using a function applied to each element and its index.

Since: 0.12.2.0

O(n) Monadic fold over non-empty vectors that discards the result.

O(n) Monadic fold over non-empty vectors with strict accumulator that discards the result.

O(n) Left-to-right prescan.

prescanl f z = init . scanl f z

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.prescanl (+) 0 (VP.fromList [1,2,3,4 :: Int])
[0,1,3,6]

O(n) Left-to-right prescan with strict accumulator.

O(n) Left-to-right postscan.

postscanl f z = tail . scanl f z

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.postscanl (+) 0 (VP.fromList [1,2,3,4 :: Int])
[1,3,6,10]

O(n) Left-to-right postscan with strict accumulator.

O(n) Left-to-right scan.

scanl f z <x1,...,xn> = <y1,...,y(n+1)>
  where y1 = z
        yi = f y(i-1) x(i-1)

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.scanl (+) 0 (VP.fromList [1,2,3,4 :: Int])
[0,1,3,6,10]

O(n) Left-to-right scan with strict accumulator.

O(n) Initial-value free left-to-right scan over a vector.

scanl f <x1,...,xn> = <y1,...,yn>
  where y1 = x1
        yi = f y(i-1) xi

Note: Since 0.13, application of this to an empty vector no longer results in an error; instead it produces an empty vector.

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.scanl1 min $ VP.fromListN 5 [4,2,4,1,3 :: Int]
[4,2,2,1,1]
>>> VP.scanl1 max $ VP.fromListN 5 [1,3,2,5,4 :: Int]
[1,3,3,5,5]
>>> VP.scanl1 min (VP.empty :: VP.Vector Int)
[]

O(n) Initial-value free left-to-right scan over a vector with a strict accumulator.

Note: Since 0.13, application of this to an empty vector no longer results in an error; instead it produces an empty vector.

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.scanl1' min $ VP.fromListN 5 [4,2,4,1,3 :: Int]
[4,2,2,1,1]
>>> VP.scanl1' max $ VP.fromListN 5 [1,3,2,5,4 :: Int]
[1,3,3,5,5]
>>> VP.scanl1' min (VP.empty :: VP.Vector Int)
[]

O(n) Left-to-right scan over a vector with its index.

Since: 0.12.2.0

O(n) Left-to-right scan over a vector (strictly) with its index.

Since: 0.12.2.0

O(n) Right-to-left prescan.

prescanr f z = reverse . prescanl (flip f) z . reverse

O(n) Right-to-left prescan with strict accumulator.

O(n) Right-to-left postscan.

O(n) Right-to-left postscan with strict accumulator.

O(n) Right-to-left scan.

O(n) Right-to-left scan with strict accumulator.

O(n) Right-to-left, initial-value free scan over a vector.

Note: Since 0.13, application of this to an empty vector no longer results in an error; instead it produces an empty vector.

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.scanr1 min $ VP.fromListN 5 [3,1,4,2,4 :: Int]
[1,1,2,2,4]
>>> VP.scanr1 max $ VP.fromListN 5 [4,5,2,3,1 :: Int]
[5,5,3,3,1]
>>> VP.scanr1 min (VP.empty :: VP.Vector Int)
[]

O(n) Right-to-left, initial-value free scan over a vector with a strict accumulator.

Note: Since 0.13, application of this to an empty vector no longer results in an error; instead it produces an empty vector.

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.scanr1' min $ VP.fromListN 5 [3,1,4,2,4 :: Int]
[1,1,2,2,4]
>>> VP.scanr1' max $ VP.fromListN 5 [4,5,2,3,1 :: Int]
[5,5,3,3,1]
>>> VP.scanr1' min (VP.empty :: VP.Vector Int)
[]

O(n) Right-to-left scan over a vector with its index.

Since: 0.12.2.0

O(n) Right-to-left scan over a vector (strictly) with its index.

Since: 0.12.2.0

O(n) Check if two vectors are equal using the supplied equality predicate.

Since: 0.12.2.0

O(n) Compare two vectors using the supplied comparison function for vector elements. Comparison works the same as for lists.

cmpBy compare == compare

Since: 0.12.2.0

O(n) Convert a vector to a list.

O(n) Convert a list to a vector.

O(n) Convert the first n elements of a list to a vector. It's expected that the supplied list will be exactly n elements long. As an optimization, this function allocates a buffer for n elements, which could be used for DoS-attacks by exhausting the memory if an attacker controls that parameter.

fromListN n xs = fromList (take n xs)

Examples

>>> import qualified Data.Vector.Primitive as VP
>>> VP.fromListN 3 [1,2,3,4,5 :: Int]
[1,2,3]
>>> VP.fromListN 3 [1 :: Int]
[1]

O(n) Convert between different vector types.

O(1) Unsafely cast a vector from one element type to another. This operation just changes the type of the vector and does not modify the elements.

This function will throw an error if elements are of mismatching sizes.

| @since 0.13.0.0

O(1) Unsafely coerce an immutable vector from one element type to another, representationally equal type. The operation just changes the type of the underlying pointer and does not modify the elements.

This is marginally safer than unsafeCast, since this function imposes an extra Coercible constraint. The constraint guarantees that the element types are representationally equal. It however cannot guarantee that their respective Prim instances are compatible.

O(n) Yield an immutable copy of the mutable vector.

O(n) Yield a mutable copy of an immutable vector.

O(n) Copy an immutable vector into a mutable one. The two vectors must have the same length.

O(1) Unsafely convert a mutable vector to an immutable one without copying. The mutable vector may not be used after this operation.

O(1) Unsafely convert an immutable vector to a mutable one without copying. Note that this is a very dangerous function and generally it's only safe to read from the resulting vector. In this case, the immutable vector could be used safely as well.

Problems with mutation happen because GHC has a lot of freedom to introduce sharing. As a result mutable vectors produced by unsafeThaw may or may not share the same underlying buffer. For example:

foo = do
  let vec = V.generate 10 id
  mvec <- V.unsafeThaw vec
  do_something mvec

Here GHC could lift vec outside of foo which means that all calls to do_something will use same buffer with possibly disastrous results. Whether such aliasing happens or not depends on the program in question, optimization levels, and GHC flags.

All in all, attempts to modify a vector produced by unsafeThaw fall out of domain of software engineering and into realm of black magic, dark rituals, and unspeakable horrors. The only advice that could be given is: "Don't attempt to mutate a vector produced by unsafeThaw unless you know how to prevent GHC from aliasing buffers accidentally. We don't."

O(n) Copy an immutable vector into a mutable one. The two vectors must have the same length. This is not checked.

Class of types supporting primitive array operations. This includes interfacing with GC-managed memory (functions suffixed with ByteArray#) and interfacing with unmanaged memory (functions suffixed with Addr#). Endianness is platform-dependent.