vector-0.6.0.1: Efficient ArraysSource codeContentsIndex
Data.Vector.Unboxed
Portabilitynon-portable
Stabilityexperimental
MaintainerRoman Leshchinskiy <rl@cse.unsw.edu.au>
Contents
Unboxed vectors
Accessors
Length information
Indexing
Monadic indexing
Extracting subvectors (slicing)
Construction
Initialisation
Monadic initialisation
Unfolding
Enumeration
Concatenation
Restricting memory usage
Modifying vectors
Bulk updates
Accumulations
Permutations
Safe destructive updates
Elementwise operations
Mapping
Monadic mapping
Zipping
Monadic zipping
Unzipping
Working with predicates
Filtering
Partitioning
Searching
Folding
Specialised folds
Monadic folds
Prefix sums (scans)
Conversions
Lists
Mutable vectors
Description

Adaptive unboxed vectors. The implementation is based on type families and picks an efficient, specialised representation for every element type. In particular, unboxed vectors of pairs are represented as pairs of unboxed vectors.

Implementing unboxed vectors for new data types can be very easy. Here is how the library does this for Complex by simply wrapping vectors of pairs.

 newtype instance MVector s (Complex a) = MV_Complex (MVector s (a,a))
 newtype instance Vector    (Complex a) = V_Complex  (Vector    (a,a))

