vector-0.13.2.0: Efficient Arrays

Copyright | (c) Roman Leshchinskiy 2008-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

Data.Vector.Generic

Contents

- Immutable 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
  - Indexing
  - Mapping
  - Monadic mapping
  - Zipping
  - Monadic zipping
  - Unzipping
- Working with predicates
  - Filtering
  - Partitioning
  - Searching
- Folding
  - Specialised folds
  - Monadic folds
  - Monadic sequencing
- Scans
- Conversions
  - Lists
  - Different vector types
  - Mutable vectors
- Fusion support
  - Conversion to/from Bundles
  - Recycling support
- Utilities
  - Comparisons
  - Show and Read
  - `Data` and `Typeable`

Description

Generic interface to immutable vectors.

Synopsis

- class MVector (Mutable v) a => Vector (v :: Type -> Type) a where
  - basicUnsafeFreeze :: Mutable v s a -> ST s (v a)
  - basicUnsafeThaw :: v a -> ST s (Mutable v s a)
  - basicLength :: v a -> Int
  - basicUnsafeSlice :: Int -> Int -> v a -> v a
  - basicUnsafeIndexM :: v a -> Int -> Box a
  - basicUnsafeCopy :: Mutable v s a -> v a -> ST s ()
  - elemseq :: v a -> a -> b -> b
