Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
RIO.Vector
Description
Generic Vector
interface. Import as:
import qualified RIO.Vector as V
This module does not export any partial or unsafe functions. For those, see RIO.Vector.Partial and RIO.Vector.Unsafe
Synopsis
- class MVector (Mutable v) a => Vector (v :: Type -> Type) a
- length :: Vector v a => v a -> Int
- null :: Vector v a => v a -> Bool
- (!?) :: Vector v a => v a -> Int -> Maybe a
- slice :: (HasCallStack, Vector v a) => Int -> Int -> 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)
- 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
- 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)
- 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
- reverse :: Vector v a => v a -> 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 ()
- 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
- 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
- filterM :: (Monad m, Vector v a) => (a -> m Bool) -> v a -> m (v a)
- 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)
- 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)
- 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
- 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
- foldl' :: Vector v b => (a -> b -> a) -> a -> v b -> a
- foldr :: Vector v a => (a -> b -> b) -> b -> v a -> b
- foldr' :: Vector v a => (a -> b -> b) -> b -> v a -> b
- 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
- 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
- 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
- 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 ()
- 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
- 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
- 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 ()
- stream :: Vector v a => v a -> Bundle v a
- unstream :: Vector v a => Bundle v a -> 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)
- dataCast :: (Vector v a, Data a, Typeable v, Typeable t) => (forall d. Data d => c (t d)) -> Maybe (c (v a))
- mkType :: String -> DataType
Immutable vectors
class MVector (Mutable v) a => Vector (v :: Type -> Type) a 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:
Minimal complete definition
basicUnsafeFreeze, basicUnsafeThaw, basicLength, basicUnsafeSlice, basicUnsafeIndexM
Instances
Accessors
Length information
Indexing
Extracting subvectors
Arguments
:: (HasCallStack, Vector v a) | |
=> Int |
|
-> Int |
|
-> v a | |
-> v a |
O(1) Yield a slice of the vector without copying it. The vector must
contain at least i+n
elements.
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.
Construction
Initialisation
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: vector-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: vector-0.12.0.0
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
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
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, possibly by copying it.
This is especially useful when dealing with slices. For example:
force (slice 0 2 <huge vector>)
Here, the slice retains a reference to the huge vector. Forcing it creates a copy of just the elements that belong to the slice and allows the huge vector to be garbage collected.
Modifying vectors
Permutations
Safe destructive update
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
>>>
import qualified Data.Vector as V
>>>
import qualified Data.Vector.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_
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.
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
>>>
import qualified Data.Vector 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.
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.
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
.
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.
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.
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
).
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.
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 with strict accumulator.
foldr' :: Vector v a => (a -> b -> b) -> b -> v a -> b Source #
O(n) Right fold with a 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.
Specialised folds
all :: Vector v a => (a -> Bool) -> v a -> Bool Source #
O(n) Check if all elements satisfy the predicate.
Examples
>>>
import qualified Data.Vector 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
>>>
import qualified Data.Vector 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
>>>
import qualified Data.Vector 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
>>>
import qualified Data.Vector 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
>>>
import qualified Data.Vector 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
>>>
import qualified Data.Vector as V
>>>
V.product $ V.fromList [1,2,3,4]
24>>>
V.product (V.empty :: V.Vector Int)
1
Monadic folds
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.
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.
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.
Prefix sums (scans)
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 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
>>>
import qualified Data.Vector 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.
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 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.
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
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
>>>
import qualified Data.Vector 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.
Fusion support
Conversion to/from Bundles
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
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
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
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 #