Copyright | (c) Roman Leshchinskiy 2009-2010 Alexey Kuleshevich 2020-2022 Aleksey Khudyakov 2020-2022 Andrew Lelechenko 2020-2022 |
---|---|

License | BSD-style |

Maintainer | Haskell Libraries Team <libraries@haskell.org> |

Stability | experimental |

Portability | non-portable |

Safe Haskell | None |

Language | Haskell2010 |

Adaptive unboxed vectors. The implementation is based on type families and picks an efficient, specialised representation for every element type. For example, 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) =>`MVector`

`MVector`

(`Complex`

a) where {-# INLINE basicLength #-} basicLength (MV_Complex v) =`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)

For newtypes, defining instances is easier since one could use
`GeneralizedNewtypeDeriving`

in order to derive instances for
`Vector`

and `MVector`

,
since they're very cumbersome to write by hand:

`>>>`

`:set -XTypeFamilies -XStandaloneDeriving -XMultiParamTypeClasses -XGeneralizedNewtypeDeriving`

`>>>`

`>>>`

`import qualified Data.Vector.Unboxed as U`

`>>>`

`import qualified Data.Vector.Generic as G`

`>>>`

`import qualified Data.Vector.Generic.Mutable as M`

`>>>`

`>>>`

`newtype Foo = Foo Int`

`>>>`

`>>>`

`newtype instance U.MVector s Foo = MV_Int (U.MVector s Int)`

`>>>`

`newtype instance U.Vector Foo = V_Int (U.Vector Int)`

`>>>`

`deriving instance M.MVector MVector Foo`

`>>>`

`deriving instance G.Vector Vector Foo`

`>>>`

`instance Unbox Foo`

## 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
- (!?) :: Unbox a => Vector a -> Int -> Maybe 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
- splitAt :: Unbox a => Int -> Vector a -> (Vector a, Vector a)
- uncons :: Unbox a => Vector a -> Maybe (a, Vector a)
- unsnoc :: Unbox a => Vector a -> Maybe (Vector a, 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
- iterateN :: Unbox a => Int -> (a -> a) -> a -> Vector a
- replicateM :: (Monad m, Unbox a) => Int -> m a -> m (Vector a)
- generateM :: (Monad m, Unbox a) => Int -> (Int -> m a) -> m (Vector a)
- iterateNM :: (Monad m, Unbox a) => Int -> (a -> m a) -> a -> m (Vector a)
- create :: Unbox a => (forall s. ST s (MVector s a)) -> Vector a
- createT :: (Traversable f, Unbox a) => (forall s. ST s (f (MVector s a))) -> f (Vector a)
- unfoldr :: Unbox a => (b -> Maybe (a, b)) -> b -> Vector a
- unfoldrN :: Unbox a => Int -> (b -> Maybe (a, b)) -> b -> Vector a
- unfoldrExactN :: Unbox a => Int -> (b -> (a, b)) -> b -> Vector a
- unfoldrM :: (Monad m, Unbox a) => (b -> m (Maybe (a, b))) -> b -> m (Vector a)
- unfoldrNM :: (Monad m, Unbox a) => Int -> (b -> m (Maybe (a, b))) -> b -> m (Vector a)
- unfoldrExactNM :: (Monad m, Unbox a) => Int -> (b -> m (a, b)) -> b -> m (Vector a)
- constructN :: Unbox a => Int -> (Vector a -> a) -> Vector a
- constructrN :: Unbox a => Int -> (Vector a -> a) -> 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
- concat :: Unbox 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
- indexed :: Unbox a => Vector a -> Vector (Int, 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)
- imapM :: (Monad m, Unbox a, Unbox b) => (Int -> a -> m b) -> Vector a -> m (Vector b)
- mapM_ :: (Monad m, Unbox a) => (a -> m b) -> Vector a -> m ()
- imapM_ :: (Monad m, Unbox a) => (Int -> 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 ()
- iforM :: (Monad m, Unbox a, Unbox b) => Vector a -> (Int -> a -> m b) -> m (Vector b)
- iforM_ :: (Monad m, Unbox a) => Vector a -> (Int -> 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)
- izipWithM :: (Monad m, Unbox a, Unbox b, Unbox c) => (Int -> 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 ()
- izipWithM_ :: (Monad m, Unbox a, Unbox b) => (Int -> 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)
- uniq :: (Unbox a, Eq a) => Vector a -> Vector a
- mapMaybe :: (Unbox a, Unbox b) => (a -> Maybe b) -> Vector a -> Vector b
- imapMaybe :: (Unbox a, Unbox b) => (Int -> a -> Maybe b) -> Vector a -> Vector b
- mapMaybeM :: (Monad m, Unbox a, Unbox b) => (a -> m (Maybe b)) -> Vector a -> m (Vector b)
- imapMaybeM :: (Monad m, Unbox a, Unbox b) => (Int -> a -> m (Maybe b)) -> Vector a -> m (Vector b)
- 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)
- partitionWith :: (Unbox a, Unbox b, Unbox c) => (a -> Either b c) -> Vector a -> (Vector b, Vector c)
- span :: Unbox a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
- break :: Unbox a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
- groupBy :: Unbox a => (a -> a -> Bool) -> Vector a -> [Vector a]
- group :: (Unbox a, Eq 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
- foldMap :: (Monoid m, Unbox a) => (a -> m) -> Vector a -> m
- foldMap' :: (Monoid m, Unbox a) => (a -> m) -> Vector a -> m
- 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
- maximumOn :: (Ord b, Unbox a) => (a -> b) -> Vector a -> a
- minimum :: (Unbox a, Ord a) => Vector a -> a
- minimumBy :: Unbox a => (a -> a -> Ordering) -> Vector a -> a
- minimumOn :: (Ord b, Unbox a) => (a -> b) -> 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
- ifoldM :: (Monad m, Unbox b) => (a -> Int -> b -> m a) -> a -> Vector b -> m a
- foldM' :: (Monad m, Unbox b) => (a -> b -> m a) -> a -> Vector b -> m a
- ifoldM' :: (Monad m, Unbox b) => (a -> Int -> 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
- foldM_ :: (Monad m, Unbox b) => (a -> b -> m a) -> a -> Vector b -> m ()
- ifoldM_ :: (Monad m, Unbox b) => (a -> Int -> b -> m a) -> a -> Vector b -> m ()
- foldM'_ :: (Monad m, Unbox b) => (a -> b -> m a) -> a -> Vector b -> m ()
- ifoldM'_ :: (Monad m, Unbox b) => (a -> Int -> b -> m a) -> a -> Vector b -> m ()
- fold1M_ :: (Monad m, Unbox a) => (a -> a -> m a) -> Vector a -> m ()
- fold1M'_ :: (Monad m, Unbox a) => (a -> a -> m a) -> Vector a -> m ()
- 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
- iscanl :: (Unbox a, Unbox b) => (Int -> a -> b -> a) -> a -> Vector b -> Vector a
- iscanl' :: (Unbox a, Unbox b) => (Int -> a -> b -> a) -> a -> Vector b -> 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
- iscanr :: (Unbox a, Unbox b) => (Int -> a -> b -> b) -> b -> Vector a -> Vector b
- iscanr' :: (Unbox a, Unbox b) => (Int -> a -> b -> b) -> b -> Vector a -> Vector b
- eqBy :: (Unbox a, Unbox b) => (a -> b -> Bool) -> Vector a -> Vector b -> Bool
- cmpBy :: (Unbox a, Unbox b) => (a -> b -> Ordering) -> Vector a -> Vector b -> Ordering
- toList :: Unbox a => Vector a -> [a]
- fromList :: Unbox a => [a] -> Vector a
- fromListN :: Unbox a => Int -> [a] -> Vector a
- convert :: (Vector v a, Vector w a) => v a -> w a
- freeze :: (Unbox a, PrimMonad m) => MVector (PrimState m) a -> m (Vector a)
- thaw :: (Unbox a, PrimMonad m) => Vector a -> m (MVector (PrimState m) a)
- copy :: (Unbox a, PrimMonad m) => MVector (PrimState m) a -> Vector a -> m ()
- unsafeFreeze :: (Unbox a, PrimMonad m) => MVector (PrimState m) a -> m (Vector a)
- unsafeThaw :: (Unbox a, PrimMonad m) => Vector a -> m (MVector (PrimState m) a)
- unsafeCopy :: (Unbox a, PrimMonad m) => MVector (PrimState m) a -> Vector a -> m ()
- newtype UnboxViaPrim a = UnboxViaPrim a
- newtype As (a :: Type) (b :: Type) = As a
- class IsoUnbox a b where

# Unboxed vectors

#### Instances

data family MVector s a Source #

#### Instances

class (Vector Vector a, MVector MVector a) => Unbox a Source #

#### Instances

# Accessors

## Length information

## Indexing

unsafeIndex :: Unbox a => Vector a -> Int -> a Source #

*O(1)* Unsafe indexing without bounds checking.

unsafeHead :: Unbox a => Vector a -> a Source #

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

unsafeLast :: Unbox a => Vector a -> a Source #

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

## Monadic indexing

indexM :: (Unbox a, Monad m) => Vector a -> Int -> m a Source #

*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.

headM :: (Unbox a, Monad m) => Vector a -> m a Source #

*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 a Source #

*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 a Source #

*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 a Source #

*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 a Source #

*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)

*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 a Source #

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

tail :: Unbox a => Vector a -> Vector a Source #

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

take :: Unbox a => Int -> Vector a -> Vector a Source #

*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 a Source #

*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 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 a Source #

*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 a Source #

*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 a Source #

*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 a Source #

*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

replicate :: Unbox a => Int -> a -> Vector a Source #

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

generate :: Unbox a => Int -> (Int -> a) -> Vector a Source #

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

iterateN :: Unbox a => Int -> (a -> a) -> a -> Vector a Source #

*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.Unboxed as VU`

`>>>`

[]`VU.iterateN 0 undefined undefined :: VU.Vector Int`

`>>>`

[(0,'a'),(-1,'b'),(-2,'c')]`VU.iterateN 3 (\(i, c) -> (pred i, succ c)) (0 :: Int, 'a')`

*Since: 0.7.1*

## 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.

generateM :: (Monad m, Unbox a) => Int -> (Int -> m a) -> m (Vector a) Source #

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

iterateNM :: (Monad m, Unbox a) => Int -> (a -> m a) -> a -> m (Vector a) Source #

*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*

create :: Unbox a => (forall s. ST s (MVector s a)) -> Vector a Source #

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`

>

createT :: (Traversable f, Unbox a) => (forall s. ST s (f (MVector s a))) -> f (Vector a) Source #

Execute the monadic action and freeze the resulting vectors.

## Unfolding

unfoldrExactN :: Unbox a => Int -> (b -> (a, b)) -> b -> Vector a Source #

*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*

unfoldrExactNM :: (Monad m, Unbox a) => Int -> (b -> m (a, b)) -> b -> m (Vector a) Source #

*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*

constructN :: Unbox a => Int -> (Vector a -> a) -> Vector a Source #

*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>

constructrN :: Unbox a => Int -> (Vector a -> a) -> Vector a Source #

*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>

## Enumeration

enumFromN :: (Unbox a, Num a) => a -> Int -> Vector a Source #

*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 a Source #

*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>

enumFromTo :: (Unbox a, Enum a) => a -> a -> Vector a Source #

*O(n)* Enumerate values from `x`

to `y`

.

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

instead.

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

*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.

## Concatenation

(++) :: Unbox a => Vector a -> Vector a -> Vector a infixr 5 Source #

*O(m+n)* Concatenate two vectors.

## Restricting memory usage

force :: Unbox a => Vector a -> Vector a Source #

*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

:: Unbox a | |

=> Vector a | initial vector (of length |

-> [(Int, a)] | list of index/value pairs (of length |

-> Vector a |

*O(m+n)* For each pair `(i,a)`

from the list of idnex/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>

:: Unbox a | |

=> Vector a | initial vector (of length |

-> Vector (Int, a) | vector of index/value pairs (of length |

-> 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>

:: Unbox a | |

=> Vector a | initial vector (of length |

-> Vector Int | index vector (of length |

-> Vector a | value vector (of length |

-> 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 a Source #

Same as (`//`

), but without bounds checking.

unsafeUpdate :: Unbox a => Vector a -> Vector (Int, a) -> Vector a Source #

Same as `update`

, but without bounds checking.

unsafeUpdate_ :: Unbox a => Vector a -> Vector Int -> Vector a -> Vector a Source #

Same as `update_`

, but without bounds checking.

## Accumulations

:: Unbox a | |

=> (a -> b -> a) | accumulating function |

-> Vector a | initial vector (of length |

-> [(Int, b)] | list of index/value pairs (of length |

-> 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`

.

#### Examples

`>>>`

`import qualified Data.Vector.Unboxed as VU`

`>>>`

[1003,2016,3004]`VU.accum (+) (VU.fromList [1000,2000,3000 :: Int]) [(2,4),(1,6),(0,3),(1,10)]`

:: (Unbox a, Unbox b) | |

=> (a -> b -> a) | accumulating function |

-> Vector a | initial vector (of length |

-> Vector (Int, b) | vector of index/value pairs (of length |

-> 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`

.

#### Examples

`>>>`

`import qualified Data.Vector.Unboxed as VU`

`>>>`

[1003,2016,3004]`VU.accumulate (+) (VU.fromList [1000,2000,3000 :: Int]) (VU.fromList [(2,4),(1,6),(0,3),(1,10)])`

:: (Unbox a, Unbox b) | |

=> (a -> b -> a) | accumulating function |

-> Vector a | initial vector (of length |

-> Vector Int | index vector (of length |

-> Vector b | value vector (of length |

-> 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 a Source #

Same as `accum`

, but without bounds checking.

unsafeAccumulate :: (Unbox a, Unbox b) => (a -> b -> a) -> Vector a -> Vector (Int, b) -> Vector a Source #

Same as `accumulate`

, but without bounds checking.

unsafeAccumulate_ :: (Unbox a, Unbox b) => (a -> b -> a) -> Vector a -> Vector Int -> Vector b -> Vector a Source #

Same as `accumulate_`

, but without bounds checking.

## Permutations

unsafeBackpermute :: Unbox a => Vector a -> Vector Int -> Vector a Source #

Same as `backpermute`

, but without bounds checking.

## Safe destructive updates

modify :: Unbox a => (forall s. MVector s a -> ST s ()) -> Vector a -> Vector a Source #

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

## Indexing

indexed :: Unbox a => Vector a -> Vector (Int, a) Source #

*O(n)* Pair each element in a vector with its index.

## Mapping

map :: (Unbox a, Unbox b) => (a -> b) -> Vector a -> Vector b Source #

*O(n)* Map a function over a vector.

imap :: (Unbox a, Unbox b) => (Int -> a -> b) -> Vector a -> Vector b Source #

*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 b Source #

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.

imapM :: (Monad m, Unbox a, Unbox b) => (Int -> a -> m b) -> Vector a -> m (Vector b) Source #

*O(n)* Apply the monadic action to every element of a vector and its
index, 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.

imapM_ :: (Monad m, Unbox a) => (Int -> a -> m b) -> Vector a -> m () Source #

*O(n)* Apply the monadic action to every element of a vector and its
index, ignoring 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. Equivalent 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 c Source #

*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 d Source #

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 e Source #

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 Source #

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 Source #

izipWith :: (Unbox a, Unbox b, Unbox c) => (Int -> a -> b -> c) -> Vector a -> Vector b -> Vector c Source #

*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 d Source #

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 e Source #

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 Source #

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 Source #

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.

izipWithM :: (Monad m, Unbox a, Unbox b, Unbox c) => (Int -> a -> b -> m c) -> Vector a -> Vector b -> m (Vector c) Source #

*O(min(m,n))* Zip the two vectors with a monadic action that also takes
the element index 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.

izipWithM_ :: (Monad m, Unbox a, Unbox b) => (Int -> a -> b -> m c) -> Vector a -> Vector b -> m () Source #

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

## Unzipping

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 a Source #

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

ifilter :: Unbox a => (Int -> a -> Bool) -> Vector a -> Vector a Source #

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

filterM :: (Monad m, Unbox a) => (a -> m Bool) -> Vector a -> m (Vector a) Source #

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

uniq :: (Unbox a, Eq a) => Vector a -> Vector a Source #

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

#### Examples

`>>>`

`import qualified Data.Vector.Unboxed as VU`

`>>>`

[1,3,200,3]`VU.uniq $ VU.fromList [1,3,3,200,3 :: Int]`

`>>>`

`import Data.Semigroup`

`>>>`

[Arg 1 'a']`VU.uniq $ VU.fromList [ Arg 1 'a', Arg 1 'b', Arg (1 :: Int) 'c']`

mapMaybe :: (Unbox a, Unbox b) => (a -> Maybe b) -> Vector a -> Vector b Source #

*O(n)* Map the values and collect the `Just`

results.

imapMaybe :: (Unbox a, Unbox b) => (Int -> a -> Maybe b) -> Vector a -> Vector b Source #

*O(n)* Map the indices/values and collect the `Just`

results.

mapMaybeM :: (Monad m, Unbox a, Unbox b) => (a -> m (Maybe b)) -> Vector a -> m (Vector b) Source #

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

.

*Since: 0.12.2.0*

imapMaybeM :: (Monad m, Unbox a, Unbox b) => (Int -> a -> m (Maybe b)) -> Vector a -> m (Vector b) Source #

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

.

*Since: 0.12.2.0*

takeWhile :: Unbox a => (a -> Bool) -> Vector a -> Vector a Source #

*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.

dropWhile :: Unbox a => (a -> Bool) -> Vector a -> Vector a Source #

*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`

.

partitionWith :: (Unbox a, Unbox b, Unbox c) => (a -> Either b c) -> Vector a -> (Vector b, Vector c) Source #

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.

groupBy :: Unbox a => (a -> a -> Bool) -> Vector a -> [Vector a] Source #

*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.Unboxed as VU`

`>>>`

`import Data.Char (isUpper)`

`>>>`

["M","ississippi ","R","iver"]`VU.groupBy (\a b -> isUpper a == isUpper b) (VU.fromList "Mississippi River")`

*Since: 0.13.0.1*

group :: (Unbox a, Eq a) => Vector a -> [Vector a] Source #

*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.Unboxed as VU`

`>>>`

["M","i","ss","i","ss","i","pp","i"]`VU.group (VU.fromList "Mississippi")`

See also `group`

.

*Since: 0.13.0.1*

## Searching

elem :: (Unbox a, Eq a) => a -> Vector a -> Bool infix 4 Source #

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

notElem :: (Unbox a, Eq a) => a -> Vector a -> Bool infix 4 Source #

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

).

findIndices :: Unbox a => (a -> Bool) -> Vector a -> Vector Int Source #

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

elemIndices :: (Unbox a, Eq a) => a -> Vector a -> Vector Int Source #

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

.

# Folding

foldl' :: Unbox b => (a -> b -> a) -> a -> Vector b -> a Source #

*O(n)* Left fold with strict accumulator.

foldl1' :: Unbox a => (a -> a -> a) -> Vector a -> a Source #

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

foldr' :: Unbox a => (a -> b -> b) -> b -> Vector a -> b Source #

*O(n)* Right fold with a strict accumulator.

foldr1' :: Unbox a => (a -> a -> a) -> Vector a -> a Source #

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

ifoldl :: Unbox b => (a -> Int -> b -> a) -> a -> Vector b -> a Source #

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

ifoldl' :: Unbox b => (a -> Int -> b -> a) -> a -> Vector b -> a Source #

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

ifoldr :: Unbox a => (Int -> a -> b -> b) -> b -> Vector a -> b Source #

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

ifoldr' :: Unbox a => (Int -> a -> b -> b) -> b -> Vector a -> b Source #

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

foldMap :: (Monoid m, Unbox a) => (a -> m) -> Vector a -> m Source #

*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*

## Specialised folds

all :: Unbox a => (a -> Bool) -> Vector a -> Bool Source #

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

#### Examples

`>>>`

`import qualified Data.Vector.Unboxed as VU`

`>>>`

True`VU.all even $ VU.fromList [2, 4, 12 :: Int]`

`>>>`

False`VU.all even $ VU.fromList [2, 4, 13 :: Int]`

`>>>`

True`VU.all even (VU.empty :: VU.Vector Int)`

any :: Unbox a => (a -> Bool) -> Vector a -> Bool Source #

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

#### Examples

`>>>`

`import qualified Data.Vector.Unboxed as VU`

`>>>`

False`VU.any even $ VU.fromList [1, 3, 7 :: Int]`

`>>>`

True`VU.any even $ VU.fromList [3, 2, 13 :: Int]`

`>>>`

False`VU.any even (VU.empty :: VU.Vector Int)`

and :: Vector Bool -> Bool Source #

*O(n)* Check if all elements are `True`

.

#### Examples

`>>>`

`import qualified Data.Vector.Unboxed as VU`

`>>>`

False`VU.and $ VU.fromList [True, False]`

`>>>`

True`VU.and VU.empty`

or :: Vector Bool -> Bool Source #

*O(n)* Check if any element is `True`

.

#### Examples

`>>>`

`import qualified Data.Vector.Unboxed as VU`

`>>>`

True`VU.or $ VU.fromList [True, False]`

`>>>`

False`VU.or VU.empty`

sum :: (Unbox a, Num a) => Vector a -> a Source #

*O(n)* Compute the sum of the elements.

#### Examples

`>>>`

`import qualified Data.Vector.Unboxed as VU`

`>>>`

321`VU.sum $ VU.fromList [300,20,1 :: Int]`

`>>>`

0`VU.sum (VU.empty :: VU.Vector Int)`

product :: (Unbox a, Num a) => Vector a -> a Source #

*O(n)* Compute the product of the elements.

#### Examples

`>>>`

`import qualified Data.Vector.Unboxed as VU`

`>>>`

24`VU.product $ VU.fromList [1,2,3,4 :: Int]`

`>>>`

1`VU.product (VU.empty :: VU.Vector Int)`

maximum :: (Unbox a, Ord a) => Vector a -> a Source #

*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.Unboxed as VU`

`>>>`

2`VU.maximum $ VU.fromList [2, 1 :: Int]`

`>>>`

`import Data.Semigroup`

`>>>`

Arg 2 'b'`VU.maximum $ VU.fromList [Arg 1 'a', Arg (2 :: Int) 'b']`

`>>>`

Arg 1 'a'`VU.maximum $ VU.fromList [Arg 1 'a', Arg (1 :: Int) 'b']`

maximumBy :: Unbox a => (a -> a -> Ordering) -> Vector a -> a Source #

*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.

#### Examples

`>>>`

`import Data.Ord`

`>>>`

`import qualified Data.Vector.Unboxed as VU`

`>>>`

(2,'a')`VU.maximumBy (comparing fst) $ VU.fromList [(2,'a'), (1 :: Int,'b')]`

`>>>`

(1,'a')`VU.maximumBy (comparing fst) $ VU.fromList [(1,'a'), (1 :: Int,'b')]`

maximumOn :: (Ord b, Unbox a) => (a -> b) -> Vector a -> a Source #

*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.

#### Examples

`>>>`

`import qualified Data.Vector.Unboxed as VU`

`>>>`

(2,'a')`VU.maximumOn fst $ VU.fromList [(2,'a'), (1 :: Int,'b')]`

`>>>`

(1,'a')`VU.maximumOn fst $ VU.fromList [(1,'a'), (1 :: Int,'b')]`

*Since: 0.13.0.0*

minimum :: (Unbox a, Ord a) => Vector a -> a Source #

*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.Unboxed as VU`

`>>>`

1`VU.minimum $ VU.fromList [2, 1 :: Int]`

`>>>`

`import Data.Semigroup`

`>>>`

Arg 1 'b'`VU.minimum $ VU.fromList [Arg 2 'a', Arg (1 :: Int) 'b']`

`>>>`

Arg 1 'a'`VU.minimum $ VU.fromList [Arg 1 'a', Arg (1 :: Int) 'b']`

minimumBy :: Unbox a => (a -> a -> Ordering) -> Vector a -> a Source #

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

*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.

#### Examples

`>>>`

`import Data.Ord`

`>>>`

`import qualified Data.Vector.Unboxed as VU`

`>>>`

(1,'b')`VU.minimumBy (comparing fst) $ VU.fromList [(2,'a'), (1 :: Int,'b')]`

`>>>`

(1,'a')`VU.minimumBy (comparing fst) $ VU.fromList [(1,'a'), (1 :: Int,'b')]`

minimumOn :: (Ord b, Unbox a) => (a -> b) -> Vector a -> a Source #

*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.

#### Examples

`>>>`

`import qualified Data.Vector.Unboxed as VU`

`>>>`

(1,'b')`VU.minimumOn fst $ VU.fromList [(2,'a'), (1 :: Int,'b')]`

`>>>`

(1,'a')`VU.minimumOn fst $ VU.fromList [(1,'a'), (1 :: Int,'b')]`

*Since: 0.13.0.0*

minIndex :: (Unbox a, Ord a) => Vector a -> Int Source #

*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 -> Int Source #

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

#### Examples

`>>>`

`import Data.Ord`

`>>>`

`import qualified Data.Vector.Unboxed as VU`

`>>>`

1`VU.minIndexBy (comparing fst) $ VU.fromList [(2,'a'), (1,'b')]`

`>>>`

0`VU.minIndexBy (comparing fst) $ VU.fromList [(1,'a'), (1,'b')]`

maxIndex :: (Unbox a, Ord a) => Vector a -> Int Source #

*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 -> Int Source #

*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.

#### Examples

`>>>`

`import Data.Ord`

`>>>`

`import qualified Data.Vector.Unboxed as VU`

`>>>`

0`VU.maxIndexBy (comparing fst) $ VU.fromList [(2,'a'), (1,'b')]`

`>>>`

0`VU.maxIndexBy (comparing fst) $ VU.fromList [(1,'a'), (1,'b')]`

## Monadic folds

ifoldM :: (Monad m, Unbox b) => (a -> Int -> b -> m a) -> a -> Vector b -> m a Source #

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

foldM' :: (Monad m, Unbox b) => (a -> b -> m a) -> a -> Vector b -> m a Source #

*O(n)* Monadic fold with strict accumulator.

ifoldM' :: (Monad m, Unbox b) => (a -> Int -> b -> m a) -> a -> Vector b -> m a Source #

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

fold1M :: (Monad m, Unbox a) => (a -> a -> m a) -> Vector a -> m a Source #

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

fold1M' :: (Monad m, Unbox a) => (a -> a -> m a) -> Vector a -> m a Source #

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

foldM_ :: (Monad m, Unbox b) => (a -> b -> m a) -> a -> Vector b -> m () Source #

*O(n)* Monadic fold that discards the result.

ifoldM_ :: (Monad m, Unbox b) => (a -> Int -> b -> m a) -> a -> Vector b -> m () Source #

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

foldM'_ :: (Monad m, Unbox b) => (a -> b -> m a) -> a -> Vector b -> m () Source #

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

ifoldM'_ :: (Monad m, Unbox b) => (a -> Int -> b -> m a) -> a -> Vector b -> m () Source #

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

fold1M_ :: (Monad m, Unbox a) => (a -> a -> m a) -> Vector a -> m () Source #

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

fold1M'_ :: (Monad m, Unbox a) => (a -> a -> m a) -> Vector a -> m () Source #

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

# Scans

prescanl' :: (Unbox a, Unbox b) => (a -> b -> a) -> a -> Vector b -> Vector a Source #

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

postscanl' :: (Unbox a, Unbox b) => (a -> b -> a) -> a -> Vector b -> Vector a Source #

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

scanl :: (Unbox a, Unbox b) => (a -> b -> a) -> a -> Vector b -> Vector a Source #

*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.Unboxed as VU`

`>>>`

[0,1,3,6,10]`VU.scanl (+) 0 (VU.fromList [1,2,3,4 :: Int])`

scanl' :: (Unbox a, Unbox b) => (a -> b -> a) -> a -> Vector b -> Vector a Source #

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

scanl1 :: Unbox a => (a -> a -> a) -> Vector a -> Vector a Source #

*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.Unboxed as VU`

`>>>`

[4,2,2,1,1]`VU.scanl1 min $ VU.fromListN 5 [4,2,4,1,3 :: Int]`

`>>>`

[1,3,3,5,5]`VU.scanl1 max $ VU.fromListN 5 [1,3,2,5,4 :: Int]`

`>>>`

[]`VU.scanl1 min (VU.empty :: VU.Vector Int)`

scanl1' :: Unbox a => (a -> a -> a) -> Vector a -> Vector a Source #

*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.Unboxed as VU`

`>>>`

[4,2,2,1,1]`VU.scanl1' min $ VU.fromListN 5 [4,2,4,1,3 :: Int]`

`>>>`

[1,3,3,5,5]`VU.scanl1' max $ VU.fromListN 5 [1,3,2,5,4 :: Int]`

`>>>`

[]`VU.scanl1' min (VU.empty :: VU.Vector Int)`

iscanl :: (Unbox a, Unbox b) => (Int -> a -> b -> a) -> a -> Vector b -> Vector a Source #

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

*Since: 0.12.2.0*

iscanl' :: (Unbox a, Unbox b) => (Int -> a -> b -> a) -> a -> Vector b -> Vector a Source #

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

*Since: 0.12.2.0*

prescanr' :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector b Source #

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

postscanr :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector b Source #

*O(n)* Right-to-left postscan.

postscanr' :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector b Source #

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

scanr :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector b Source #

*O(n)* Right-to-left scan.

scanr' :: (Unbox a, Unbox b) => (a -> b -> b) -> b -> Vector a -> Vector b Source #

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

scanr1 :: Unbox a => (a -> a -> a) -> Vector a -> Vector a Source #

*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.Unboxed as VU`

`>>>`

[1,1,2,2,4]`VU.scanr1 min $ VU.fromListN 5 [3,1,4,2,4 :: Int]`

`>>>`

[5,5,3,3,1]`VU.scanr1 max $ VU.fromListN 5 [4,5,2,3,1 :: Int]`

`>>>`

[]`VU.scanr1 min (VU.empty :: VU.Vector Int)`

scanr1' :: Unbox a => (a -> a -> a) -> Vector a -> Vector a Source #

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

#### Examples

`>>>`

`import qualified Data.Vector.Unboxed as VU`

`>>>`

[1,1,2,2,4]`VU.scanr1' min $ VU.fromListN 5 [3,1,4,2,4 :: Int]`

`>>>`

[5,5,3,3,1]`VU.scanr1' max $ VU.fromListN 5 [4,5,2,3,1 :: Int]`

`>>>`

[]`VU.scanr1' min (VU.empty :: VU.Vector Int)`

iscanr :: (Unbox a, Unbox b) => (Int -> a -> b -> b) -> b -> Vector a -> Vector b Source #

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

*Since: 0.12.2.0*

iscanr' :: (Unbox a, Unbox b) => (Int -> a -> b -> b) -> b -> Vector a -> Vector b Source #

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

@sinqce 0.12.2.0

## Comparisons

eqBy :: (Unbox a, Unbox b) => (a -> b -> Bool) -> Vector a -> Vector b -> Bool Source #

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

*Since: 0.12.2.0*

cmpBy :: (Unbox a, Unbox b) => (a -> b -> Ordering) -> Vector a -> Vector b -> Ordering Source #

*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*

# Conversions

## Lists

fromListN :: Unbox a => Int -> [a] -> Vector a Source #

*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.Unboxed as VU`

`>>>`

[1,2,3]`VU.fromListN 3 [1,2,3,4,5 :: Int]`

`>>>`

[1]`VU.fromListN 3 [1 :: Int]`

## Other vector types

convert :: (Vector v a, Vector w a) => v a -> w a Source #

*O(n)* Convert between different vector types.

## Mutable vectors

freeze :: (Unbox a, PrimMonad m) => MVector (PrimState m) a -> m (Vector a) Source #

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

thaw :: (Unbox a, PrimMonad m) => Vector a -> m (MVector (PrimState m) a) Source #

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

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.

unsafeFreeze :: (Unbox a, PrimMonad m) => MVector (PrimState m) a -> m (Vector a) Source #

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

unsafeThaw :: (Unbox a, PrimMonad m) => Vector a -> m (MVector (PrimState m) a) Source #

*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."

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. This is not checked.

## Deriving via

newtype UnboxViaPrim a Source #

Newtype wrapper which allows to derive unboxed vector in term of
primitive vectors using `DerivingVia`

mechanism. This is mostly
used as illustration of use of `DerivingVia`

for vector, see examples below.

First is rather straightforward: we define newtype and use GND to
derive `Prim`

instance. Newtype instances should be defined
manually. Then we use deriving via to define necessary instances.

`>>>`

`:set -XTypeFamilies -XStandaloneDeriving -XDerivingVia -XMultiParamTypeClasses`

`>>>`

`-- Needed to derive Prim`

`>>>`

`:set -XGeneralizedNewtypeDeriving -XDataKinds -XUnboxedTuples -XPolyKinds`

`>>>`

`>>>`

`import qualified Data.Vector.Unboxed as U`

`>>>`

`import qualified Data.Vector.Primitive as P`

`>>>`

`import qualified Data.Vector.Generic as G`

`>>>`

`import qualified Data.Vector.Generic.Mutable as M`

`>>>`

`>>>`

`newtype Foo = Foo Int deriving P.Prim`

`>>>`

`>>>`

`newtype instance U.MVector s Foo = MV_Int (P.MVector s Foo)`

`>>>`

`newtype instance U.Vector Foo = V_Int (P.Vector Foo)`

`>>>`

`deriving via (U.UnboxViaPrim Foo) instance M.MVector MVector Foo`

`>>>`

`deriving via (U.UnboxViaPrim Foo) instance G.Vector Vector Foo`

`>>>`

`instance Unbox Foo`

Second example is essentially same but with a twist. Instead of
using `Prim`

instance of data type, we use underlying instance of `Int`

:

`>>>`

`:set -XTypeFamilies -XStandaloneDeriving -XDerivingVia -XMultiParamTypeClasses`

`>>>`

`>>>`

`import qualified Data.Vector.Unboxed as U`

`>>>`

`import qualified Data.Vector.Primitive as P`

`>>>`

`import qualified Data.Vector.Generic as G`

`>>>`

`import qualified Data.Vector.Generic.Mutable as M`

`>>>`

`>>>`

`newtype Foo = Foo Int`

`>>>`

`>>>`

`newtype instance U.MVector s Foo = MV_Int (P.MVector s Int)`

`>>>`

`newtype instance U.Vector Foo = V_Int (P.Vector Int)`

`>>>`

`deriving via (U.UnboxViaPrim Int) instance M.MVector MVector Foo`

`>>>`

`deriving via (U.UnboxViaPrim Int) instance G.Vector Vector Foo`

`>>>`

`instance Unbox Foo`

*Since: 0.13.0.0*