- type family Mutable (v :: Type -> Type) = (mv :: Type -> Type -> Type) | mv -> v
- length :: Vector v a => v a -> Int
- null :: Vector v a => v a -> Bool
- (!) :: (HasCallStack, Vector v a) => v a -> Int -> a
- (!?) :: Vector v a => v a -> Int -> Maybe a
- head :: Vector v a => v a -> a
- last :: Vector v a => v a -> a
- unsafeIndex :: Vector v a => v a -> Int -> a
- unsafeHead :: Vector v a => v a -> a
- unsafeLast :: Vector v a => v a -> a
- indexM :: (HasCallStack, Vector v a, Monad m) => v a -> Int -> m a
- headM :: (Vector v a, Monad m) => v a -> m a
- lastM :: (Vector v a, Monad m) => v a -> m a
- unsafeIndexM :: (Vector v a, Monad m) => v a -> Int -> m a
- unsafeHeadM :: (Vector v a, Monad m) => v a -> m a
- unsafeLastM :: (Vector v a, Monad m) => v a -> m a
- slice :: (HasCallStack, Vector v a) => Int -> Int -> v a -> v a
- init :: Vector v a => v a -> v a
- tail :: Vector v a => v a -> v a
- take :: Vector v a => Int -> v a -> v a
- drop :: Vector v a => Int -> v a -> v a
- splitAt :: Vector v a => Int -> v a -> (v a, v a)
- uncons :: Vector v a => v a -> Maybe (a, v a)
- unsnoc :: Vector v a => v a -> Maybe (v a, a)
- unsafeSlice :: Vector v a => Int -> Int -> v a -> v a
- unsafeInit :: Vector v a => v a -> v a
- unsafeTail :: Vector v a => v a -> v a
- unsafeTake :: Vector v a => Int -> v a -> v a
- unsafeDrop :: Vector v a => Int -> v a -> v a
- empty :: Vector v a => v a
- singleton :: Vector v a => a -> v a
- replicate :: Vector v a => Int -> a -> v a
- generate :: Vector v a => Int -> (Int -> a) -> v a
- iterateN :: Vector v a => Int -> (a -> a) -> a -> v a
- replicateM :: (Monad m, Vector v a) => Int -> m a -> m (v a)
- generateM :: (Monad m, Vector v a) => Int -> (Int -> m a) -> m (v a)
- iterateNM :: (Monad m, Vector v a) => Int -> (a -> m a) -> a -> m (v a)
- create :: Vector v a => (forall s. ST s (Mutable v s a)) -> v a
- createT :: (Traversable f, Vector v a) => (forall s. ST s (f (Mutable v s a))) -> f (v a)
- unfoldr :: Vector v a => (b -> Maybe (a, b)) -> b -> v a
- unfoldrN :: Vector v a => Int -> (b -> Maybe (a, b)) -> b -> v a
- unfoldrExactN :: Vector v a => Int -> (b -> (a, b)) -> b -> v a
- unfoldrM :: (Monad m, Vector v a) => (b -> m (Maybe (a, b))) -> b -> m (v a)
- unfoldrNM :: (Monad m, Vector v a) => Int -> (b -> m (Maybe (a, b))) -> b -> m (v a)
- unfoldrExactNM :: (Monad m, Vector v a) => Int -> (b -> m (a, b)) -> b -> m (v a)
- constructN :: Vector v a => Int -> (v a -> a) -> v a
- constructrN :: Vector v a => Int -> (v a -> a) -> v a
- enumFromN :: (Vector v a, Num a) => a -> Int -> v a
- enumFromStepN :: (Vector v a, Num a) => a -> a -> Int -> v a
- enumFromTo :: (Vector v a, Enum a) => a -> a -> v a
- enumFromThenTo :: (Vector v a, Enum a) => a -> a -> a -> v a
- cons :: Vector v a => a -> v a -> v a
- snoc :: Vector v a => v a -> a -> v a
- (++) :: Vector v a => v a -> v a -> v a
- concat :: Vector v a => [v a] -> v a
- concatNE :: Vector v a => NonEmpty (v a) -> v a
- force :: Vector v a => v a -> v a
- (//) :: Vector v a => v a -> [(Int, a)] -> v a
- update :: (Vector v a, Vector v (Int, a)) => v a -> v (Int, a) -> v a
- update_ :: (Vector v a, Vector v Int) => v a -> v Int -> v a -> v a
- unsafeUpd :: Vector v a => v a -> [(Int, a)] -> v a
- unsafeUpdate :: (Vector v a, Vector v (Int, a)) => v a -> v (Int, a) -> v a
- unsafeUpdate_ :: (Vector v a, Vector v Int) => v a -> v Int -> v a -> v a
- accum :: Vector v a => (a -> b -> a) -> v a -> [(Int, b)] -> v a
- accumulate :: (Vector v a, Vector v (Int, b)) => (a -> b -> a) -> v a -> v (Int, b) -> v a
- accumulate_ :: (Vector v a, Vector v Int, Vector v b) => (a -> b -> a) -> v a -> v Int -> v b -> v a
- unsafeAccum :: Vector v a => (a -> b -> a) -> v a -> [(Int, b)] -> v a
- unsafeAccumulate :: (Vector v a, Vector v (Int, b)) => (a -> b -> a) -> v a -> v (Int, b) -> v a
- unsafeAccumulate_ :: (Vector v a, Vector v Int, Vector v b) => (a -> b -> a) -> v a -> v Int -> v b -> v a
- reverse :: Vector v a => v a -> v a
- backpermute :: (HasCallStack, Vector v a, Vector v Int) => v a -> v Int -> v a
- unsafeBackpermute :: (Vector v a, Vector v Int) => v a -> v Int -> v a
- modify :: Vector v a => (forall s. Mutable v s a -> ST s ()) -> v a -> v a
- indexed :: (Vector v a, Vector v (Int, a)) => v a -> v (Int, a)
- map :: (Vector v a, Vector v b) => (a -> b) -> v a -> v b
- imap :: (Vector v a, Vector v b) => (Int -> a -> b) -> v a -> v b
- concatMap :: (Vector v a, Vector v b) => (a -> v b) -> v a -> v b
- mapM :: (Monad m, Vector v a, Vector v b) => (a -> m b) -> v a -> m (v b)
- imapM :: (Monad m, Vector v a, Vector v b) => (Int -> a -> m b) -> v a -> m (v b)
- mapM_ :: (Monad m, Vector v a) => (a -> m b) -> v a -> m ()
- imapM_ :: (Monad m, Vector v a) => (Int -> a -> m b) -> v a -> m ()
- forM :: (Monad m, Vector v a, Vector v b) => v a -> (a -> m b) -> m (v b)
- forM_ :: (Monad m, Vector v a) => v a -> (a -> m b) -> m ()
- iforM :: (Monad m, Vector v a, Vector v b) => v a -> (Int -> a -> m b) -> m (v b)
- iforM_ :: (Monad m, Vector v a) => v a -> (Int -> a -> m b) -> m ()
- zipWith :: (Vector v a, Vector v b, Vector v c) => (a -> b -> c) -> v a -> v b -> v c
- zipWith3 :: (Vector v a, Vector v b, Vector v c, Vector v d) => (a -> b -> c -> d) -> v a -> v b -> v c -> v d
- zipWith4 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e) => (a -> b -> c -> d -> e) -> v a -> v b -> v c -> v d -> v e
- zipWith5 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e, Vector v f) => (a -> b -> c -> d -> e -> f) -> v a -> v b -> v c -> v d -> v e -> v f
- zipWith6 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e, Vector v f, Vector v g) => (a -> b -> c -> d -> e -> f -> g) -> v a -> v b -> v c -> v d -> v e -> v f -> v g
- izipWith :: (Vector v a, Vector v b, Vector v c) => (Int -> a -> b -> c) -> v a -> v b -> v c
- izipWith3 :: (Vector v a, Vector v b, Vector v c, Vector v d) => (Int -> a -> b -> c -> d) -> v a -> v b -> v c -> v d
- izipWith4 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e) => (Int -> a -> b -> c -> d -> e) -> v a -> v b -> v c -> v d -> v e
- izipWith5 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e, Vector v f) => (Int -> a -> b -> c -> d -> e -> f) -> v a -> v b -> v c -> v d -> v e -> v f
- izipWith6 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e, Vector v f, Vector v g) => (Int -> a -> b -> c -> d -> e -> f -> g) -> v a -> v b -> v c -> v d -> v e -> v f -> v g
- zip :: (Vector v a, Vector v b, Vector v (a, b)) => v a -> v b -> v (a, b)
- zip3 :: (Vector v a, Vector v b, Vector v c, Vector v (a, b, c)) => v a -> v b -> v c -> v (a, b, c)
- zip4 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v (a, b, c, d)) => v a -> v b -> v c -> v d -> v (a, b, c, d)
- zip5 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e, Vector v (a, b, c, d, e)) => v a -> v b -> v c -> v d -> v e -> v (a, b, c, d, e)
- zip6 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e, Vector v f, Vector v (a, b, c, d, e, f)) => v a -> v b -> v c -> v d -> v e -> v f -> v (a, b, c, d, e, f)
- zipWithM :: (Monad m, Vector v a, Vector v b, Vector v c) => (a -> b -> m c) -> v a -> v b -> m (v c)
- izipWithM :: (Monad m, Vector v a, Vector v b, Vector v c) => (Int -> a -> b -> m c) -> v a -> v b -> m (v c)
- zipWithM_ :: (Monad m, Vector v a, Vector v b) => (a -> b -> m c) -> v a -> v b -> m ()
- izipWithM_ :: (Monad m, Vector v a, Vector v b) => (Int -> a -> b -> m c) -> v a -> v b -> m ()
- unzip :: (Vector v a, Vector v b, Vector v (a, b)) => v (a, b) -> (v a, v b)
- unzip3 :: (Vector v a, Vector v b, Vector v c, Vector v (a, b, c)) => v (a, b, c) -> (v a, v b, v c)
- unzip4 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v (a, b, c, d)) => v (a, b, c, d) -> (v a, v b, v c, v d)
- unzip5 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e, Vector v (a, b, c, d, e)) => v (a, b, c, d, e) -> (v a, v b, v c, v d, v e)
- unzip6 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e, Vector v f, Vector v (a, b, c, d, e, f)) => v (a, b, c, d, e, f) -> (v a, v b, v c, v d, v e, v f)
- filter :: Vector v a => (a -> Bool) -> v a -> v a
- ifilter :: Vector v a => (Int -> a -> Bool) -> v a -> v a
- filterM :: (Monad m, Vector v a) => (a -> m Bool) -> v a -> m (v a)
- uniq :: (Vector v a, Eq a) => v a -> v a
- mapMaybe :: (Vector v a, Vector v b) => (a -> Maybe b) -> v a -> v b
- imapMaybe :: (Vector v a, Vector v b) => (Int -> a -> Maybe b) -> v a -> v b
- mapMaybeM :: (Monad m, Vector v a, Vector v b) => (a -> m (Maybe b)) -> v a -> m (v b)
- imapMaybeM :: (Monad m, Vector v a, Vector v b) => (Int -> a -> m (Maybe b)) -> v a -> m (v b)
- takeWhile :: Vector v a => (a -> Bool) -> v a -> v a
- dropWhile :: Vector v a => (a -> Bool) -> v a -> v a
- partition :: Vector v a => (a -> Bool) -> v a -> (v a, v a)
- partitionWith :: (Vector v a, Vector v b, Vector v c) => (a -> Either b c) -> v a -> (v b, v c)
- unstablePartition :: Vector v a => (a -> Bool) -> v a -> (v a, v a)
- span :: Vector v a => (a -> Bool) -> v a -> (v a, v a)
- break :: Vector v a => (a -> Bool) -> v a -> (v a, v a)
- spanR :: Vector v a => (a -> Bool) -> v a -> (v a, v a)
- breakR :: Vector v a => (a -> Bool) -> v a -> (v a, v a)
- groupBy :: Vector v a => (a -> a -> Bool) -> v a -> [v a]
- group :: (Vector v a, Eq a) => v a -> [v a]
- elem :: (Vector v a, Eq a) => a -> v a -> Bool
- notElem :: (Vector v a, Eq a) => a -> v a -> Bool
- find :: Vector v a => (a -> Bool) -> v a -> Maybe a
- findIndex :: Vector v a => (a -> Bool) -> v a -> Maybe Int
- findIndexR :: Vector v a => (a -> Bool) -> v a -> Maybe Int
- findIndices :: (Vector v a, Vector v Int) => (a -> Bool) -> v a -> v Int
- elemIndex :: (Vector v a, Eq a) => a -> v a -> Maybe Int
- elemIndices :: (Vector v a, Vector v Int, Eq a) => a -> v a -> v Int
- foldl :: Vector v b => (a -> b -> a) -> a -> v b -> a
- foldl1 :: Vector v a => (a -> a -> a) -> v a -> a
- foldl' :: Vector v b => (a -> b -> a) -> a -> v b -> a
- foldl1' :: Vector v a => (a -> a -> a) -> v a -> a
- foldr :: Vector v a => (a -> b -> b) -> b -> v a -> b
- foldr1 :: Vector v a => (a -> a -> a) -> v a -> a
- foldr' :: Vector v a => (a -> b -> b) -> b -> v a -> b
- foldr1' :: Vector v a => (a -> a -> a) -> v a -> a
- ifoldl :: Vector v b => (a -> Int -> b -> a) -> a -> v b -> a
- ifoldl' :: Vector v b => (a -> Int -> b -> a) -> a -> v b -> a
- ifoldr :: Vector v a => (Int -> a -> b -> b) -> b -> v a -> b
- ifoldr' :: Vector v a => (Int -> a -> b -> b) -> b -> v a -> b
- foldMap :: (Monoid m, Vector v a) => (a -> m) -> v a -> m
- foldMap' :: (Monoid m, Vector v a) => (a -> m) -> v a -> m
- all :: Vector v a => (a -> Bool) -> v a -> Bool
- any :: Vector v a => (a -> Bool) -> v a -> Bool
- and :: Vector v Bool => v Bool -> Bool
- or :: Vector v Bool => v Bool -> Bool
- sum :: (Vector v a, Num a) => v a -> a
- product :: (Vector v a, Num a) => v a -> a
- maximum :: (Vector v a, Ord a) => v a -> a
- maximumBy :: Vector v a => (a -> a -> Ordering) -> v a -> a
- maximumOn :: (Ord b, Vector v a) => (a -> b) -> v a -> a
- minimum :: (Vector v a, Ord a) => v a -> a
- minimumBy :: Vector v a => (a -> a -> Ordering) -> v a -> a
- minimumOn :: (Ord b, Vector v a) => (a -> b) -> v a -> a
- minIndex :: (Vector v a, Ord a) => v a -> Int
- minIndexBy :: Vector v a => (a -> a -> Ordering) -> v a -> Int
- maxIndex :: (Vector v a, Ord a) => v a -> Int
- maxIndexBy :: Vector v a => (a -> a -> Ordering) -> v a -> Int
- foldM :: (Monad m, Vector v b) => (a -> b -> m a) -> a -> v b -> m a
- ifoldM :: (Monad m, Vector v b) => (a -> Int -> b -> m a) -> a -> v b -> m a
- foldM' :: (Monad m, Vector v b) => (a -> b -> m a) -> a -> v b -> m a
- ifoldM' :: (Monad m, Vector v b) => (a -> Int -> b -> m a) -> a -> v b -> m a
- fold1M :: (Monad m, Vector v a) => (a -> a -> m a) -> v a -> m a
- fold1M' :: (Monad m, Vector v a) => (a -> a -> m a) -> v a -> m a
- foldM_ :: (Monad m, Vector v b) => (a -> b -> m a) -> a -> v b -> m ()
- ifoldM_ :: (Monad m, Vector v b) => (a -> Int -> b -> m a) -> a -> v b -> m ()
- foldM'_ :: (Monad m, Vector v b) => (a -> b -> m a) -> a -> v b -> m ()
- ifoldM'_ :: (Monad m, Vector v b) => (a -> Int -> b -> m a) -> a -> v b -> m ()
- fold1M_ :: (Monad m, Vector v a) => (a -> a -> m a) -> v a -> m ()
- fold1M'_ :: (Monad m, Vector v a) => (a -> a -> m a) -> v a -> m ()
- sequence :: (Monad m, Vector v a, Vector v (m a)) => v (m a) -> m (v a)
- sequence_ :: (Monad m, Vector v (m a)) => v (m a) -> m ()
- prescanl :: (Vector v a, Vector v b) => (a -> b -> a) -> a -> v b -> v a
- prescanl' :: (Vector v a, Vector v b) => (a -> b -> a) -> a -> v b -> v a
- postscanl :: (Vector v a, Vector v b) => (a -> b -> a) -> a -> v b -> v a
- postscanl' :: (Vector v a, Vector v b) => (a -> b -> a) -> a -> v b -> v a
- scanl :: (Vector v a, Vector v b) => (a -> b -> a) -> a -> v b -> v a
- scanl' :: (Vector v a, Vector v b) => (a -> b -> a) -> a -> v b -> v a
- scanl1 :: Vector v a => (a -> a -> a) -> v a -> v a
- scanl1' :: Vector v a => (a -> a -> a) -> v a -> v a
- iscanl :: (Vector v a, Vector v b) => (Int -> a -> b -> a) -> a -> v b -> v a
- iscanl' :: (Vector v a, Vector v b) => (Int -> a -> b -> a) -> a -> v b -> v a
- prescanr :: (Vector v a, Vector v b) => (a -> b -> b) -> b -> v a -> v b
- prescanr' :: (Vector v a, Vector v b) => (a -> b -> b) -> b -> v a -> v b
- postscanr :: (Vector v a, Vector v b) => (a -> b -> b) -> b -> v a -> v b
- postscanr' :: (Vector v a, Vector v b) => (a -> b -> b) -> b -> v a -> v b
- scanr :: (Vector v a, Vector v b) => (a -> b -> b) -> b -> v a -> v b
- scanr' :: (Vector v a, Vector v b) => (a -> b -> b) -> b -> v a -> v b
- scanr1 :: Vector v a => (a -> a -> a) -> v a -> v a
- scanr1' :: Vector v a => (a -> a -> a) -> v a -> v a
- iscanr :: (Vector v a, Vector v b) => (Int -> a -> b -> b) -> b -> v a -> v b
- iscanr' :: (Vector v a, Vector v b) => (Int -> a -> b -> b) -> b -> v a -> v b
- toList :: Vector v a => v a -> [a]
- fromList :: Vector v a => [a] -> v a
- fromListN :: Vector v a => Int -> [a] -> v a
- convert :: (Vector v a, Vector w a) => v a -> w a
- freeze :: (PrimMonad m, Vector v a) => Mutable v (PrimState m) a -> m (v a)
- thaw :: (PrimMonad m, Vector v a) => v a -> m (Mutable v (PrimState m) a)
- copy :: (HasCallStack, PrimMonad m, Vector v a) => Mutable v (PrimState m) a -> v a -> m ()
- unsafeFreeze :: (PrimMonad m, Vector v a) => Mutable v (PrimState m) a -> m (v a)
- unsafeThaw :: (PrimMonad m, Vector v a) => v a -> m (Mutable v (PrimState m) a)
- unsafeCopy :: (PrimMonad m, Vector v a) => Mutable v (PrimState m) a -> v a -> m ()
- stream :: Vector v a => v a -> Bundle v a
- unstream :: Vector v a => Bundle v a -> v a
- unstreamM :: forall m v a (u :: Type -> Type). (Monad m, Vector v a) => MBundle m u a -> m (v a)
- streamR :: forall v a (u :: Type -> Type). Vector v a => v a -> Bundle u a
- unstreamR :: Vector v a => Bundle v a -> v a
- new :: Vector v a => New v a -> v a
- clone :: Vector v a => v a -> New v a
- eq :: (Vector v a, Eq a) => v a -> v a -> Bool
- cmp :: (Vector v a, Ord a) => v a -> v a -> Ordering
- eqBy :: (Vector v a, Vector v b) => (a -> b -> Bool) -> v a -> v b -> Bool
- cmpBy :: (Vector v a, Vector v b) => (a -> b -> Ordering) -> v a -> v b -> Ordering
- showsPrec :: (Vector v a, Show a) => Int -> v a -> ShowS
- readPrec :: (Vector v a, Read a) => ReadPrec (v a)
- liftShowsPrec :: Vector v a => (Int -> a -> ShowS) -> ([a] -> ShowS) -> Int -> v a -> ShowS
- liftReadsPrec :: Vector v a => (Int -> ReadS a) -> ReadS [a] -> Int -> ReadS (v a)
- gfoldl :: (Vector v a, Data a) => (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> v a -> c (v a)
- gunfold :: (Vector v a, Data a, HasCallStack) => (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (v a)
- dataCast :: (Vector v a, Data a, Typeable v, Typeable t) => (forall d. Data d => c (t d)) -> Maybe (c (v a))
- mkVecType :: String -> DataType
- mkVecConstr :: String -> Constr
- mkType :: String -> DataType

# Immutable vectors

class MVector (Mutable v) a => Vector (v :: Type -> Type) a where Source #

Class of immutable vectors. Every immutable vector is associated with its mutable version through the `Mutable` type family. Methods of this class should not be used directly. Instead, Data.Vector.Generic and other `Data.Vector` modules provide safe and fusible wrappers.

Minimum complete implementation:

- `basicUnsafeFreeze`
- `basicUnsafeThaw`
- `basicLength`
- `basicUnsafeSlice`
- `basicUnsafeIndexM`

Minimal complete definition

basicUnsafeFreeze, basicUnsafeThaw, basicLength, basicUnsafeSlice, basicUnsafeIndexM

Methods

basicUnsafeFreeze :: Mutable v s a -> ST s (v a) Source #

Assumed complexity: O(1)

Unsafely convert a mutable vector to its immutable version without copying. The mutable vector may not be used after this operation.

basicUnsafeThaw :: v a -> ST s (Mutable v s a) Source #

Assumed complexity: O(1)

Unsafely convert an immutable vector to its mutable version without copying. The immutable vector may not be used after this operation.

basicLength :: v a -> Int Source #

Assumed complexity: O(1)

Yield the length of the vector.

basicUnsafeSlice Source #

Arguments

:: Int | starting index
-> Int | length
-> v a |
-> v a |

Assumed complexity: O(1)

Yield a slice of the vector without copying it. No range checks are performed.

basicUnsafeIndexM :: v a -> Int -> Box a Source #

Assumed complexity: O(1)

Yield the element at the given position in a monad. No range checks are performed.

The monad allows us to be strict in the vector if we want. Suppose we had

    unsafeIndex :: v a -> Int -> a

instead. Now, if we wanted to copy a vector, we'd do something like

    copy mv v ... = ... unsafeWrite mv i (unsafeIndex v i) ...

For lazy vectors, the indexing would not be evaluated, which means that we would retain a reference to the original vector in each element we write. This is not what we want!

With `basicUnsafeIndexM`, we can do

    copy mv v ... = ... case basicUnsafeIndexM v i of
                          Box x -> unsafeWrite mv i x ...

which does not have this problem, because indexing (but not the returned element!) is evaluated immediately.

basicUnsafeCopy :: Mutable v s a -> v a -> ST s () Source #

Assumed complexity: O(n)

Copy an immutable vector into a mutable one. The two vectors must have the same length, but this is not checked.

Instances of `Vector` should redefine this method if they wish to support an efficient block copy operation.

Default definition: copying based on `basicUnsafeIndexM` and `basicUnsafeWrite`.

elemseq :: v a -> a -> b -> b Source #

Evaluate `a` as far as storing it in a vector would and yield `b`. The `v a` argument only fixes the type and is not touched. This method is only used for optimisation purposes. Thus, it is safe for instances of `Vector` to evaluate `a` less than it would be when stored in a vector, although this might result in suboptimal code.

    elemseq v x y = (singleton x `asTypeOf` v) `seq` y

Default definition: `a` is not evaluated at all.

#### Instances

Instances details

Vector Vector a Source # |

Instance details

Defined in Data.Vector

Methods

basicUnsafeFreeze :: Mutable Vector s a -> ST s (Vector a) Source #

basicUnsafeThaw :: Vector a -> ST s (Mutable Vector s a) Source #

basicLength :: Vector a -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector a -> Vector a Source #

basicUnsafeIndexM :: Vector a -> Int -> Box a Source #

basicUnsafeCopy :: Mutable Vector s a -> Vector a -> ST s () Source #

elemseq :: Vector a -> a -> b -> b Source #

Prim a => Vector Vector a Source # |

Instance details

Defined in Data.Vector.Primitive

Methods

basicUnsafeFreeze :: Mutable Vector s a -> ST s (Vector a) Source #

basicUnsafeThaw :: Vector a -> ST s (Mutable Vector s a) Source #

basicLength :: Vector a -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector a -> Vector a Source #

basicUnsafeIndexM :: Vector a -> Int -> Box a Source #

basicUnsafeCopy :: Mutable Vector s a -> Vector a -> ST s () Source #

elemseq :: Vector a -> a -> b -> b Source #

Storable a => Vector Vector a Source # |

Instance details

Defined in Data.Vector.Storable

Methods

basicUnsafeFreeze :: Mutable Vector s a -> ST s (Vector a) Source #

basicUnsafeThaw :: Vector a -> ST s (Mutable Vector s a) Source #

basicLength :: Vector a -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector a -> Vector a Source #

basicUnsafeIndexM :: Vector a -> Int -> Box a Source #

basicUnsafeCopy :: Mutable Vector s a -> Vector a -> ST s () Source #

elemseq :: Vector a -> a -> b -> b Source #

Vector Vector a Source # |

Instance details

Defined in Data.Vector.Strict

Methods

basicUnsafeFreeze :: Mutable Vector s a -> ST s (Vector a) Source #

basicUnsafeThaw :: Vector a -> ST s (Mutable Vector s a) Source #

basicLength :: Vector a -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector a -> Vector a Source #

basicUnsafeIndexM :: Vector a -> Int -> Box a Source #

basicUnsafeCopy :: Mutable Vector s a -> Vector a -> ST s () Source #

elemseq :: Vector a -> a -> b -> b Source #

Vector Vector All Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s All -> ST s (Vector All) Source #

basicUnsafeThaw :: Vector All -> ST s (Mutable Vector s All) Source #

basicLength :: Vector All -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector All -> Vector All Source #

basicUnsafeIndexM :: Vector All -> Int -> Box All Source #

basicUnsafeCopy :: Mutable Vector s All -> Vector All -> ST s () Source #

elemseq :: Vector All -> All -> b -> b Source #

Vector Vector Any Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s Any -> ST s (Vector Any) Source #

basicUnsafeThaw :: Vector Any -> ST s (Mutable Vector s Any) Source #

basicLength :: Vector Any -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector Any -> Vector Any Source #

basicUnsafeIndexM :: Vector Any -> Int -> Box Any Source #

basicUnsafeCopy :: Mutable Vector s Any -> Vector Any -> ST s () Source #

elemseq :: Vector Any -> Any -> b -> b Source #

Vector Vector Int16 Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s Int16 -> ST s (Vector Int16) Source #

basicUnsafeThaw :: Vector Int16 -> ST s (Mutable Vector s Int16) Source #

basicLength :: Vector Int16 -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector Int16 -> Vector Int16 Source #

basicUnsafeIndexM :: Vector Int16 -> Int -> Box Int16 Source #

basicUnsafeCopy :: Mutable Vector s Int16 -> Vector Int16 -> ST s () Source #

elemseq :: Vector Int16 -> Int16 -> b -> b Source #

Vector Vector Int32 Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s Int32 -> ST s (Vector Int32) Source #

basicUnsafeThaw :: Vector Int32 -> ST s (Mutable Vector s Int32) Source #

basicLength :: Vector Int32 -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector Int32 -> Vector Int32 Source #

basicUnsafeIndexM :: Vector Int32 -> Int -> Box Int32 Source #

basicUnsafeCopy :: Mutable Vector s Int32 -> Vector Int32 -> ST s () Source #

elemseq :: Vector Int32 -> Int32 -> b -> b Source #

Vector Vector Int64 Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s Int64 -> ST s (Vector Int64) Source #

basicUnsafeThaw :: Vector Int64 -> ST s (Mutable Vector s Int64) Source #

basicLength :: Vector Int64 -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector Int64 -> Vector Int64 Source #

basicUnsafeIndexM :: Vector Int64 -> Int -> Box Int64 Source #

basicUnsafeCopy :: Mutable Vector s Int64 -> Vector Int64 -> ST s () Source #

elemseq :: Vector Int64 -> Int64 -> b -> b Source #

Vector Vector Int8 Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s Int8 -> ST s (Vector Int8) Source #

basicUnsafeThaw :: Vector Int8 -> ST s (Mutable Vector s Int8) Source #

basicLength :: Vector Int8 -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector Int8 -> Vector Int8 Source #

basicUnsafeIndexM :: Vector Int8 -> Int -> Box Int8 Source #

basicUnsafeCopy :: Mutable Vector s Int8 -> Vector Int8 -> ST s () Source #

elemseq :: Vector Int8 -> Int8 -> b -> b Source #

Vector Vector Word16 Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s Word16 -> ST s (Vector Word16) Source #

basicUnsafeThaw :: Vector Word16 -> ST s (Mutable Vector s Word16) Source #

basicLength :: Vector Word16 -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector Word16 -> Vector Word16 Source #

basicUnsafeIndexM :: Vector Word16 -> Int -> Box Word16 Source #

basicUnsafeCopy :: Mutable Vector s Word16 -> Vector Word16 -> ST s () Source #

elemseq :: Vector Word16 -> Word16 -> b -> b Source #

Vector Vector Word32 Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s Word32 -> ST s (Vector Word32) Source #

basicUnsafeThaw :: Vector Word32 -> ST s (Mutable Vector s Word32) Source #

basicLength :: Vector Word32 -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector Word32 -> Vector Word32 Source #

basicUnsafeIndexM :: Vector Word32 -> Int -> Box Word32 Source #

basicUnsafeCopy :: Mutable Vector s Word32 -> Vector Word32 -> ST s () Source #

elemseq :: Vector Word32 -> Word32 -> b -> b Source #

Vector Vector Word64 Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s Word64 -> ST s (Vector Word64) Source #

basicUnsafeThaw :: Vector Word64 -> ST s (Mutable Vector s Word64) Source #

basicLength :: Vector Word64 -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector Word64 -> Vector Word64 Source #

basicUnsafeIndexM :: Vector Word64 -> Int -> Box Word64 Source #

basicUnsafeCopy :: Mutable Vector s Word64 -> Vector Word64 -> ST s () Source #

elemseq :: Vector Word64 -> Word64 -> b -> b Source #

Vector Vector Word8 Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s Word8 -> ST s (Vector Word8) Source #

basicUnsafeThaw :: Vector Word8 -> ST s (Mutable Vector s Word8) Source #

basicLength :: Vector Word8 -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector Word8 -> Vector Word8 Source #

basicUnsafeIndexM :: Vector Word8 -> Int -> Box Word8 Source #

basicUnsafeCopy :: Mutable Vector s Word8 -> Vector Word8 -> ST s () Source #

elemseq :: Vector Word8 -> Word8 -> b -> b Source #

Vector Vector () Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s () -> ST s (Vector ()) Source #

basicUnsafeThaw :: Vector () -> ST s (Mutable Vector s ()) Source #

basicLength :: Vector () -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector () -> Vector () Source #

basicUnsafeIndexM :: Vector () -> Int -> Box () Source #

basicUnsafeCopy :: Mutable Vector s () -> Vector () -> ST s () Source #

elemseq :: Vector () -> () -> b -> b Source #

Vector Vector Bool Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s Bool -> ST s (Vector Bool) Source #

basicUnsafeThaw :: Vector Bool -> ST s (Mutable Vector s Bool) Source #

basicLength :: Vector Bool -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector Bool -> Vector Bool Source #

basicUnsafeIndexM :: Vector Bool -> Int -> Box Bool Source #

basicUnsafeCopy :: Mutable Vector s Bool -> Vector Bool -> ST s () Source #

elemseq :: Vector Bool -> Bool -> b -> b Source #

Vector Vector Char Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s Char -> ST s (Vector Char) Source #

basicUnsafeThaw :: Vector Char -> ST s (Mutable Vector s Char) Source #

basicLength :: Vector Char -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector Char -> Vector Char Source #

basicUnsafeIndexM :: Vector Char -> Int -> Box Char Source #

basicUnsafeCopy :: Mutable Vector s Char -> Vector Char -> ST s () Source #

elemseq :: Vector Char -> Char -> b -> b Source #

Vector Vector Double Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s Double -> ST s (Vector Double) Source #

basicUnsafeThaw :: Vector Double -> ST s (Mutable Vector s Double) Source #

basicLength :: Vector Double -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector Double -> Vector Double Source #

basicUnsafeIndexM :: Vector Double -> Int -> Box Double Source #

basicUnsafeCopy :: Mutable Vector s Double -> Vector Double -> ST s () Source #

elemseq :: Vector Double -> Double -> b -> b Source #

Vector Vector Float Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s Float -> ST s (Vector Float) Source #

basicUnsafeThaw :: Vector Float -> ST s (Mutable Vector s Float) Source #

basicLength :: Vector Float -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector Float -> Vector Float Source #

basicUnsafeIndexM :: Vector Float -> Int -> Box Float Source #

basicUnsafeCopy :: Mutable Vector s Float -> Vector Float -> ST s () Source #

elemseq :: Vector Float -> Float -> b -> b Source #

Vector Vector Int Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s Int -> ST s (Vector Int) Source #

basicUnsafeThaw :: Vector Int -> ST s (Mutable Vector s Int) Source #

basicLength :: Vector Int -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector Int -> Vector Int Source #

basicUnsafeIndexM :: Vector Int -> Int -> Box Int Source #

basicUnsafeCopy :: Mutable Vector s Int -> Vector Int -> ST s () Source #

elemseq :: Vector Int -> Int -> b -> b Source #

Vector Vector Word Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s Word -> ST s (Vector Word) Source #

basicUnsafeThaw :: Vector Word -> ST s (Mutable Vector s Word) Source #

basicLength :: Vector Word -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector Word -> Vector Word Source #

basicUnsafeIndexM :: Vector Word -> Int -> Box Word Source #

basicUnsafeCopy :: Mutable Vector s Word -> Vector Word -> ST s () Source #

elemseq :: Vector Word -> Word -> b -> b Source #

Unbox a => Vector Vector (Complex a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (Complex a) -> ST s (Vector (Complex a)) Source #

basicUnsafeThaw :: Vector (Complex a) -> ST s (Mutable Vector s (Complex a)) Source #

basicLength :: Vector (Complex a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (Complex a) -> Vector (Complex a) Source #

basicUnsafeIndexM :: Vector (Complex a) -> Int -> Box (Complex a) Source #

basicUnsafeCopy :: Mutable Vector s (Complex a) -> Vector (Complex a) -> ST s () Source #

elemseq :: Vector (Complex a) -> Complex a -> b -> b Source #

Unbox a => Vector Vector (First a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (First a) -> ST s (Vector (First a)) Source #

basicUnsafeThaw :: Vector (First a) -> ST s (Mutable Vector s (First a)) Source #

basicLength :: Vector (First a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (First a) -> Vector (First a) Source #

basicUnsafeIndexM :: Vector (First a) -> Int -> Box (First a) Source #

basicUnsafeCopy :: Mutable Vector s (First a) -> Vector (First a) -> ST s () Source #

elemseq :: Vector (First a) -> First a -> b -> b Source #

Unbox a => Vector Vector (Last a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (Last a) -> ST s (Vector (Last a)) Source #

basicUnsafeThaw :: Vector (Last a) -> ST s (Mutable Vector s (Last a)) Source #

basicLength :: Vector (Last a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (Last a) -> Vector (Last a) Source #

basicUnsafeIndexM :: Vector (Last a) -> Int -> Box (Last a) Source #

basicUnsafeCopy :: Mutable Vector s (Last a) -> Vector (Last a) -> ST s () Source #

elemseq :: Vector (Last a) -> Last a -> b -> b Source #

Unbox a => Vector Vector (Max a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (Max a) -> ST s (Vector (Max a)) Source #

basicUnsafeThaw :: Vector (Max a) -> ST s (Mutable Vector s (Max a)) Source #

basicLength :: Vector (Max a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (Max a) -> Vector (Max a) Source #

basicUnsafeIndexM :: Vector (Max a) -> Int -> Box (Max a) Source #

basicUnsafeCopy :: Mutable Vector s (Max a) -> Vector (Max a) -> ST s () Source #

elemseq :: Vector (Max a) -> Max a -> b -> b Source #

Unbox a => Vector Vector (Min a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (Min a) -> ST s (Vector (Min a)) Source #

basicUnsafeThaw :: Vector (Min a) -> ST s (Mutable Vector s (Min a)) Source #

basicLength :: Vector (Min a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (Min a) -> Vector (Min a) Source #

basicUnsafeIndexM :: Vector (Min a) -> Int -> Box (Min a) Source #

basicUnsafeCopy :: Mutable Vector s (Min a) -> Vector (Min a) -> ST s () Source #

elemseq :: Vector (Min a) -> Min a -> b -> b Source #

Unbox a => Vector Vector (WrappedMonoid a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (WrappedMonoid a) -> ST s (Vector (WrappedMonoid a)) Source #

basicUnsafeThaw :: Vector (WrappedMonoid a) -> ST s (Mutable Vector s (WrappedMonoid a)) Source #

basicLength :: Vector (WrappedMonoid a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (WrappedMonoid a) -> Vector (WrappedMonoid a) Source #

basicUnsafeIndexM :: Vector (WrappedMonoid a) -> Int -> Box (WrappedMonoid a) Source #

basicUnsafeCopy :: Mutable Vector s (WrappedMonoid a) -> Vector (WrappedMonoid a) -> ST s () Source #

elemseq :: Vector (WrappedMonoid a) -> WrappedMonoid a -> b -> b Source #

Unbox a => Vector Vector (Identity a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (Identity a) -> ST s (Vector (Identity a)) Source #

basicUnsafeThaw :: Vector (Identity a) -> ST s (Mutable Vector s (Identity a)) Source #

basicLength :: Vector (Identity a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (Identity a) -> Vector (Identity a) Source #

basicUnsafeIndexM :: Vector (Identity a) -> Int -> Box (Identity a) Source #

basicUnsafeCopy :: Mutable Vector s (Identity a) -> Vector (Identity a) -> ST s () Source #

elemseq :: Vector (Identity a) -> Identity a -> b -> b Source #

Unbox a => Vector Vector (Down a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (Down a) -> ST s (Vector (Down a)) Source #

basicUnsafeThaw :: Vector (Down a) -> ST s (Mutable Vector s (Down a)) Source #

basicLength :: Vector (Down a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (Down a) -> Vector (Down a) Source #

basicUnsafeIndexM :: Vector (Down a) -> Int -> Box (Down a) Source #

basicUnsafeCopy :: Mutable Vector s (Down a) -> Vector (Down a) -> ST s () Source #

elemseq :: Vector (Down a) -> Down a -> b -> b Source #

Unbox a => Vector Vector (Dual a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (Dual a) -> ST s (Vector (Dual a)) Source #

basicUnsafeThaw :: Vector (Dual a) -> ST s (Mutable Vector s (Dual a)) Source #

basicLength :: Vector (Dual a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (Dual a) -> Vector (Dual a) Source #

basicUnsafeIndexM :: Vector (Dual a) -> Int -> Box (Dual a) Source #

basicUnsafeCopy :: Mutable Vector s (Dual a) -> Vector (Dual a) -> ST s () Source #

elemseq :: Vector (Dual a) -> Dual a -> b -> b Source #

Unbox a => Vector Vector (Product a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (Product a) -> ST s (Vector (Product a)) Source #

basicUnsafeThaw :: Vector (Product a) -> ST s (Mutable Vector s (Product a)) Source #

basicLength :: Vector (Product a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (Product a) -> Vector (Product a) Source #

basicUnsafeIndexM :: Vector (Product a) -> Int -> Box (Product a) Source #

basicUnsafeCopy :: Mutable Vector s (Product a) -> Vector (Product a) -> ST s () Source #

elemseq :: Vector (Product a) -> Product a -> b -> b Source #

Unbox a => Vector Vector (Sum a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (Sum a) -> ST s (Vector (Sum a)) Source #

basicUnsafeThaw :: Vector (Sum a) -> ST s (Mutable Vector s (Sum a)) Source #

basicLength :: Vector (Sum a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (Sum a) -> Vector (Sum a) Source #

basicUnsafeIndexM :: Vector (Sum a) -> Int -> Box (Sum a) Source #

basicUnsafeCopy :: Mutable Vector s (Sum a) -> Vector (Sum a) -> ST s () Source #

elemseq :: Vector (Sum a) -> Sum a -> b -> b Source #

Vector Vector (DoNotUnboxLazy a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (DoNotUnboxLazy a) -> ST s (Vector (DoNotUnboxLazy a)) Source #

basicUnsafeThaw :: Vector (DoNotUnboxLazy a) -> ST s (Mutable Vector s (DoNotUnboxLazy a)) Source #

basicLength :: Vector (DoNotUnboxLazy a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (DoNotUnboxLazy a) -> Vector (DoNotUnboxLazy a) Source #

basicUnsafeIndexM :: Vector (DoNotUnboxLazy a) -> Int -> Box (DoNotUnboxLazy a) Source #

basicUnsafeCopy :: Mutable Vector s (DoNotUnboxLazy a) -> Vector (DoNotUnboxLazy a) -> ST s () Source #

elemseq :: Vector (DoNotUnboxLazy a) -> DoNotUnboxLazy a -> b -> b Source #

NFData a => Vector Vector (DoNotUnboxNormalForm a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (DoNotUnboxNormalForm a) -> ST s (Vector (DoNotUnboxNormalForm a)) Source #

basicUnsafeThaw :: Vector (DoNotUnboxNormalForm a) -> ST s (Mutable Vector s (DoNotUnboxNormalForm a)) Source #

basicLength :: Vector (DoNotUnboxNormalForm a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (DoNotUnboxNormalForm a) -> Vector (DoNotUnboxNormalForm a) Source #

basicUnsafeIndexM :: Vector (DoNotUnboxNormalForm a) -> Int -> Box (DoNotUnboxNormalForm a) Source #

basicUnsafeCopy :: Mutable Vector s (DoNotUnboxNormalForm a) -> Vector (DoNotUnboxNormalForm a) -> ST s () Source #

elemseq :: Vector (DoNotUnboxNormalForm a) -> DoNotUnboxNormalForm a -> b -> b Source #

Vector Vector (DoNotUnboxStrict a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (DoNotUnboxStrict a) -> ST s (Vector (DoNotUnboxStrict a)) Source #

basicUnsafeThaw :: Vector (DoNotUnboxStrict a) -> ST s (Mutable Vector s (DoNotUnboxStrict a)) Source #

basicLength :: Vector (DoNotUnboxStrict a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (DoNotUnboxStrict a) -> Vector (DoNotUnboxStrict a) Source #

basicUnsafeIndexM :: Vector (DoNotUnboxStrict a) -> Int -> Box (DoNotUnboxStrict a) Source #

basicUnsafeCopy :: Mutable Vector s (DoNotUnboxStrict a) -> Vector (DoNotUnboxStrict a) -> ST s () Source #

elemseq :: Vector (DoNotUnboxStrict a) -> DoNotUnboxStrict a -> b -> b Source #

Prim a => Vector Vector (UnboxViaPrim a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (UnboxViaPrim a) -> ST s (Vector (UnboxViaPrim a)) Source #

basicUnsafeThaw :: Vector (UnboxViaPrim a) -> ST s (Mutable Vector s (UnboxViaPrim a)) Source #

basicLength :: Vector (UnboxViaPrim a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (UnboxViaPrim a) -> Vector (UnboxViaPrim a) Source #

basicUnsafeIndexM :: Vector (UnboxViaPrim a) -> Int -> Box (UnboxViaPrim a) Source #

basicUnsafeCopy :: Mutable Vector s (UnboxViaPrim a) -> Vector (UnboxViaPrim a) -> ST s () Source #

elemseq :: Vector (UnboxViaPrim a) -> UnboxViaPrim a -> b -> b Source #

(Unbox a, Unbox b) => Vector Vector (Arg a b) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (Arg a b) -> ST s (Vector (Arg a b)) Source #

basicUnsafeThaw :: Vector (Arg a b) -> ST s (Mutable Vector s (Arg a b)) Source #

basicLength :: Vector (Arg a b) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (Arg a b) -> Vector (Arg a b) Source #

basicUnsafeIndexM :: Vector (Arg a b) -> Int -> Box (Arg a b) Source #

basicUnsafeCopy :: Mutable Vector s (Arg a b) -> Vector (Arg a b) -> ST s () Source #

elemseq :: Vector (Arg a b) -> Arg a b -> b0 -> b0 Source #

(IsoUnbox a b, Unbox b) => Vector Vector (As a b) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (As a b) -> ST s (Vector (As a b)) Source #

basicUnsafeThaw :: Vector (As a b) -> ST s (Mutable Vector s (As a b)) Source #

basicLength :: Vector (As a b) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (As a b) -> Vector (As a b) Source #

basicUnsafeIndexM :: Vector (As a b) -> Int -> Box (As a b) Source #

basicUnsafeCopy :: Mutable Vector s (As a b) -> Vector (As a b) -> ST s () Source #

elemseq :: Vector (As a b) -> As a b -> b0 -> b0 Source #

(Unbox a, Unbox b) => Vector Vector (a, b) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (a, b) -> ST s (Vector (a, b)) Source #

basicUnsafeThaw :: Vector (a, b) -> ST s (Mutable Vector s (a, b)) Source #

basicLength :: Vector (a, b) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (a, b) -> Vector (a, b) Source #

basicUnsafeIndexM :: Vector (a, b) -> Int -> Box (a, b) Source #

basicUnsafeCopy :: Mutable Vector s (a, b) -> Vector (a, b) -> ST s () Source #

elemseq :: Vector (a, b) -> (a, b) -> b0 -> b0 Source #

Unbox a => Vector Vector (Const a b) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (Const a b) -> ST s (Vector (Const a b)) Source #

basicUnsafeThaw :: Vector (Const a b) -> ST s (Mutable Vector s (Const a b)) Source #

basicLength :: Vector (Const a b) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (Const a b) -> Vector (Const a b) Source #

basicUnsafeIndexM :: Vector (Const a b) -> Int -> Box (Const a b) Source #

basicUnsafeCopy :: Mutable Vector s (Const a b) -> Vector (Const a b) -> ST s () Source #

elemseq :: Vector (Const a b) -> Const a b -> b0 -> b0 Source #

Unbox (f a) => Vector Vector (Alt f a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (Alt f a) -> ST s (Vector (Alt f a)) Source #

basicUnsafeThaw :: Vector (Alt f a) -> ST s (Mutable Vector s (Alt f a)) Source #

basicLength :: Vector (Alt f a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (Alt f a) -> Vector (Alt f a) Source #

basicUnsafeIndexM :: Vector (Alt f a) -> Int -> Box (Alt f a) Source #

basicUnsafeCopy :: Mutable Vector s (Alt f a) -> Vector (Alt f a) -> ST s () Source #

elemseq :: Vector (Alt f a) -> Alt f a -> b -> b Source #

(Unbox a, Unbox b, Unbox c) => Vector Vector (a, b, c) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (a, b, c) -> ST s (Vector (a, b, c)) Source #

basicUnsafeThaw :: Vector (a, b, c) -> ST s (Mutable Vector s (a, b, c)) Source #

basicLength :: Vector (a, b, c) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (a, b, c) -> Vector (a, b, c) Source #

basicUnsafeIndexM :: Vector (a, b, c) -> Int -> Box (a, b, c) Source #

basicUnsafeCopy :: Mutable Vector s (a, b, c) -> Vector (a, b, c) -> ST s () Source #

elemseq :: Vector (a, b, c) -> (a, b, c) -> b0 -> b0 Source #

(Unbox a, Unbox b, Unbox c, Unbox d) => Vector Vector (a, b, c, d) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (a, b, c, d) -> ST s (Vector (a, b, c, d)) Source #

basicUnsafeThaw :: Vector (a, b, c, d) -> ST s (Mutable Vector s (a, b, c, d)) Source #

basicLength :: Vector (a, b, c, d) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (a, b, c, d) -> Vector (a, b, c, d) Source #

basicUnsafeIndexM :: Vector (a, b, c, d) -> Int -> Box (a, b, c, d) Source #

basicUnsafeCopy :: Mutable Vector s (a, b, c, d) -> Vector (a, b, c, d) -> ST s () Source #

elemseq :: Vector (a, b, c, d) -> (a, b, c, d) -> b0 -> b0 Source #

Unbox (f (g a)) => Vector Vector (Compose f g a) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (Compose f g a) -> ST s (Vector (Compose f g a)) Source #

basicUnsafeThaw :: Vector (Compose f g a) -> ST s (Mutable Vector s (Compose f g a)) Source #

basicLength :: Vector (Compose f g a) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (Compose f g a) -> Vector (Compose f g a) Source #

basicUnsafeIndexM :: Vector (Compose f g a) -> Int -> Box (Compose f g a) Source #

basicUnsafeCopy :: Mutable Vector s (Compose f g a) -> Vector (Compose f g a) -> ST s () Source #

elemseq :: Vector (Compose f g a) -> Compose f g a -> b -> b Source #

(Unbox a, Unbox b, Unbox c, Unbox d, Unbox e) => Vector Vector (a, b, c, d, e) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (a, b, c, d, e) -> ST s (Vector (a, b, c, d, e)) Source #

basicUnsafeThaw :: Vector (a, b, c, d, e) -> ST s (Mutable Vector s (a, b, c, d, e)) Source #

basicLength :: Vector (a, b, c, d, e) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (a, b, c, d, e) -> Vector (a, b, c, d, e) Source #

basicUnsafeIndexM :: Vector (a, b, c, d, e) -> Int -> Box (a, b, c, d, e) Source #

basicUnsafeCopy :: Mutable Vector s (a, b, c, d, e) -> Vector (a, b, c, d, e) -> ST s () Source #

elemseq :: Vector (a, b, c, d, e) -> (a, b, c, d, e) -> b0 -> b0 Source #

(Unbox a, Unbox b, Unbox c, Unbox d, Unbox e, Unbox f) => Vector Vector (a, b, c, d, e, f) Source # |

Instance details

Defined in Data.Vector.Unboxed.Base

Methods

basicUnsafeFreeze :: Mutable Vector s (a, b, c, d, e, f) -> ST s (Vector (a, b, c, d, e, f)) Source #

basicUnsafeThaw :: Vector (a, b, c, d, e, f) -> ST s (Mutable Vector s (a, b, c, d, e, f)) Source #

basicLength :: Vector (a, b, c, d, e, f) -> Int Source #

basicUnsafeSlice :: Int -> Int -> Vector (a, b, c, d, e, f) -> Vector (a, b, c, d, e, f) Source #

basicUnsafeIndexM :: Vector (a, b, c, d, e, f) -> Int -> Box (a, b, c, d, e, f) Source #

basicUnsafeCopy :: Mutable Vector s (a, b, c, d, e, f) -> Vector (a, b, c, d, e, f) -> ST s () Source #

elemseq :: Vector (a, b, c, d, e, f) -> (a, b, c, d, e, f) -> b0 -> b0 Source #

type family Mutable (v :: Type -> Type) = (mv :: Type -> Type -> Type) | mv -> v Source #

`Mutable v s a` is the mutable version of the immutable vector type `v a` with the state token `s`. It is injective on GHC 8 and newer.

#### Instances

Instances details

type Mutable Array Source # |
Instance details Defined in Data.Vector.Generic.Base type Mutable Array = MutableArray
type Mutable PrimArray Source # |
Instance details Defined in Data.Vector.Generic.Base type Mutable PrimArray = MutablePrimArray
type Mutable SmallArray Source # |
Instance details Defined in Data.Vector.Generic.Base type Mutable SmallArray = SmallMutableArray
type Mutable Vector Source # |
Instance details Defined in Data.Vector type Mutable Vector = MVector
type Mutable Vector Source # |
Instance details Defined in Data.Vector.Primitive type Mutable Vector = MVector
type Mutable Vector Source # |
Instance details Defined in Data.Vector.Storable type Mutable Vector = MVector
type Mutable Vector Source # |
Instance details Defined in Data.Vector.Strict type Mutable Vector = MVector
type Mutable Vector Source # |
Instance details Defined in Data.Vector.Unboxed.Base type Mutable Vector = MVector

# Accessors

## Length information

length :: Vector v a => v a -> Int Source #

O(1) Yield the length of the vector.

null :: Vector v a => v a -> Bool Source #

O(1) Test whether a vector is empty.

## Indexing

(!) :: (HasCallStack, Vector v a) => v a -> Int -> a infixl 9 Source #

O(1) Indexing.

(!?) :: Vector v a => v a -> Int -> Maybe a infixl 9 Source #

O(1) Safe indexing.

head :: Vector v a => v a -> a Source #

O(1) First element.

last :: Vector v a => v a -> a Source #

O(1) Last element.

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

O(1) Unsafe indexing without bounds checking.

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

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

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

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

## Monadic indexing

indexM :: (HasCallStack, Vector v a, Monad m) => v 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 :: (Vector v a, Monad m) => v 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 :: (Vector v a, Monad m) => v 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 :: (Vector v a, Monad m) => v 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 :: (Vector v a, Monad m) => v 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 :: (Vector v a, Monad m) => v 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)

slice Source #

Arguments

:: (HasCallStack, Vector v a) |
=> Int | `i` starting index
-> Int | `n` length
-> v a |
-> v a |

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

init :: Vector v a => v a -> v a Source #

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

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

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

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

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

drop :: Vector v a => Int -> v a -> v 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.

splitAt :: Vector v a => Int -> v a -> (v a, v a) Source #

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

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

Since: 0.7.1

uncons :: Vector v a => v a -> Maybe (a, v a) Source #

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

Since: 0.12.2.0

unsnoc :: Vector v a => v a -> Maybe (v a, a) Source #

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

Since: 0.12.2.0

unsafeSlice Source #

Arguments

:: Vector v a |
=> Int | `i` starting index
-> Int | `n` length
-> v a |
-> v 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 :: Vector v a => v a -> v a Source #

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

unsafeTail :: Vector v a => v a -> v a Source #

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

unsafeTake :: Vector v a => Int -> v a -> v 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 :: Vector v a => Int -> v a -> v 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

empty :: Vector v a => v a Source #

O(1) The empty vector.

singleton :: Vector v a => a -> v a Source #

O(1) A vector with exactly one element.

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

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

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

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

iterateN :: Vector v a => Int -> (a -> a) -> a -> v 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}} \)

Since: 0.7.1

## Monadic initialisation

replicateM :: (Monad m, Vector v a) => Int -> m a -> m (v a) Source #

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

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

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

iterateNM :: (Monad m, Vector v a) => Int -> (a -> m a) -> a -> m (v 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 :: Vector v a => (forall s. ST s (Mutable v s a)) -> v 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, Vector v a) => (forall s. ST s (f (Mutable v s a))) -> f (v a) Source #

Execute the monadic action and freeze the resulting vectors.

## Unfolding

unfoldr :: Vector v a => (b -> Maybe (a, b)) -> b -> v a Source #

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 :: Vector v a => Int -> (b -> Maybe (a, b)) -> b -> v a Source #

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

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

unfoldrExactN :: Vector v a => Int -> (b -> (a, b)) -> b -> v 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

unfoldrM :: (Monad m, Vector v a) => (b -> m (Maybe (a, b))) -> b -> m (v a) Source #

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

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

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

unfoldrExactNM :: (Monad m, Vector v a) => Int -> (b -> m (a, b)) -> b -> m (v 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 :: Vector v a => Int -> (v a -> a) -> v 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 :: Vector v a => Int -> (v a -> a) -> v 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 :: (Vector v a, Num a) => a -> Int -> v 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 :: (Vector v a, Num a) => a -> a -> Int -> v 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 :: (Vector v a, Enum a) => a -> a -> v a Source #

O(n) Enumerate values from `x` to `y`.

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

enumFromThenTo :: (Vector v a, Enum a) => a -> a -> a -> v 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

cons :: Vector v a => a -> v a -> v a Source #

O(n) Prepend an element.

snoc :: Vector v a => v a -> a -> v a Source #

O(n) Append an element.

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

O(m+n) Concatenate two vectors.

concat :: Vector v a => [v a] -> v a Source #

O(n) Concatenate all vectors in the list.

concatNE :: Vector v a => NonEmpty (v a) -> v a Source #

O(n) Concatenate all vectors in the non-empty list.

## Restricting memory usage

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

O(n) Yield the argument, but force it not to retain any extra memory, 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 #

Arguments

:: Vector v a |
=> v a | initial vector (of length `m`)
-> [(Int, a)] | list of index/value pairs (of length `n`)
-> v a |

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

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

update Source #

Arguments

:: (Vector v a, Vector v (Int, a)) |
=> v a | initial vector (of length `m`)
-> v (Int, a) | vector of index/value pairs (of length `n`)
-> v 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 #

Arguments

:: (Vector v a, Vector v Int) |
=> v a | initial vector (of length `m`)
-> v Int | index vector (of length `n1`)
-> v a | value vector (of length `n2`)
-> v 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>

This function is useful for instances of `Vector` that cannot store pairs. Otherwise, `update` is probably more convenient.

    update_ xs is ys = update xs (zip is ys)

unsafeUpd :: Vector v a => v a -> [(Int, a)] -> v a Source #

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

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

Same as `update`, but without bounds checking.

unsafeUpdate_ :: (Vector v a, Vector v Int) => v a -> v Int -> v a -> v a Source #

Same as `update_`, but without bounds checking.

## Accumulations

accum Source #

Arguments

:: Vector v a |
=> (a -> b -> a) | accumulating function `f`
-> v a | initial vector (of length `m`)
-> [(Int, b)] | list of index/value pairs (of length `n`)
-> v 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

Expand

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

accumulate Source #

Arguments

:: (Vector v a, Vector v (Int, b)) |
=> (a -> b -> a) | accumulating function `f`
-> v a | initial vector (of length `m`)
-> v (Int, b) | vector of index/value pairs (of length `n`)
-> v 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

Expand

    >>> import qualified Data.Vector.Strict as V
    >>> V.accumulate (+) (V.fromList [1000,2000,3000]) (V.fromList [(2,4),(1,6),(0,3),(1,10)])
    [1003,2016,3004]

accumulate_ Source #

Arguments

:: (Vector v a, Vector v Int, Vector v b) |
=> (a -> b -> a) | accumulating function `f`
-> v a | initial vector (of length `m`)
-> v Int | index vector (of length `n1`)
-> v b | value vector (of length `n2`)
-> v a |

O(m+min(n1,n2)) For each index `i` from the index vector and the corresponding value `b` from 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>

This function is useful for instances of `Vector` that cannot store pairs. Otherwise, `accumulate` is probably more convenient:

    accumulate_ f as is bs = accumulate f as (zip is bs)

unsafeAccum :: Vector v a => (a -> b -> a) -> v a -> [(Int, b)] -> v a Source #

Same as `accum`, but without bounds checking.

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

Same as `accumulate`, but without bounds checking.

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

Same as `accumulate_`, but without bounds checking.

## Permutations

reverse :: Vector v a => v a -> v a Source #

O(n) Reverse a vector.

backpermute Source #

Arguments

:: (HasCallStack, Vector v a, Vector v Int) |
=> v a | `xs` value vector
-> v Int | `is` index vector (of length `n`)
-> v a |

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 :: (Vector v a, Vector v Int) => v a -> v Int -> v a Source #

Same as `backpermute`, but without bounds checking.

## Safe destructive updates

modify :: Vector v a => (forall s. Mutable v s a -> ST s ()) -> v a -> v a Source #

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

#### Examples

Expand

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

# Elementwise operations

## Indexing

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

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

## Mapping

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

O(n) Map a function over a vector.

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

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

concatMap :: (Vector v a, Vector v b) => (a -> v b) -> v a -> v b Source #

Map a function over a vector and concatenate the results.

## Monadic mapping

mapM :: (Monad m, Vector v a, Vector v b) => (a -> m b) -> v a -> m (v b) Source #

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

imapM :: (Monad m, Vector v a, Vector v b) => (Int -> a -> m b) -> v a -> m (v 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, Vector v a) => (a -> m b) -> v a -> m () Source #

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

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

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

forM :: (Monad m, Vector v a, Vector v b) => v a -> (a -> m b) -> m (v 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, Vector v a) => v 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_``.

iforM :: (Monad m, Vector v a, Vector v b) => v a -> (Int -> a -> m b) -> m (v b) Source #

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

Since: 0.12.2.0

iforM_ :: (Monad m, Vector v a) => v a -> (Int -> a -> m b) -> m () Source #

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

Since: 0.12.2.0

## Zipping

zipWith :: (Vector v a, Vector v b, Vector v c) => (a -> b -> c) -> v a -> v b -> v c Source #

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

zipWith3 :: (Vector v a, Vector v b, Vector v c, Vector v d) => (a -> b -> c -> d) -> v a -> v b -> v c -> v d Source #

Zip three vectors with the given function.

zipWith4 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e) => (a -> b -> c -> d -> e) -> v a -> v b -> v c -> v d -> v e Source #

zipWith5 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e, Vector v f) => (a -> b -> c -> d -> e -> f) -> v a -> v b -> v c -> v d -> v e -> v f Source #

zipWith6 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e, Vector v f, Vector v g) => (a -> b -> c -> d -> e -> f -> g) -> v a -> v b -> v c -> v d -> v e -> v f -> v g Source #

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

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

izipWith3 :: (Vector v a, Vector v b, Vector v c, Vector v d) => (Int -> a -> b -> c -> d) -> v a -> v b -> v c -> v d Source #

Zip three vectors and their indices with the given function.

izipWith4 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e) => (Int -> a -> b -> c -> d -> e) -> v a -> v b -> v c -> v d -> v e Source #

izipWith5 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e, Vector v f) => (Int -> a -> b -> c -> d -> e -> f) -> v a -> v b -> v c -> v d -> v e -> v f Source #

izipWith6 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e, Vector v f, Vector v g) => (Int -> a -> b -> c -> d -> e -> f -> g) -> v a -> v b -> v c -> v d -> v e -> v f -> v g Source #

zip :: (Vector v a, Vector v b, Vector v (a, b)) => v a -> v b -> v (a, b) Source #

O(min(m,n)) Zip two vectors.

zip3 :: (Vector v a, Vector v b, Vector v c, Vector v (a, b, c)) => v a -> v b -> v c -> v (a, b, c) Source #

Zip together three vectors into a vector of triples.

zip4 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v (a, b, c, d)) => v a -> v b -> v c -> v d -> v (a, b, c, d) Source #

zip5 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e, Vector v (a, b, c, d, e)) => v a -> v b -> v c -> v d -> v e -> v (a, b, c, d, e) Source #

zip6 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e, Vector v f, Vector v (a, b, c, d, e, f)) => v a -> v b -> v c -> v d -> v e -> v f -> v (a, b, c, d, e, f) Source #

## Monadic zipping

zipWithM :: (Monad m, Vector v a, Vector v b, Vector v c) => (a -> b -> m c) -> v a -> v b -> m (v c) Source #

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

izipWithM :: (Monad m, Vector v a, Vector v b, Vector v c) => (Int -> a -> b -> m c) -> v a -> v b -> m (v 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, Vector v a, Vector v b) => (a -> b -> m c) -> v a -> v b -> m () Source #

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

izipWithM_ :: (Monad m, Vector v a, Vector v b) => (Int -> a -> b -> m c) -> v a -> v 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

unzip :: (Vector v a, Vector v b, Vector v (a, b)) => v (a, b) -> (v a, v b) Source #

O(min(m,n)) Unzip a vector of pairs.

unzip3 :: (Vector v a, Vector v b, Vector v c, Vector v (a, b, c)) => v (a, b, c) -> (v a, v b, v c) Source #

unzip4 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v (a, b, c, d)) => v (a, b, c, d) -> (v a, v b, v c, v d) Source #

unzip5 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e, Vector v (a, b, c, d, e)) => v (a, b, c, d, e) -> (v a, v b, v c, v d, v e) Source #

unzip6 :: (Vector v a, Vector v b, Vector v c, Vector v d, Vector v e, Vector v f, Vector v (a, b, c, d, e, f)) => v (a, b, c, d, e, f) -> (v a, v b, v c, v d, v e, v f) Source #

# Working with predicates

## Filtering

filter :: Vector v a => (a -> Bool) -> v a -> v a Source #

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

ifilter :: Vector v a => (Int -> a -> Bool) -> v a -> v 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, Vector v a) => (a -> m Bool) -> v a -> m (v a) Source #

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

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

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

#### Examples

Expand

    >>> import qualified Data.Vector.Strict as V
    >>> V.uniq $ V.fromList [1,3,3,200,3]
    [1,3,200,3]
    >>> import Data.Semigroup
    >>> V.uniq $ V.fromList [ Arg 1 'a', Arg 1 'b', Arg 1 'c']
    [Arg 1 'a']

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

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

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

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

mapMaybeM :: (Monad m, Vector v a, Vector v b) => (a -> m (Maybe b)) -> v a -> m (v 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, Vector v a, Vector v b) => (Int -> a -> m (Maybe b)) -> v a -> m (v 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 :: Vector v a => (a -> Bool) -> v a -> v 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 :: Vector v a => (a -> Bool) -> v a -> v a Source #

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

## Partitioning

partition :: Vector v a => (a -> Bool) -> v a -> (v a, v 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`.

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

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

Since: 0.12.1.0

unstablePartition :: Vector v a => (a -> Bool) -> v a -> (v a, v 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 :: Vector v a => (a -> Bool) -> v a -> (v a, v a) Source #

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

Does not fuse.

#### Examples

Expand

    >>> import qualified Data.Vector.Strict as V
    >>> V.span (<4) $ V.generate 10 id
    ([0,1,2,3],[4,5,6,7,8,9])

break :: Vector v a => (a -> Bool) -> v a -> (v a, v a) Source #

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

Does not fuse.

#### Examples

Expand

    >>> import qualified Data.Vector.Strict as V
    >>> V.break (>4) $ V.generate 10 id
    ([0,1,2,3,4],[5,6,7,8,9])

spanR :: Vector v a => (a -> Bool) -> v a -> (v a, v a) Source #

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

Does not fuse.

#### Examples

Expand

    >>> import qualified Data.Vector.Strict as V
    >>> V.spanR (>4) $ V.generate 10 id
    ([5,6,7,8,9],[0,1,2,3,4])

breakR :: Vector v a => (a -> Bool) -> v a -> (v a, v a) Source #

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

Does not fuse.

@since NEXT_VERSION

#### Examples

Expand

    >>> import qualified Data.Vector.Strict as V
    >>> V.breakR (<5) $ V.generate 10 id
    ([5,6,7,8,9],[0,1,2,3,4])

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

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

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.

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

See also `groupBy`.

Since: 0.13.0.1

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

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

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

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

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

See also `group`.

Since: 0.13.0.1

## Searching

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

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

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

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

find :: Vector v a => (a -> Bool) -> v a -> Maybe a Source #

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

findIndex :: Vector v a => (a -> Bool) -> v a -> Maybe Int Source #

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

findIndexR :: Vector v a => (a -> Bool) -> v a -> Maybe Int Source #

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

Does not fuse.

Since: 0.12.2.0

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

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

elemIndex :: (Vector v a, Eq a) => a -> v a -> Maybe Int Source #

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

elemIndices :: (Vector v a, Vector v Int, Eq a) => a -> v a -> v 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 :: Vector v b => (a -> b -> a) -> a -> v b -> a Source #

O(n) Left fold.

foldl1 :: Vector v a => (a -> a -> a) -> v a -> a Source #

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

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

O(n) Left fold with strict accumulator.

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

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

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

O(n) Right fold.

foldr1 :: Vector v a => (a -> a -> a) -> v a -> a Source #

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

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

O(n) Right fold with a strict accumulator.

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

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

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

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

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

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

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

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

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

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

foldMap :: (Monoid m, Vector v a) => (a -> m) -> v 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

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

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

Since: 0.12.2.0

## Specialised folds

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

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

#### Examples

Expand

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

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

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

#### Examples

Expand

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

and :: Vector v Bool => v Bool -> Bool Source #

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

#### Examples

Expand

    >>> import qualified Data.Vector.Strict as V
    >>> V.and $ V.fromList [True, False]
    False
    >>> V.and V.empty
    True

or :: Vector v Bool => v Bool -> Bool Source #

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

#### Examples

Expand

    >>> import qualified Data.Vector.Strict as V
    >>> V.or $ V.fromList [True, False]
    True
    >>> V.or V.empty
    False

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

O(n) Compute the sum of the elements.

#### Examples

Expand

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

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

O(n) Compute the product of the elements.

#### Examples

Expand

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

maximum :: (Vector v a, Ord a) => v 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

Expand

    >>> import qualified Data.Vector.Strict as V
    >>> V.maximum $ V.fromList [2, 1]
    2
    >>> import Data.Semigroup
    >>> V.maximum $ V.fromList [Arg 1 'a', Arg 2 'b']
    Arg 2 'b'
    >>> V.maximum $ V.fromList [Arg 1 'a', Arg 1 'b']
    Arg 1 'a'

maximumBy :: Vector v a => (a -> a -> Ordering) -> v 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

Expand

    >>> import Data.Ord
    >>> import qualified Data.Vector.Strict as V
    >>> V.maximumBy (comparing fst) $ V.fromList [(2,'a'), (1,'b')]
    (2,'a')
    >>> V.maximumBy (comparing fst) $ V.fromList [(1,'a'), (1,'b')]
    (1,'a')

maximumOn :: (Ord b, Vector v a) => (a -> b) -> v 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

Expand

    >>> import qualified Data.Vector.Strict as V
    >>> V.maximumOn fst $ V.fromList [(2,'a'), (1,'b')]
    (2,'a')
    >>> V.maximumOn fst $ V.fromList [(1,'a'), (1,'b')]
    (1,'a')

Since: 0.13.0.0

minimum :: (Vector v a, Ord a) => v 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

Expand

    >>> import qualified Data.Vector.Strict as V
    >>> V.minimum $ V.fromList [2, 1]
    1
    >>> import Data.Semigroup
    >>> V.minimum $ V.fromList [Arg 2 'a', Arg 1 'b']
    Arg 1 'b'
    >>> V.minimum $ V.fromList [Arg 1 'a', Arg 1 'b']
    Arg 1 'a'

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

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

Expand

    >>> import Data.Ord
    >>> import qualified Data.Vector.Strict as V
    >>> V.minimumBy (comparing fst) $ V.fromList [(2,'a'), (1,'b')]
    (1,'b')
    >>> V.minimumBy (comparing fst) $ V.fromList [(1,'a'), (1,'b')]
    (1,'a')

minimumOn :: (Ord b, Vector v a) => (a -> b) -> v 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

Expand

    >>> import qualified Data.Vector.Strict as V
    >>> V.minimumOn fst $ V.fromList [(2,'a'), (1,'b')]
    (1,'b')
    >>> V.minimumOn fst $ V.fromList [(1,'a'), (1,'b')]
    (1,'a')

Since: 0.13.0.0

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

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

minIndexBy :: Vector v a => (a -> a -> Ordering) -> v 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

Expand

    >>> import Data.Ord
    >>> import qualified Data.Vector.Strict as V
    >>> V.minIndexBy (comparing fst) $ V.fromList [(2,'a'), (1,'b')]
    1
    >>> V.minIndexBy (comparing fst) $ V.fromList [(1,'a'), (1,'b')]
    0

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

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

maxIndexBy :: Vector v a => (a -> a -> Ordering) -> v 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

Expand

    >>> import Data.Ord
    >>> import qualified Data.Vector.Strict as V
    >>> V.maxIndexBy (comparing fst) $ V.fromList [(2,'a'), (1,'b')]
    0
    >>> V.maxIndexBy (comparing fst) $ V.fromList [(1,'a'), (1,'b')]
    0

## Monadic folds

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

O(n) Monadic fold.

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

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

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

O(n) Monadic fold with strict accumulator.

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

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

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

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

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

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

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

O(n) Monadic fold that discards the result.

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

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

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

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

ifoldM'_ :: (Monad m, Vector v b) => (a -> Int -> b -> m a) -> a -> v 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, Vector v a) => (a -> a -> m a) -> v a -> m () Source #

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

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

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

## Monadic sequencing

sequence :: (Monad m, Vector v a, Vector v (m a)) => v (m a) -> m (v a) Source #

Evaluate each action and collect the results.

sequence_ :: (Monad m, Vector v (m a)) => v (m a) -> m () Source #

Evaluate each action and discard the results.

# Scans

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

O(n) Left-to-right prescan.

    prescanl f z = init . scanl f z

#### Examples

Expand

    >>> import qualified Data.Vector.Strict as V
    >>> V.prescanl (+) 0 (V.fromList [1,2,3,4])
    [0,1,3,6]

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

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

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

O(n) Left-to-right postscan.

    postscanl f z = tail . scanl f z

#### Examples

Expand

    >>> import qualified Data.Vector.Strict as V
    >>> V.postscanl (+) 0 (V.fromList [1,2,3,4])
    [1,3,6,10]

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

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

scanl :: (Vector v a, Vector v b) => (a -> b -> a) -> a -> v b -> v 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

Expand

    >>> import qualified Data.Vector.Strict as V
    >>> V.scanl (+) 0 (V.fromList [1,2,3,4])
    [0,1,3,6,10]

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

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

scanl1 :: Vector v a => (a -> a -> a) -> v a -> v 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

Expand

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

scanl1' :: Vector v a => (a -> a -> a) -> v a -> v 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

Expand

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

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

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

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

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

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

O(n) Right-to-left prescan.

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

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

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

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

O(n) Right-to-left postscan.

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

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

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

O(n) Right-to-left scan.

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

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

scanr1 :: Vector v a => (a -> a -> a) -> v a -> v 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

Expand

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

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

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

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

#### Examples

Expand

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

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

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

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

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

# Conversions

## Lists

toList :: Vector v a => v a -> [a] Source #

O(n) Convert a vector to a list.

fromList :: Vector v a => [a] -> v a Source #

O(n) Convert a list to a vector. During the operation, the vector’s capacity will be doubling until the list's contents are in the vector. Depending on the list’s size, up to half of the vector’s capacity might be empty. If you’d rather avoid this, you can use `fromListN`, which will provide the exact space the list requires but will prevent list fusion, or ``force` . `fromList``, which will create the vector and then copy it without the superfluous space.

Since: 0.4

fromListN :: Vector v a => Int -> [a] -> v 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

Expand

    >>> import qualified Data.Vector.Strict as V
    >>> V.fromListN 3 [1,2,3,4,5]
    [1,2,3]
    >>> V.fromListN 3 [1]
    [1]

## Different vector types

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

O(n) Convert between different vector types.

## Mutable vectors

freeze :: (PrimMonad m, Vector v a) => Mutable v (PrimState m) a -> m (v a) Source #

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

thaw :: (PrimMonad m, Vector v a) => v a -> m (Mutable v (PrimState m) a) Source #

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

copy :: (HasCallStack, PrimMonad m, Vector v a) => Mutable v (PrimState m) a -> v a -> m () Source #

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

unsafeFreeze :: (PrimMonad m, Vector v a) => Mutable v (PrimState m) a -> m (v 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 :: (PrimMonad m, Vector v a) => v a -> m (Mutable v (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 :: (PrimMonad m, Vector v a) => Mutable v (PrimState m) a -> v 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.

# Fusion support

## Conversion to/from Bundles

stream :: Vector v a => v a -> Bundle v a Source #

O(1) Convert a vector to a `Bundle`.

unstream :: Vector v a => Bundle v a -> v a Source #

O(n) Construct a vector from a `Bundle`.

unstreamM :: forall m v a (u :: Type -> Type). (Monad m, Vector v a) => MBundle m u a -> m (v a) Source #

Load a monadic stream bundle into a newly allocated vector. This function goes through a list, so prefer using `unstream`, unless you need to be in a monad.

Since: 0.12.2.0

streamR :: forall v a (u :: Type -> Type). Vector v a => v a -> Bundle u a Source #

O(1) Convert a vector to a `Bundle`, proceeding from right to left.

unstreamR :: Vector v a => Bundle v a -> v a Source #

O(n) Construct a vector from a `Bundle`, proceeding from right to left.

## Recycling support

new :: Vector v a => New v a -> v a Source #

Construct a vector from a monadic initialiser.

clone :: Vector v a => v a -> New v a Source #

Convert a vector to an initialiser which, when run, produces a copy of the vector.

# Utilities

## Comparisons

eq :: (Vector v a, Eq a) => v a -> v a -> Bool Source #

O(n) Check if two vectors are equal. All `Vector` instances are also instances of `Eq` and it is usually more appropriate to use those. This function is primarily intended for implementing `Eq` instances for new vector types.

cmp :: (Vector v a, Ord a) => v a -> v a -> Ordering Source #

O(n) Compare two vectors lexicographically. All `Vector` instances are also instances of `Ord` and it is usually more appropriate to use those. This function is primarily intended for implementing `Ord` instances for new vector types.

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

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

cmpBy :: (Vector v a, Vector v b) => (a -> b -> Ordering) -> v a -> v 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 == cmp

## Show and Read

showsPrec :: (Vector v a, Show a) => Int -> v a -> ShowS Source #

Generic definition of `showsPrec`.

readPrec :: (Vector v a, Read a) => ReadPrec (v a) Source #

Generic definition of `readPrec`.

liftShowsPrec :: Vector v a => (Int -> a -> ShowS) -> ([a] -> ShowS) -> Int -> v a -> ShowS Source #

liftReadsPrec :: Vector v a => (Int -> ReadS a) -> ReadS [a] -> Int -> ReadS (v a) Source #

Note: uses `ReadS`.

## `Data` and `Typeable`

gfoldl :: (Vector v a, Data a) => (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> v a -> c (v a) Source #

Generic definion of `gfoldl` that views a `Vector` as a list.

gunfold :: (Vector v a, Data a, HasCallStack) => (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (v a) Source #

dataCast :: (Vector v a, Data a, Typeable v, Typeable t) => (forall d. Data d => c (t d)) -> Maybe (c (v a)) Source #

mkVecType :: String -> DataType Source #

mkVecConstr :: String -> Constr Source #

mkType :: String -> DataType Source #

Deprecated: Use Data.Data.mkNoRepType