instance (RealFloat a, Unbox a) => Data.Vector.Generic.Mutable.MVector MVector (Complex a) where
   {-# INLINE basicLength #-}
   basicLength (MV_Complex v) = Data.Vector.Generic.Mutable.basicLength v
   ...

instance (RealFloat a, Unbox a) => Data.Vector.Generic.Vector Vector (Complex a) where
   {-# INLINE basicLength #-}
   basicLength (V_Complex v) = Data.Vector.Generic.basicLength v
   ...

instance (RealFloat a, Unbox a) => Unbox (Complex a)
Synopsis
data family Vector a
data family MVector s a
class (Vector Vector a, MVector MVector a) => Unbox a
length :: Unbox a => Vector a -> Int
null :: Unbox a => Vector a -> Bool
(!) :: Unbox a => Vector a -> Int -> a
head :: Unbox a => Vector a -> a
last :: Unbox a => Vector a -> a
unsafeIndex :: Unbox a => Vector a -> Int -> a
unsafeHead :: Unbox a => Vector a -> a
unsafeLast :: Unbox a => Vector a -> a
indexM :: (Unbox a, Monad m) => Vector a -> Int -> m a
headM :: (Unbox a, Monad m) => Vector a -> m a
lastM :: (Unbox a, Monad m) => Vector a -> m a
unsafeIndexM :: (Unbox a, Monad m) => Vector a -> Int -> m a
unsafeHeadM :: (Unbox a, Monad m) => Vector a -> m a
unsafeLastM :: (Unbox a, Monad m) => Vector a -> m a
slice :: Unbox a => Int -> Int -> Vector a -> Vector a
init :: Unbox a => Vector a -> Vector a
tail :: Unbox a => Vector a -> Vector a
take :: Unbox a => Int -> Vector a -> Vector a
drop :: Unbox a => Int -> Vector a -> Vector a
unsafeSlice :: Unbox a => Int -> Int -> Vector a -> Vector a
unsafeInit :: Unbox a => Vector a -> Vector a
unsafeTail :: Unbox a => Vector a -> Vector a
unsafeTake :: Unbox a => Int -> Vector a -> Vector a
unsafeDrop :: Unbox a => Int -> Vector a -> Vector a
empty :: Unbox a => Vector a
singleton :: Unbox a => a -> Vector a
replicate :: Unbox a => Int -> a -> Vector a
generate :: Unbox a => Int -> (Int -> a) -> Vector a
replicateM :: (Monad m, Unbox a) => Int -> m a -> m (Vector a)
create :: Unbox a => (forall s. ST s (MVector s a)) -> Vector a
unfoldr :: Unbox a => (b -> Maybe (a, b)) -> b -> Vector a
unfoldrN :: Unbox a => Int -> (b -> Maybe (a, b)) -> b -> Vector a
enumFromN :: (Unbox a, Num a) => a -> Int -> Vector a
enumFromStepN :: (Unbox a, Num a) => a -> a -> Int -> Vector a
enumFromTo :: (Unbox a, Enum a) => a -> a -> Vector a
enumFromThenTo :: (Unbox a, Enum a) => a -> a -> a -> Vector a
cons :: Unbox a => a -> Vector a -> Vector a
snoc :: Unbox a => Vector a -> a -> Vector a
(++) :: Unbox a => Vector a -> Vector a -> Vector a
force :: Unbox a => Vector a -> Vector a
(//) :: Unbox a => Vector a -> [(Int, a)] -> Vector a
update :: Unbox a => Vector a -> Vector (Int, a) -> Vector a
update_ :: Unbox a => Vector a -> Vector Int -> Vector a -> Vector a
unsafeUpd :: Unbox a => Vector a -> [(Int, a)] -> Vector a
unsafeUpdate :: Unbox a => Vector a -> Vector (Int, a) -> Vector a
unsafeUpdate_ :: Unbox a => Vector a -> Vector Int -> Vector a -> Vector a
accum :: Unbox a => (a -> b -> a) -> Vector a -> [(Int, b)] -> Vector a
accumulate :: (Unbox a, Unbox b) => (a -> b -> a) -> Vector a -> Vector (Int, b) -> Vector a
accumulate_ :: (Unbox a, Unbox b) => (a -> b -> a) -> Vector a -> Vector Int -> Vector b -> Vector a
unsafeAccum :: Unbox a => (a -> b -> a) -> Vector a -> [(Int, b)] -> Vector a
unsafeAccumulate :: (Unbox a, Unbox b) => (a -> b -> a) -> Vector a -> Vector (Int, b) -> Vector a
unsafeAccumulate_ :: (Unbox a, Unbox b) => (a -> b -> a) -> Vector a -> Vector Int -> Vector b -> Vector a
reverse :: Unbox a => Vector a -> Vector a
backpermute :: Unbox a => Vector a -> Vector Int -> Vector a
unsafeBackpermute :: Unbox a => Vector a -> Vector Int -> Vector a
modify :: Unbox a => (forall s. MVector s a -> ST s ()) -> Vector a -> Vector a
map :: (Unbox a, Unbox b) => (a -> b) -> Vector a -> Vector b
imap :: (Unbox a, Unbox b) => (Int -> a -> b) -> Vector a -> Vector b
concatMap :: (Unbox a, Unbox b) => (a -> Vector b) -> Vector a -> Vector b
mapM :: (Monad m, Unbox a, Unbox b) => (a -> m b) -> Vector a -> m (Vector b)
mapM_ :: (Monad m, Unbox a) => (a -> m b) -> Vector a -> m ()
forM :: (Monad m, Unbox a, Unbox b) => Vector a -> (a -> m b) -> m (Vector b)
forM_ :: (Monad m, Unbox a) => Vector a -> (a -> m b) -> m ()
zipWith :: (Unbox a, Unbox b, Unbox c) => (a -> b -> c) -> Vector a -> Vector b -> Vector c
zipWith3 :: (Unbox a, Unbox b, Unbox c, Unbox d) => (a -> b -> c -> d) -> Vector a -> Vector b -> Vector c -> Vector d
zipWith4 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e) => (a -> b -> c -> d -> e) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e
zipWith5 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f) => (a -> b -> c -> d -> e -> f) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f
zipWith6 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f, Unbox g) => (a -> b -> c -> d -> e -> f -> g) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f -> Vector g
izipWith :: (Unbox a, Unbox b, Unbox c) => (Int -> a -> b -> c) -> Vector a -> Vector b -> Vector c
izipWith3 :: (Unbox a, Unbox b, Unbox c, Unbox d) => (Int -> a -> b -> c -> d) -> Vector a -> Vector b -> Vector c -> Vector d
izipWith4 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e) => (Int -> a -> b -> c -> d -> e) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e
izipWith5 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f) => (Int -> a -> b -> c -> d -> e -> f) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f
izipWith6 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f, Unbox g) => (Int -> a -> b -> c -> d -> e -> f -> g) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f -> Vector g
zip :: (Unbox a, Unbox b) => Vector a -> Vector b -> Vector (a, b)
zip3 :: (Unbox a, Unbox b, Unbox c) => Vector a -> Vector b -> Vector c -> Vector (a, b, c)
zip4 :: (Unbox a, Unbox b, Unbox c, Unbox d) => Vector a -> Vector b -> Vector c -> Vector d -> Vector (a, b, c, d)
zip5 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e) => Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector (a, b, c, d, e)
zip6 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f) => Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f -> Vector (a, b, c, d, e, f)
zipWithM :: (Monad m, Unbox a, Unbox b, Unbox c) => (a -> b -> m c) -> Vector a -> Vector b -> m (Vector c)
zipWithM_ :: (Monad m, Unbox a, Unbox b) => (a -> b -> m c) -> Vector a -> Vector b -> m ()
unzip :: (Unbox a, Unbox b) => Vector (a, b) -> (Vector a, Vector b)
unzip3 :: (Unbox a, Unbox b, Unbox c) => Vector (a, b, c) -> (Vector a, Vector b, Vector c)
unzip4 :: (Unbox a, Unbox b, Unbox c, Unbox d) => Vector (a, b, c, d) -> (Vector a, Vector b, Vector c, Vector d)
unzip5 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e) => Vector (a, b, c, d, e) -> (Vector a, Vector b, Vector c, Vector d, Vector e)
unzip6 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f) => Vector (a, b, c, d, e, f) -> (Vector a, Vector b, Vector c, Vector d, Vector e, Vector f)
filter :: Unbox a => (a -> Bool) -> Vector a -> Vector a
ifilter :: Unbox a => (Int -> a -> Bool) -> Vector a -> Vector a
filterM :: (Monad m, Unbox a) => (a -> m Bool) -> Vector a -> m (Vector a)
takeWhile :: Unbox a => (a -> Bool) -> Vector a -> Vector a
dropWhile :: Unbox a => (a -> Bool) -> Vector a -> Vector a
partition :: Unbox a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
unstablePartition :: Unbox a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
span :: Unbox a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
break :: Unbox a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
elem :: (Unbox a, Eq a) => a -> Vector a -> Bool
notElem :: (Unbox a, Eq a) => a -> Vector a -> Bool
find :: Unbox a => (a -> Bool) -> Vector a -> Maybe a
findIndex :: Unbox a => (a -> Bool) -> Vector a -> Maybe Int
findIndices :: Unbox a => (a -> Bool) -> Vector a -> Vector Int
elemIndex :: (Unbox a, Eq a) => a -> Vector a -> Maybe Int
elemIndices :: (Unbox a, Eq a) => a -> Vector a -> Vector Int
foldl :: Unbox b => (a -> b -> a) -> a -> Vector b -> a
foldl1 :: Unbox a => (a -> a -> a) -> Vector a -> a
foldl' :: Unbox b => (a -> b -> a) -> a -> Vector b -> a
foldl1' :: Unbox a => (a -> a -> a) -> Vector a -> a
foldr :: Unbox a => (a -> b -> b) -> b -> Vector a -> b
foldr1 :: Unbox a => (a -> a -> a) -> Vector a -> a
foldr' :: Unbox a => (a -> b -> b) -> b -> Vector a -> b
foldr1' :: Unbox a => (a -> a -> a) -> Vector a -> a
ifoldl :: Unbox b => (a -> Int -> b -> a) -> a -> Vector b -> a
ifoldl' :: Unbox b => (a -> Int -> b -> a) -> a -> Vector b -> a
ifoldr :: Unbox a => (Int -> a -> b -> b) -> b -> Vector a -> b
ifoldr' :: Unbox a => (Int -> a -> b -> b) -> b -> Vector a -> b
all :: Unbox a => (a -> Bool) -> Vector a -> Bool
any :: Unbox a => (a -> Bool) -> Vector a -> Bool
and :: Vector Bool -> Bool
or :: Vector Bool -> Bool
sum :: (Unbox a, Num a) => Vector a -> a
product :: (Unbox a, Num a) => Vector a -> a
maximum :: (Unbox a, Ord a) => Vector a -> a
maximumBy :: Unbox a => (a -> a -> Ordering) -> Vector a -> a
minimum :: (Unbox a, Ord a) => Vector a -> a
minimumBy :: Unbox a => (a -> a -> Ordering) -> Vector a -> a
minIndex :: (Unbox a, Ord a) => Vector a -> Int
minIndexBy :: Unbox a => (a -> a -> Ordering) -> Vector a -> Int
maxIndex :: (Unbox a, Ord a) => Vector a -> Int
maxIndexBy :: Unbox a => (a -> a -> Ordering) -> Vector a -> Int
foldM :: (Monad m, Unbox b) => (a -> b -> m a) -> a -> Vector b -> m a
foldM' :: (Monad m, Unbox b) => (a -> b -> m a) -> a -> Vector b -> m a
fold1M :: (Monad m, Unbox a) => (a -> a -> m a) -> Vector a -> m a
fold1M' :: (Monad m, Unbox a) => (a -> a -> m a) -> Vector a -> m a
prescanl :: (Unbox a, Unbox b) => (a -> b -> a) -> a -> Vector b -> Vector a
prescanl' :: (Unbox a, Unbox b) => (a -> b -> a) -> a -> Vector b -> Vector a
postscanl :: (Unbox a, Unbox b) => (a -> b -> a) -> a -> Vector b -> Vector a
postscanl' :: (Unbox a, Unbox b) => (a -> b -> a) -> a -> Vector b -> Vector a
scanl :: (Unbox a, Unbox b) => (a -> b -> a) -> a -> Vector b -> Vector a
scanl' :: (Unbox a, Unbox b) => (a -> b -> a) -> a -> Vector b -> Vector a
scanl1 :: Unbox a => (a -> a -> a) -> Vector a -> Vector a
scanl1' :: Unbox a => (a -> a -> a) -> Vector a -> Vector a
prescanr :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector b
prescanr' :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector b
postscanr :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector b
postscanr' :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector b
scanr :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector b
scanr' :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector b
scanr1 :: Unbox a => (a -> a -> a) -> Vector a -> Vector a
scanr1' :: Unbox a => (a -> a -> a) -> Vector a -> Vector a
toList :: Unbox a => Vector a -> [a]
fromList :: Unbox a => [a] -> Vector a
fromListN :: Unbox a => Int -> [a] -> Vector a
copy :: (Unbox a, PrimMonad m) => MVector (PrimState m) a -> Vector a -> m ()
unsafeCopy :: (Unbox a, PrimMonad m) => MVector (PrimState m) a -> Vector a -> m ()
Unboxed vectors
data family Vector a Source
data family MVector s a Source
class (Vector Vector a, MVector MVector a) => Unbox a Source
Accessors
Length information
length :: Unbox a => Vector a -> IntSource
O(1) Yield the length of the vector.
null :: Unbox a => Vector a -> BoolSource
O(1) Test whether a vector if empty
Indexing
(!) :: Unbox a => Vector a -> Int -> aSource
O(1) Indexing
head :: Unbox a => Vector a -> aSource
O(1) First element
last :: Unbox a => Vector a -> aSource
O(1) Last element
unsafeIndex :: Unbox a => Vector a -> Int -> aSource
O(1) Unsafe indexing without bounds checking
unsafeHead :: Unbox a => Vector a -> aSource
O(1) First element without checking if the vector is empty
unsafeLast :: Unbox a => Vector a -> aSource
O(1) Last element without checking if the vector is empty
Monadic indexing
indexM :: (Unbox a, Monad m) => Vector a -> Int -> m aSource

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 elements) is evaluated eagerly.

