Safe Haskell | None |
---|---|
Language | Haskell2010 |
Storable Vector
. Import as:
import qualified RIO.Vector.Storable as VS
This module does not export any partial or unsafe functions. For those, see RIO.Vector.Storable.Partial and RIO.Vector.Storable.Unsafe
Synopsis
- data Vector a
- data MVector s a = MVector !Int !(ForeignPtr a)
- class Storable a
- length :: Storable a => Vector a -> Int
- null :: Storable a => Vector a -> Bool
- (!?) :: Storable a => Vector a -> Int -> Maybe a
- slice :: Storable a => Int -> Int -> Vector a -> Vector a
- take :: Storable a => Int -> Vector a -> Vector a
- drop :: Storable a => Int -> Vector a -> Vector a
- splitAt :: Storable a => Int -> Vector a -> (Vector a, Vector a)
- empty :: Storable a => Vector a
- singleton :: Storable a => a -> Vector a
- replicate :: Storable a => Int -> a -> Vector a
- generate :: Storable a => Int -> (Int -> a) -> Vector a
- iterateN :: Storable a => Int -> (a -> a) -> a -> Vector a
- replicateM :: (Monad m, Storable a) => Int -> m a -> m (Vector a)
- generateM :: (Monad m, Storable a) => Int -> (Int -> m a) -> m (Vector a)
- iterateNM :: (Monad m, Storable a) => Int -> (a -> m a) -> a -> m (Vector a)
- create :: Storable a => (forall s. ST s (MVector s a)) -> Vector a
- createT :: (Traversable f, Storable a) => (forall s. ST s (f (MVector s a))) -> f (Vector a)
- unfoldr :: Storable a => (b -> Maybe (a, b)) -> b -> Vector a
- unfoldrN :: Storable a => Int -> (b -> Maybe (a, b)) -> b -> Vector a
- unfoldrM :: (Monad m, Storable a) => (b -> m (Maybe (a, b))) -> b -> m (Vector a)
- unfoldrNM :: (Monad m, Storable a) => Int -> (b -> m (Maybe (a, b))) -> b -> m (Vector a)
- constructN :: Storable a => Int -> (Vector a -> a) -> Vector a
- constructrN :: Storable a => Int -> (Vector a -> a) -> Vector a
- enumFromN :: (Storable a, Num a) => a -> Int -> Vector a
- enumFromStepN :: (Storable a, Num a) => a -> a -> Int -> Vector a
- enumFromTo :: (Storable a, Enum a) => a -> a -> Vector a
- enumFromThenTo :: (Storable a, Enum a) => a -> a -> a -> Vector a
- cons :: Storable a => a -> Vector a -> Vector a
- snoc :: Storable a => Vector a -> a -> Vector a
- (++) :: Storable a => Vector a -> Vector a -> Vector a
- concat :: Storable a => [Vector a] -> Vector a
- force :: Storable a => Vector a -> Vector a
- reverse :: Storable a => Vector a -> Vector a
- modify :: Storable a => (forall s. MVector s a -> ST s ()) -> Vector a -> Vector a
- map :: (Storable a, Storable b) => (a -> b) -> Vector a -> Vector b
- imap :: (Storable a, Storable b) => (Int -> a -> b) -> Vector a -> Vector b
- concatMap :: (Storable a, Storable b) => (a -> Vector b) -> Vector a -> Vector b
- mapM :: (Monad m, Storable a, Storable b) => (a -> m b) -> Vector a -> m (Vector b)
- mapM_ :: (Monad m, Storable a) => (a -> m b) -> Vector a -> m ()
- forM :: (Monad m, Storable a, Storable b) => Vector a -> (a -> m b) -> m (Vector b)
- forM_ :: (Monad m, Storable a) => Vector a -> (a -> m b) -> m ()
- zipWith :: (Storable a, Storable b, Storable c) => (a -> b -> c) -> Vector a -> Vector b -> Vector c
- zipWith3 :: (Storable a, Storable b, Storable c, Storable d) => (a -> b -> c -> d) -> Vector a -> Vector b -> Vector c -> Vector d
- zipWith4 :: (Storable a, Storable b, Storable c, Storable d, Storable e) => (a -> b -> c -> d -> e) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e
- zipWith5 :: (Storable a, Storable b, Storable c, Storable d, Storable e, Storable f) => (a -> b -> c -> d -> e -> f) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f
- zipWith6 :: (Storable a, Storable b, Storable c, Storable d, Storable e, Storable f, Storable g) => (a -> b -> c -> d -> e -> f -> g) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f -> Vector g
- izipWith :: (Storable a, Storable b, Storable c) => (Int -> a -> b -> c) -> Vector a -> Vector b -> Vector c
- izipWith3 :: (Storable a, Storable b, Storable c, Storable d) => (Int -> a -> b -> c -> d) -> Vector a -> Vector b -> Vector c -> Vector d
- izipWith4 :: (Storable a, Storable b, Storable c, Storable d, Storable e) => (Int -> a -> b -> c -> d -> e) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e
- izipWith5 :: (Storable a, Storable b, Storable c, Storable d, Storable e, Storable f) => (Int -> a -> b -> c -> d -> e -> f) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f
- izipWith6 :: (Storable a, Storable b, Storable c, Storable d, Storable e, Storable f, Storable g) => (Int -> a -> b -> c -> d -> e -> f -> g) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f -> Vector g
- zipWithM :: (Monad m, Storable a, Storable b, Storable c) => (a -> b -> m c) -> Vector a -> Vector b -> m (Vector c)
- zipWithM_ :: (Monad m, Storable a, Storable b) => (a -> b -> m c) -> Vector a -> Vector b -> m ()
- filter :: Storable a => (a -> Bool) -> Vector a -> Vector a
- ifilter :: Storable a => (Int -> a -> Bool) -> Vector a -> Vector a
- uniq :: (Storable a, Eq a) => Vector a -> Vector a
- mapMaybe :: (Storable a, Storable b) => (a -> Maybe b) -> Vector a -> Vector b
- imapMaybe :: (Storable a, Storable b) => (Int -> a -> Maybe b) -> Vector a -> Vector b
- filterM :: (Monad m, Storable a) => (a -> m Bool) -> Vector a -> m (Vector a)
- takeWhile :: Storable a => (a -> Bool) -> Vector a -> Vector a
- dropWhile :: Storable a => (a -> Bool) -> Vector a -> Vector a
- partition :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
- unstablePartition :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
- span :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
- break :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
- elem :: (Storable a, Eq a) => a -> Vector a -> Bool
- notElem :: (Storable a, Eq a) => a -> Vector a -> Bool
- find :: Storable a => (a -> Bool) -> Vector a -> Maybe a
- findIndex :: Storable a => (a -> Bool) -> Vector a -> Maybe Int
- findIndices :: Storable a => (a -> Bool) -> Vector a -> Vector Int
- elemIndex :: (Storable a, Eq a) => a -> Vector a -> Maybe Int
- elemIndices :: (Storable a, Eq a) => a -> Vector a -> Vector Int
- foldl :: Storable b => (a -> b -> a) -> a -> Vector b -> a
- foldl' :: Storable b => (a -> b -> a) -> a -> Vector b -> a
- foldr :: Storable a => (a -> b -> b) -> b -> Vector a -> b
- foldr' :: Storable a => (a -> b -> b) -> b -> Vector a -> b
- ifoldl :: Storable b => (a -> Int -> b -> a) -> a -> Vector b -> a
- ifoldl' :: Storable b => (a -> Int -> b -> a) -> a -> Vector b -> a
- ifoldr :: Storable a => (Int -> a -> b -> b) -> b -> Vector a -> b
- ifoldr' :: Storable a => (Int -> a -> b -> b) -> b -> Vector a -> b
- all :: Storable a => (a -> Bool) -> Vector a -> Bool
- any :: Storable a => (a -> Bool) -> Vector a -> Bool
- and :: Vector Bool -> Bool
- or :: Vector Bool -> Bool
- sum :: (Storable a, Num a) => Vector a -> a
- product :: (Storable a, Num a) => Vector a -> a
- foldM :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m a
- foldM' :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m a
- foldM_ :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m ()
- foldM'_ :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m ()
- prescanl :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a
- prescanl' :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a
- postscanl :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a
- postscanl' :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a
- scanl :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a
- scanl' :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a
- prescanr :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b
- prescanr' :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b
- postscanr :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b
- postscanr' :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b
- scanr :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b
- scanr' :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b
- toList :: Storable a => Vector a -> [a]
- fromList :: Storable a => [a] -> Vector a
- fromListN :: Storable a => Int -> [a] -> Vector a
- convert :: (Vector v a, Vector w a) => v a -> w a
- freeze :: (Storable a, PrimMonad m) => MVector (PrimState m) a -> m (Vector a)
- thaw :: (Storable a, PrimMonad m) => Vector a -> m (MVector (PrimState m) a)
- copy :: (Storable a, PrimMonad m) => MVector (PrimState m) a -> Vector a -> m ()
Storable vectors
Storable
-based vectors
Instances
NFData1 Vector | Since: vector-0.12.1.0 |
Defined in Data.Vector.Storable | |
Storable a => Vector Vector a | |
Defined in Data.Vector.Storable basicUnsafeFreeze :: PrimMonad m => Mutable Vector (PrimState m) a -> m (Vector a) # basicUnsafeThaw :: PrimMonad m => Vector a -> m (Mutable Vector (PrimState m) a) # basicLength :: Vector a -> Int # basicUnsafeSlice :: Int -> Int -> Vector a -> Vector a # basicUnsafeIndexM :: Monad m => Vector a -> Int -> m a # basicUnsafeCopy :: PrimMonad m => Mutable Vector (PrimState m) a -> Vector a -> m () # | |
Storable a => IsList (Vector a) | |
(Storable a, Eq a) => Eq (Vector a) | |
(Data a, Storable a) => Data (Vector a) | |
Defined in Data.Vector.Storable gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Vector a -> c (Vector a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (Vector a) # toConstr :: Vector a -> Constr # dataTypeOf :: Vector a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (Vector a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (Vector a)) # gmapT :: (forall b. Data b => b -> b) -> Vector a -> Vector a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Vector a -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Vector a -> r # gmapQ :: (forall d. Data d => d -> u) -> Vector a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Vector a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Vector a -> m (Vector a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Vector a -> m (Vector a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Vector a -> m (Vector a) # | |
(Storable a, Ord a) => Ord (Vector a) | |
Defined in Data.Vector.Storable | |
(Read a, Storable a) => Read (Vector a) | |
(Show a, Storable a) => Show (Vector a) | |
Storable a => Semigroup (Vector a) | |
Storable a => Monoid (Vector a) | |
NFData (Vector a) | |
Defined in Data.Vector.Storable | |
type Mutable Vector | |
Defined in Data.Vector.Storable | |
type Item (Vector a) | |
Defined in Data.Vector.Storable |
Mutable Storable
-based vectors
MVector !Int !(ForeignPtr a) |
Instances
The member functions of this class facilitate writing values of primitive types to raw memory (which may have been allocated with the above mentioned routines) and reading values from blocks of raw memory. The class, furthermore, includes support for computing the storage requirements and alignment restrictions of storable types.
Memory addresses are represented as values of type
, for some
Ptr
aa
which is an instance of class Storable
. The type argument to
Ptr
helps provide some valuable type safety in FFI code (you can't
mix pointers of different types without an explicit cast), while
helping the Haskell type system figure out which marshalling method is
needed for a given pointer.
All marshalling between Haskell and a foreign language ultimately
boils down to translating Haskell data structures into the binary
representation of a corresponding data structure of the foreign
language and vice versa. To code this marshalling in Haskell, it is
necessary to manipulate primitive data types stored in unstructured
memory blocks. The class Storable
facilitates this manipulation on
all types for which it is instantiated, which are the standard basic
types of Haskell, the fixed size Int
types (Int8
, Int16
,
Int32
, Int64
), the fixed size Word
types (Word8
, Word16
,
Word32
, Word64
), StablePtr
, all types from Foreign.C.Types,
as well as Ptr
.
sizeOf, alignment, (peek | peekElemOff | peekByteOff), (poke | pokeElemOff | pokeByteOff)
Instances
Accessors
Length information
Indexing
Extracting subvectors
O(1) Yield a slice of the vector without copying it. The vector must
contain at least i+n
elements.
take :: Storable a => Int -> Vector a -> Vector a #
O(1) Yield at the first n
elements without copying. The vector may
contain less than n
elements in which case it is returned unchanged.
drop :: Storable a => Int -> Vector a -> Vector a #
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 :: Storable a => Int -> a -> Vector a #
O(n) Vector of the given length with the same value in each position
generate :: Storable a => Int -> (Int -> a) -> Vector a #
O(n) Construct a vector of the given length by applying the function to each index
iterateN :: Storable a => Int -> (a -> a) -> a -> Vector a #
O(n) Apply function \(\max(n - 1, 0)\) times to an initial value, producing a vector of length \(\max(n, 0)\). Zeroth element will contain the initial value, that's why there is one less function application than the number of elements in the produced vector.
\( \underbrace{x, f (x), f (f (x)), \ldots}_{\max(0,n)\rm{~elements}} \)
Examples
>>>
import qualified Data.Vector.Storable as VS
>>>
VS.iterateN 0 undefined undefined :: VS.Vector Int
[]>>>
VS.iterateN 26 succ 'a'
"abcdefghijklmnopqrstuvwxyz"
Since: vector-0.7.1
Monadic initialisation
replicateM :: (Monad m, Storable a) => Int -> m a -> m (Vector a) #
O(n) Execute the monadic action the given number of times and store the results in a vector.
generateM :: (Monad m, Storable a) => Int -> (Int -> m a) -> m (Vector a) #
O(n) Construct a vector of the given length by applying the monadic action to each index
iterateNM :: (Monad m, Storable a) => Int -> (a -> m a) -> a -> m (Vector a) #
O(n) Apply monadic function \(\max(n - 1, 0)\) times to an initial value, producing a vector of length \(\max(n, 0)\). Zeroth element will contain the initial value, that's why there is one less function application than the number of elements in the produced vector.
For non-monadic version see iterateN
Since: vector-0.12.0.0
create :: Storable a => (forall s. ST s (MVector s a)) -> Vector a #
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, Storable a) => (forall s. ST s (f (MVector s a))) -> f (Vector a) #
Execute the monadic action and freeze the resulting vectors.
Unfolding
constructN :: Storable a => Int -> (Vector a -> a) -> Vector a #
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 :: Storable a => Int -> (Vector a -> a) -> Vector a #
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 :: (Storable a, Num a) => a -> Int -> Vector a #
O(n) Yield a vector of the given length containing the values x
, x+1
etc. This operation is usually more efficient than enumFromTo
.
enumFromN 5 3 = <5,6,7>
enumFromStepN :: (Storable a, Num a) => a -> a -> Int -> Vector a #
O(n) Yield a vector of the given length containing the values x
, x+y
,
x+y+y
etc. This operations is usually more efficient than enumFromThenTo
.
enumFromStepN 1 0.1 5 = <1,1.1,1.2,1.3,1.4>
enumFromTo :: (Storable a, Enum a) => a -> a -> Vector a #
O(n) Enumerate values from x
to y
.
WARNING: This operation can be very inefficient. If at all possible, use
enumFromN
instead.
enumFromThenTo :: (Storable a, Enum a) => a -> a -> a -> Vector a #
O(n) Enumerate values from x
to y
with a specific step z
.
WARNING: This operation can be very inefficient. If at all possible, use
enumFromStepN
instead.
Concatenation
Restricting memory usage
force :: Storable a => Vector a -> Vector a #
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 :: Storable a => (forall s. MVector s a -> ST s ()) -> Vector a -> Vector a #
Apply a destructive operation to a vector. The operation will be performed in place if it is safe to do so and will modify a copy of the vector otherwise.
modify (\v -> write v 0 'x') (replicate
3 'a') = <'x','a','a'>
Elementwise operations
Mapping
map :: (Storable a, Storable b) => (a -> b) -> Vector a -> Vector b #
O(n) Map a function over a vector
imap :: (Storable a, Storable b) => (Int -> a -> b) -> Vector a -> Vector b #
O(n) Apply a function to every element of a vector and its index
concatMap :: (Storable a, Storable b) => (a -> Vector b) -> Vector a -> Vector b #
Map a function over a vector and concatenate the results.
Monadic mapping
mapM :: (Monad m, Storable a, Storable b) => (a -> m b) -> Vector a -> m (Vector b) #
O(n) Apply the monadic action to all elements of the vector, yielding a vector of results
mapM_ :: (Monad m, Storable a) => (a -> m b) -> Vector a -> m () #
O(n) Apply the monadic action to all elements of a vector and ignore the results
forM :: (Monad m, Storable a, Storable b) => Vector a -> (a -> m b) -> m (Vector b) #
O(n) Apply the monadic action to all elements of the vector, yielding a
vector of results. Equivalent to flip
.mapM
forM_ :: (Monad m, Storable a) => Vector a -> (a -> m b) -> m () #
O(n) Apply the monadic action to all elements of a vector and ignore the
results. Equivalent to flip
.mapM_
Zipping
zipWith :: (Storable a, Storable b, Storable c) => (a -> b -> c) -> Vector a -> Vector b -> Vector c #
O(min(m,n)) Zip two vectors with the given function.
zipWith3 :: (Storable a, Storable b, Storable c, Storable d) => (a -> b -> c -> d) -> Vector a -> Vector b -> Vector c -> Vector d #
Zip three vectors with the given function.
zipWith4 :: (Storable a, Storable b, Storable c, Storable d, Storable e) => (a -> b -> c -> d -> e) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e #
zipWith5 :: (Storable a, Storable b, Storable c, Storable d, Storable e, Storable f) => (a -> b -> c -> d -> e -> f) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f #
zipWith6 :: (Storable a, Storable b, Storable c, Storable d, Storable e, Storable f, Storable g) => (a -> b -> c -> d -> e -> f -> g) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f -> Vector g #
izipWith :: (Storable a, Storable b, Storable c) => (Int -> a -> b -> c) -> Vector a -> Vector b -> Vector c #
O(min(m,n)) Zip two vectors with a function that also takes the elements' indices.
izipWith3 :: (Storable a, Storable b, Storable c, Storable d) => (Int -> a -> b -> c -> d) -> Vector a -> Vector b -> Vector c -> Vector d #
Zip three vectors and their indices with the given function.
izipWith4 :: (Storable a, Storable b, Storable c, Storable d, Storable e) => (Int -> a -> b -> c -> d -> e) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e #
izipWith5 :: (Storable a, Storable b, Storable c, Storable d, Storable e, Storable f) => (Int -> a -> b -> c -> d -> e -> f) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f #
izipWith6 :: (Storable a, Storable b, Storable c, Storable d, Storable e, Storable f, Storable g) => (Int -> a -> b -> c -> d -> e -> f -> g) -> Vector a -> Vector b -> Vector c -> Vector d -> Vector e -> Vector f -> Vector g #
Monadic zipping
zipWithM :: (Monad m, Storable a, Storable b, Storable c) => (a -> b -> m c) -> Vector a -> Vector b -> m (Vector c) #
O(min(m,n)) Zip the two vectors with the monadic action and yield a vector of results
zipWithM_ :: (Monad m, Storable a, Storable b) => (a -> b -> m c) -> Vector a -> Vector b -> m () #
O(min(m,n)) Zip the two vectors with the monadic action and ignore the results
Working with predicates
Filtering
filter :: Storable a => (a -> Bool) -> Vector a -> Vector a #
O(n) Drop elements that do not satisfy the predicate
ifilter :: Storable a => (Int -> a -> Bool) -> Vector a -> Vector a #
O(n) Drop elements that do not satisfy the predicate which is applied to values and their indices
mapMaybe :: (Storable a, Storable b) => (a -> Maybe b) -> Vector a -> Vector b #
O(n) Drop elements when predicate returns Nothing
imapMaybe :: (Storable a, Storable b) => (Int -> a -> Maybe b) -> Vector a -> Vector b #
O(n) Drop elements when predicate, applied to index and value, returns Nothing
filterM :: (Monad m, Storable a) => (a -> m Bool) -> Vector a -> m (Vector a) #
O(n) Drop elements that do not satisfy the monadic predicate
takeWhile :: Storable a => (a -> Bool) -> Vector a -> Vector a #
O(n) Yield the longest prefix of elements satisfying the predicate. Current implementation is not copy-free, unless the result vector is fused away.
dropWhile :: Storable a => (a -> Bool) -> Vector a -> Vector a #
O(n) Drop the longest prefix of elements that satisfy the predicate without copying.
Partitioning
partition :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a) #
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 :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a) #
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 :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a) #
O(n) Split the vector into the longest prefix of elements that satisfy the predicate and the rest without copying.
break :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a) #
O(n) Split the vector into the longest prefix of elements that do not satisfy the predicate and the rest without copying.
Searching
elem :: (Storable a, Eq a) => a -> Vector a -> Bool infix 4 #
O(n) Check if the vector contains an element
notElem :: (Storable a, Eq a) => a -> Vector a -> Bool infix 4 #
O(n) Check if the vector does not contain an element (inverse of elem
)
findIndices :: Storable a => (a -> Bool) -> Vector a -> Vector Int #
O(n) Yield the indices of elements satisfying the predicate in ascending order.
elemIndices :: (Storable a, Eq a) => a -> Vector a -> Vector Int #
O(n) Yield the indices of all occurences of the given element in
ascending order. This is a specialised version of findIndices
.
Folding
foldr' :: Storable a => (a -> b -> b) -> b -> Vector a -> b #
O(n) Right fold with a strict accumulator
ifoldl :: Storable b => (a -> Int -> b -> a) -> a -> Vector b -> a #
O(n) Left fold (function applied to each element and its index)
ifoldl' :: Storable b => (a -> Int -> b -> a) -> a -> Vector b -> a #
O(n) Left fold with strict accumulator (function applied to each element and its index)
ifoldr :: Storable a => (Int -> a -> b -> b) -> b -> Vector a -> b #
O(n) Right fold (function applied to each element and its index)
ifoldr' :: Storable a => (Int -> a -> b -> b) -> b -> Vector a -> b #
O(n) Right fold with strict accumulator (function applied to each element and its index)
Specialised folds
all :: Storable a => (a -> Bool) -> Vector a -> Bool #
O(n) Check if all elements satisfy the predicate.
Examples
>>>
import qualified Data.Vector.Storable as VS
>>>
VS.all even $ VS.fromList [2, 4, 12 :: Int]
True>>>
VS.all even $ VS.fromList [2, 4, 13 :: Int]
False>>>
VS.all even (VS.empty :: VS.Vector Int)
True
any :: Storable a => (a -> Bool) -> Vector a -> Bool #
O(n) Check if any element satisfies the predicate.
Examples
>>>
import qualified Data.Vector.Storable as VS
>>>
VS.any even $ VS.fromList [1, 3, 7 :: Int]
False>>>
VS.any even $ VS.fromList [3, 2, 13 :: Int]
True>>>
VS.any even (VS.empty :: VS.Vector Int)
False
O(n) Check if all elements are True
Examples
>>>
import qualified Data.Vector.Storable as VS
>>>
VS.and $ VS.fromList [True, False]
False>>>
VS.and VS.empty
True
O(n) Check if any element is True
Examples
>>>
import qualified Data.Vector.Storable as VS
>>>
VS.or $ VS.fromList [True, False]
True>>>
VS.or VS.empty
False
sum :: (Storable a, Num a) => Vector a -> a #
O(n) Compute the sum of the elements
Examples
>>>
import qualified Data.Vector.Storable as VS
>>>
VS.sum $ VS.fromList [300,20,1 :: Int]
321>>>
VS.sum (VS.empty :: VS.Vector Int)
0
product :: (Storable a, Num a) => Vector a -> a #
O(n) Compute the produce of the elements
Examples
>>>
import qualified Data.Vector.Storable as VS
>>>
VS.product $ VS.fromList [1,2,3,4 :: Int]
24>>>
VS.product (VS.empty :: VS.Vector Int)
1
Monadic folds
foldM' :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m a #
O(n) Monadic fold with strict accumulator
foldM_ :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m () #
O(n) Monadic fold that discards the result
foldM'_ :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m () #
O(n) Monadic fold with strict accumulator that discards the result
Prefix sums (scans)
prescanl' :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a #
O(n) Prescan with strict accumulator
postscanl' :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a #
O(n) Scan with strict accumulator
scanl :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a #
O(n) Haskell-style scan
scanl f z <x1,...,xn> = <y1,...,y(n+1)> where y1 = z yi = f y(i-1) x(i-1)
Example: scanl (+) 0 <1,2,3,4> = <0,1,3,6,10>
scanl' :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a #
O(n) Haskell-style scan with strict accumulator
prescanr' :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b #
O(n) Right-to-left prescan with strict accumulator
postscanr :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b #
O(n) Right-to-left scan
postscanr' :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b #
O(n) Right-to-left scan with strict accumulator
scanr :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b #
O(n) Right-to-left Haskell-style scan
scanr' :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b #
O(n) Right-to-left Haskell-style scan with strict accumulator
Conversions
Lists
Different vector types
Mutable vectors
freeze :: (Storable a, PrimMonad m) => MVector (PrimState m) a -> m (Vector a) #
O(n) Yield an immutable copy of the mutable vector.