headM :: (Unbox a, Monad m) => Vector a -> m aSource
O(1) First element of a vector in a monad. See indexM for an explanation of why this is useful.
lastM :: (Unbox a, Monad m) => Vector a -> m aSource
O(1) Last element of a vector in a monad. See indexM for an explanation of why this is useful.
unsafeIndexM :: (Unbox a, Monad m) => Vector a -> Int -> m aSource
O(1) Indexing in a monad without bounds checks. See indexM for an explanation of why this is useful.
unsafeHeadM :: (Unbox a, Monad m) => Vector a -> m aSource
O(1) First element in a monad without checking for empty vectors. See indexM for an explanation of why this is useful.
unsafeLastM :: (Unbox a, Monad m) => Vector a -> m aSource
O(1) Last element in a monad without checking for empty vectors. See indexM for an explanation of why this is useful.
Extracting subvectors (slicing)
sliceSource
:: Unbox a
=> Intn length
-> Int
-> Vector a
-> Vector a
O(1) Yield a slice of the vector without copying it. The vector must contain at least i+n elements.
init :: Unbox a => Vector a -> Vector aSource
O(1) Yield all but the last element without copying. The vector may not be empty.
tail :: Unbox a => Vector a -> Vector aSource
O(1) Yield all but the first element without copying. The vector may not be empty.
take :: Unbox a => Int -> Vector a -> Vector aSource
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.
drop :: Unbox a => Int -> Vector a -> Vector aSource
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.
unsafeSliceSource
:: Unbox a
=> Intn length
-> Int
-> Vector a
-> Vector a
O(1) Yield a slice of the vector without copying. The vector must contain at least i+n elements but this is not checked.
unsafeInit :: Unbox a => Vector a -> Vector aSource
O(1) Yield all but the last element without copying. The vector may not be empty but this is not checked.
unsafeTail :: Unbox a => Vector a -> Vector aSource
O(1) Yield all but the first element without copying. The vector may not be empty but this is not checked.
unsafeTake :: Unbox a => Int -> Vector a -> Vector aSource
O(1) Yield the first n elements without copying. The vector must contain at least n elements but this is not checked.
unsafeDrop :: Unbox a => Int -> Vector a -> Vector aSource
O(1) Yield all but the first n elements without copying. The vector must contain at least n elements but this is not checked.
Construction
Initialisation
empty :: Unbox a => Vector aSource
O(1) Empty vector
singleton :: Unbox a => a -> Vector aSource
O(1) Vector with exactly one element
replicate :: Unbox a => Int -> a -> Vector aSource
O(n) Vector of the given length with the same value in each position
generate :: Unbox a => Int -> (Int -> a) -> Vector aSource
O(n) Construct a vector of the given length by applying the function to each index
Monadic initialisation
replicateM :: (Monad m, Unbox a) => Int -> m a -> m (Vector a)Source
O(n) Execute the monadic action the given number of times and store the results in a vector.
create :: Unbox a => (forall s. ST s (MVector s a)) -> Vector aSource

Execute the monadic action and freeze the resulting vector.

 create (do { v <- new 2; write v 0 'a'; write v 1 'b' }) = <a,b>
Unfolding
unfoldr :: Unbox a => (b -> Maybe (a, b)) -> b -> Vector aSource

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>
unfoldrN :: Unbox a => Int -> (b -> Maybe (a, b)) -> b -> Vector aSource

O(n) Construct a vector with at most n by repeatedly applying the generator function to the 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>
Enumeration
enumFromN :: (Unbox a, Num a) => a -> Int -> Vector aSource

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>
enumFromStepN :: (Unbox a, Num a) => a -> a -> Int -> Vector aSource

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 0.1 5 = <1,1.1,1.2,1.3,1.4>
enumFromTo :: (Unbox a, Enum a) => a -> a -> Vector aSource

O(n) Enumerate values from x to y.

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

enumFromThenTo :: (Unbox a, Enum a) => a -> a -> a -> Vector aSource

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

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

Concatenation
cons :: Unbox a => a -> Vector a -> Vector aSource
O(n) Prepend an element
snoc :: Unbox a => Vector a -> a -> Vector aSource
O(n) Append an element
(++) :: Unbox a => Vector a -> Vector a -> Vector aSource
O(m+n) Concatenate two vectors
Restricting memory usage
force :: Unbox a => Vector a -> Vector aSource

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.

Modifying vectors
Bulk updates
(//)Source
:: Unbox a
=> Vector alist of index/value pairs (of length n)
-> [(Int, a)]
-> Vector a

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

 <5,9,2,7> // [(2,1),(0,3),(2,8)] = <3,9,8,7>
updateSource
:: Unbox a
=> Vector avector of index/value pairs (of length n)
-> Vector (Int, a)
-> Vector a

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

 update <5,9,2,7> <(2,1),(0,3),(2,8)> = <3,9,8,7>
update_Source
:: Unbox a
=> Vector aindex vector (of length n1)
-> Vector Intvalue vector (of length n2)
-> Vector a
-> Vector a

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>

The function update provides the same functionality and is usually more convenient.

 update_ xs is ys = update xs (zip is ys)
unsafeUpd :: Unbox a => Vector a -> [(Int, a)] -> Vector aSource
Same as (//) but without bounds checking.
unsafeUpdate :: Unbox a => Vector a -> Vector (Int, a) -> Vector aSource
Same as update but without bounds checking.
unsafeUpdate_ :: Unbox a => Vector a -> Vector Int -> Vector a -> Vector aSource
Same as update_ but without bounds checking.
Accumulations
accumSource
:: Unbox a
=> a -> b -> ainitial vector (of length m)
-> Vector alist of index/value pairs (of length n)
-> [(Int, b)]
-> Vector a

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

 accum (+) <5,9,2> [(2,4),(1,6),(0,3),(1,7)] = <5+3, 9+6+7, 2+4>
accumulateSource
:: (Unbox a, Unbox b)
=> a -> b -> ainitial vector (of length m)
-> Vector avector of index/value pairs (of length n)
-> Vector (Int, b)
-> Vector a

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

 accumulate (+) <5,9,2> <(2,4),(1,6),(0,3),(1,7)> = <5+3, 9+6+7, 2+4>
accumulate_Source
:: (Unbox a, Unbox b)
=> a -> b -> ainitial vector (of length m)
-> Vector aindex vector (of length n1)
-> Vector Intvalue vector (of length n2)
-> Vector b
-> Vector a

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>

The function accumulate provides the same functionality and is usually more convenient.

 accumulate_ f as is bs = accumulate f as (zip is bs)
unsafeAccum :: Unbox a => (a -> b -> a) -> Vector a -> [(Int, b)] -> Vector aSource
Same as accum but without bounds checking.
unsafeAccumulate :: (Unbox a, Unbox b) => (a -> b -> a) -> Vector a -> Vector (Int, b) -> Vector aSource
Same as accumulate but without bounds checking.
unsafeAccumulate_ :: (Unbox a, Unbox b) => (a -> b -> a) -> Vector a -> Vector Int -> Vector b -> Vector aSource
Same as accumulate_ but without bounds checking.
Permutations
reverse :: Unbox a => Vector a -> Vector aSource
O(n) Reverse a vector
backpermute :: Unbox a => Vector a -> Vector Int -> Vector aSource

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>
unsafeBackpermute :: Unbox a => Vector a -> Vector Int -> Vector aSource
Same as backpermute but without bounds checking.
Safe destructive updates
modify :: Unbox a => (forall s. MVector s a -> ST s ()) -> Vector a -> Vector aSource

Apply a destructive operation to a vector. The operation will be performed in place if it is safe to do so and will modify a copy of the vector otherwise.

 modify (\v -> write v 0 'x') (replicate 3 'a') = <'x','a','a'>
Elementwise operations
Mapping
map :: (Unbox a, Unbox b) => (a -> b) -> Vector a -> Vector bSource
O(n) Map a function over a vector
imap :: (Unbox a, Unbox b) => (Int -> a -> b) -> Vector a -> Vector bSource
O(n) Apply a function to every element of a vector and its index
concatMap :: (Unbox a, Unbox b) => (a -> Vector b) -> Vector a -> Vector bSource
Map a function over a vector and concatenate the results.
Monadic mapping
mapM :: (Monad m, Unbox a, Unbox b) => (a -> m b) -> Vector a -> m (Vector b)Source
O(n) Apply the monadic action to all elements of the vector, yielding a vector of results
mapM_ :: (Monad m, Unbox a) => (a -> m b) -> Vector a -> m ()Source
O(n) Apply the monadic action to all elements of a vector and ignore the results
forM :: (Monad m, Unbox a, Unbox b) => Vector a -> (a -> m b) -> m (Vector b)Source
O(n) Apply the monadic action to all elements of the vector, yielding a vector of results. Equvalent to flip mapM.
forM_ :: (Monad m, Unbox a) => Vector a -> (a -> m b) -> m ()Source
O(n) Apply the monadic action to all elements of a vector and ignore the results. Equivalent to flip mapM_.
Zipping
zipWith :: (Unbox a, Unbox b, Unbox c) => (a -> b -> c) -> Vector a -> Vector b -> Vector cSource
O(min(m,n)) Zip two vectors with the given function.
zipWith3 :: (Unbox a, Unbox b, Unbox c, Unbox d) => (a -> b -> c -> d) -> Vector a -> Vector b -> Vector c -> Vector dSource
Zip three vectors with the given function.
zipWith4 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e) => (a -> b -> c -> d -> e) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector eSource
zipWith5 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f) => (a -> b -> c -> d -> e -> f) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector fSource
zipWith6 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f, Unbox g) => (a -> b -> c -> d -> e -> f -> g) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f -> Vector gSource
izipWith :: (Unbox a, Unbox b, Unbox c) => (Int -> a -> b -> c) -> Vector a -> Vector b -> Vector cSource
O(min(m,n)) Zip two vectors with a function that also takes the elements' indices.
izipWith3 :: (Unbox a, Unbox b, Unbox c, Unbox d) => (Int -> a -> b -> c -> d) -> Vector a -> Vector b -> Vector c -> Vector dSource
Zip three vectors and their indices with the given function.
izipWith4 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e) => (Int -> a -> b -> c -> d -> e) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector eSource
izipWith5 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f) => (Int -> a -> b -> c -> d -> e -> f) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector fSource
izipWith6 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f, Unbox g) => (Int -> a -> b -> c -> d -> e -> f -> g) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f -> Vector gSource
zip :: (Unbox a, Unbox b) => Vector a -> Vector b -> Vector (a, b)Source
O(1) Zip 2 vectors
zip3 :: (Unbox a, Unbox b, Unbox c) => Vector a -> Vector b -> Vector c -> Vector (a, b, c)Source
O(1) Zip 3 vectors
zip4 :: (Unbox a, Unbox b, Unbox c, Unbox d) => Vector a -> Vector b -> Vector c -> Vector d -> Vector (a, b, c, d)Source
O(1) Zip 4 vectors
zip5 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e) => Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector (a, b, c, d, e)Source
O(1) Zip 5 vectors
zip6 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f) => Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f -> Vector (a, b, c, d, e, f)Source
O(1) Zip 6 vectors
Monadic zipping
zipWithM :: (Monad m, Unbox a, Unbox b, Unbox c) => (a -> b -> m c) -> Vector a -> Vector b -> m (Vector c)Source
O(min(m,n)) Zip the two vectors with the monadic action and yield a vector of results
zipWithM_ :: (Monad m, Unbox a, Unbox b) => (a -> b -> m c) -> Vector a -> Vector b -> m ()Source
O(min(m,n)) Zip the two vectors with the monadic action and ignore the results
Unzipping
unzip :: (Unbox a, Unbox b) => Vector (a, b) -> (Vector a, Vector b)Source
O(1) Unzip 2 vectors
unzip3 :: (Unbox a, Unbox b, Unbox c) => Vector (a, b, c) -> (Vector a, Vector b, Vector c)Source
O(1) Unzip 3 vectors
unzip4 :: (Unbox a, Unbox b, Unbox c, Unbox d) => Vector (a, b, c, d) -> (Vector a, Vector b, Vector c, Vector d)Source
O(1) Unzip 4 vectors
unzip5 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e) => Vector (a, b, c, d, e) -> (Vector a, Vector b, Vector c, Vector d, Vector e)Source
O(1) Unzip 5 vectors
unzip6 :: (Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f) => Vector (a, b, c, d, e, f) -> (Vector a, Vector b, Vector c, Vector d, Vector e, Vector f)Source
O(1) Unzip 6 vectors
Working with predicates
Filtering
filter :: Unbox a => (a -> Bool) -> Vector a -> Vector aSource
O(n) Drop elements that do not satisfy the predicate
ifilter :: Unbox a => (Int -> a -> Bool) -> Vector a -> Vector aSource
O(n) Drop elements that do not satisfy the predicate which is applied to values and their indices
filterM :: (Monad m, Unbox a) => (a -> m Bool) -> Vector a -> m (Vector a)Source
O(n) Drop elements that do not satisfy the monadic predicate
takeWhile :: Unbox a => (a -> Bool) -> Vector a -> Vector aSource
O(n) Yield the longest prefix of elements satisfying the predicate without copying.
dropWhile :: Unbox a => (a -> Bool) -> Vector a -> Vector aSource
O(n) Drop the longest prefix of elements that satisfy the predicate without copying.
Partitioning
partition :: Unbox a => (a -> Bool) -> Vector a -> (Vector a, Vector a)Source
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.
unstablePartition :: Unbox a => (a -> Bool) -> Vector a -> (Vector a, Vector a)Source
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.
span :: Unbox a => (a -> Bool) -> Vector a -> (Vector a, Vector a)Source
O(n) Split the vector into the longest prefix of elements that satisfy the predicate and the rest without copying.
break :: Unbox a => (a -> Bool) -> Vector a -> (Vector a, Vector a)Source
O(n) Split the vector into the longest prefix of elements that do not satisfy the predicate and the rest without copying.
Searching
elem :: (Unbox a, Eq a) => a -> Vector a -> BoolSource
O(n) Check if the vector contains an element
notElem :: (Unbox a, Eq a) => a -> Vector a -> BoolSource
O(n) Check if the vector does not contain an element (inverse of elem)
find :: Unbox a => (a -> Bool) -> Vector a -> Maybe aSource
O(n) Yield Just the first element matching the predicate or Nothing if no such element exists.
findIndex :: Unbox a => (a -> Bool) -> Vector a -> Maybe IntSource
O(n) Yield Just the index of the first element matching the predicate or Nothing if no such element exists.
findIndices :: Unbox a => (a -> Bool) -> Vector a -> Vector IntSource
O(n) Yield the indices of elements satisfying the predicate in ascending order.
elemIndex :: (Unbox a, Eq a) => a -> Vector a -> Maybe IntSource
O(n) Yield Just the index of the first occurence of the given element or Nothing if the vector does not contain the element. This is a specialised version of findIndex.
elemIndices :: (Unbox a, Eq a) => a -> Vector a -> Vector IntSource
O(n) Yield the indices of all occurences of the given element in ascending order. This is a specialised version of findIndices.
Folding
foldl :: Unbox b => (a -> b -> a) -> a -> Vector b -> aSource
O(n) Left fold
foldl1 :: Unbox a => (a -> a -> a) -> Vector a -> aSource
O(n) Left fold on non-empty vectors
foldl' :: Unbox b => (a -> b -> a) -> a -> Vector b -> aSource
O(n) Left fold with strict accumulator
foldl1' :: Unbox a => (a -> a -> a) -> Vector a -> aSource
O(n) Left fold on non-empty vectors with strict accumulator
foldr :: Unbox a => (a -> b -> b) -> b -> Vector a -> bSource
O(n) Right fold
foldr1 :: Unbox a => (a -> a -> a) -> Vector a -> aSource
O(n) Right fold on non-empty vectors
foldr' :: Unbox a => (a -> b -> b) -> b -> Vector a -> bSource
O(n) Right fold with a strict accumulator
foldr1' :: Unbox a => (a -> a -> a) -> Vector a -> aSource
O(n) Right fold on non-empty vectors with strict accumulator
ifoldl :: Unbox b => (a -> Int -> b -> a) -> a -> Vector b -> aSource
O(n) Left fold (function applied to each element and its index)
ifoldl' :: Unbox b => (a -> Int -> b -> a) -> a -> Vector b -> aSource
O(n) Left fold with strict accumulator (function applied to each element and its index)
ifoldr :: Unbox a => (Int -> a -> b -> b) -> b -> Vector a -> bSource
O(n) Right fold (function applied to each element and its index)
ifoldr' :: Unbox a => (Int -> a -> b -> b) -> b -> Vector a -> bSource
O(n) Right fold with strict accumulator (function applied to each element and its index)
Specialised folds
all :: Unbox a => (a -> Bool) -> Vector a -> BoolSource
O(n) Check if all elements satisfy the predicate.
any :: Unbox a => (a -> Bool) -> Vector a -> BoolSource
O(n) Check if any element satisfies the predicate.
and :: Vector Bool -> BoolSource
O(n) Check if all elements are True
or :: Vector Bool -> BoolSource
O(n) Check if any element is True
sum :: (Unbox a, Num a) => Vector a -> aSource
O(n) Compute the sum of the elements
product :: (Unbox a, Num a) => Vector a -> aSource
O(n) Compute the produce of the elements
maximum :: (Unbox a, Ord a) => Vector a -> aSource
O(n) Yield the maximum element of the vector. The vector may not be empty.
maximumBy :: Unbox a => (a -> a -> Ordering) -> Vector a -> aSource
O(n) Yield the maximum element of the vector according to the given comparison function. The vector may not be empty.
minimum :: (Unbox a, Ord a) => Vector a -> aSource
O(n) Yield the minimum element of the vector. The vector may not be empty.
minimumBy :: Unbox a => (a -> a -> Ordering) -> Vector a -> aSource
O(n) Yield the minimum element of the vector according to the given comparison function. The vector may not be empty.
minIndex :: (Unbox a, Ord a) => Vector a -> IntSource
O(n) Yield the index of the minimum element of the vector. The vector may not be empty.
minIndexBy :: Unbox a => (a -> a -> Ordering) -> Vector a -> IntSource
O(n) Yield the index of the minimum element of the vector according to the given comparison function. The vector may not be empty.
maxIndex :: (Unbox a, Ord a) => Vector a -> IntSource
O(n) Yield the index of the maximum element of the vector. The vector may not be empty.
maxIndexBy :: Unbox a => (a -> a -> Ordering) -> Vector a -> IntSource
O(n) Yield the index of the maximum element of the vector according to the given comparison function. The vector may not be empty.
Monadic folds
foldM :: (Monad m, Unbox b) => (a -> b -> m a) -> a -> Vector b -> m aSource
O(n) Monadic fold
foldM' :: (Monad m, Unbox b) => (a -> b -> m a) -> a -> Vector b -> m aSource
O(n) Monadic fold with strict accumulator
fold1M :: (Monad m, Unbox a) => (a -> a -> m a) -> Vector a -> m aSource
O(n) Monadic fold over non-empty vectors
fold1M' :: (Monad m, Unbox a) => (a -> a -> m a) -> Vector a -> m aSource
O(n) Monad fold over non-empty vectors with strict accumulator
Prefix sums (scans)
prescanl :: (Unbox a, Unbox b) => (a -> b -> a) -> a -> Vector b -> Vector aSource

O(n) Prescan

 prescanl f z = init . scanl f z

Example: prescanl (+) 0 <1,2,3,4> = <0,1,3,6>

prescanl' :: (Unbox a, Unbox b) => (a -> b -> a) -> a -> Vector b -> Vector aSource
O(n) Prescan with strict accumulator
postscanl :: (Unbox a, Unbox b) => (a -> b -> a) -> a -> Vector b -> Vector aSource

O(n) Scan

 postscanl f z = tail . scanl f z

Example: postscanl (+) 0 <1,2,3,4> = <1,3,6,10>

postscanl' :: (Unbox a, Unbox b) => (a -> b -> a) -> a -> Vector b -> Vector aSource
O(n) Scan with strict accumulator
scanl :: (Unbox a, Unbox b) => (a -> b -> a) -> a -> Vector b -> Vector aSource

O(n) Haskell-style scan

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

Example: scanl (+) 0 <1,2,3,4> = <0,1,3,6,10>

scanl' :: (Unbox a, Unbox b) => (a -> b -> a) -> a -> Vector b -> Vector aSource
O(n) Haskell-style scan with strict accumulator
scanl1 :: Unbox a => (a -> a -> a) -> Vector a -> Vector aSource

O(n) Scan over a non-empty vector

 scanl f <x1,...,xn> = <y1,...,yn>
   where y1 = x1
         yi = f y(i-1) xi
scanl1' :: Unbox a => (a -> a -> a) -> Vector a -> Vector aSource
O(n) Scan over a non-empty vector with a strict accumulator
prescanr :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector bSource

O(n) Right-to-left prescan

 prescanr f z = reverse . prescanl (flip f) z . reverse
prescanr' :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector bSource
O(n) Right-to-left prescan with strict accumulator
postscanr :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector bSource
O(n) Right-to-left scan
postscanr' :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector bSource
O(n) Right-to-left scan with strict accumulator
scanr :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector bSource
O(n) Right-to-left Haskell-style scan
scanr' :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector bSource
O(n) Right-to-left Haskell-style scan with strict accumulator
scanr1 :: Unbox a => (a -> a -> a) -> Vector a -> Vector aSource
O(n) Right-to-left scan over a non-empty vector
scanr1' :: Unbox a => (a -> a -> a) -> Vector a -> Vector aSource
O(n) Right-to-left scan over a non-empty vector with a strict accumulator
Conversions
Lists
toList :: Unbox a => Vector a -> [a]Source
O(n) Convert a vector to a list
fromList :: Unbox a => [a] -> Vector aSource
O(n) Convert a list to a vector
fromListN :: Unbox a => Int -> [a] -> Vector aSource

O(n) Convert the first n elements of a list to a vector

 fromListN n xs = fromList (take n xs)
Mutable vectors
copy :: (Unbox a, PrimMonad m) => MVector (PrimState m) a -> Vector a -> m ()Source
O(n) Copy an immutable vector into a mutable one. The two vectors must have the same length. This is not checked.
unsafeCopy :: (Unbox a, PrimMonad m) => MVector (PrimState m) a -> Vector a -> m ()Source
O(n) Copy an immutable vector into a mutable one. The two vectors must have the same length.
Produced by Haddock version 2.6.0