vector-0.12.3.1: Efficient Arrays
Copyright(c) Roman Leshchinskiy 2008-2010
LicenseBSD-style
MaintainerRoman Leshchinskiy <rl@cse.unsw.edu.au>
Stabilityexperimental
Portabilitynon-portable
Safe HaskellNone
LanguageHaskell2010

Data.Vector.Primitive

Description

Unboxed vectors of primitive types. The use of this module is not recommended except in very special cases. Adaptive unboxed vectors defined in Data.Vector.Unboxed are significantly more flexible at no performance cost.

Synopsis

Primitive vectors

data Vector a Source #

Unboxed vectors of primitive types

Constructors

Vector !Int !Int !ByteArray

offset, length, underlying byte array

Instances

Instances details
NFData1 Vector Source #

Since: 0.12.1.0

Instance details

Defined in Data.Vector.Primitive

Methods

liftRnf :: (a -> ()) -> Vector a -> () Source #

Prim a => Vector Vector a Source # 
Instance details

Defined in Data.Vector.Primitive

Prim a => IsList (Vector a) Source # 
Instance details

Defined in Data.Vector.Primitive

Associated Types

type Item (Vector a) Source #

Methods

fromList :: [Item (Vector a)] -> Vector a Source #

fromListN :: Int -> [Item (Vector a)] -> Vector a Source #

toList :: Vector a -> [Item (Vector a)] Source #

(Prim a, Eq a) => Eq (Vector a) Source # 
Instance details

Defined in Data.Vector.Primitive

Methods

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

(/=) :: Vector a -> Vector a -> Bool Source #

(Data a, Prim a) => Data (Vector a) Source # 
Instance details

Defined in Data.Vector.Primitive

Methods

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

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

toConstr :: Vector a -> Constr Source #

dataTypeOf :: Vector a -> DataType Source #

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

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

gmapT :: (forall b. Data b => b -> b) -> Vector a -> Vector a Source #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Vector a -> r Source #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Vector a -> r Source #

gmapQ :: (forall d. Data d => d -> u) -> Vector a -> [u] Source #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Vector a -> u Source #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Vector a -> m (Vector a) Source #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Vector a -> m (Vector a) Source #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Vector a -> m (Vector a) Source #

(Prim a, Ord a) => Ord (Vector a) Source # 
Instance details

Defined in Data.Vector.Primitive

Methods

compare :: Vector a -> Vector a -> Ordering Source #

(<) :: Vector a -> Vector a -> Bool Source #

(<=) :: Vector a -> Vector a -> Bool Source #

(>) :: Vector a -> Vector a -> Bool Source #

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

max :: Vector a -> Vector a -> Vector a Source #

min :: Vector a -> Vector a -> Vector a Source #

(Read a, Prim a) => Read (Vector a) Source # 
Instance details

Defined in Data.Vector.Primitive

(Show a, Prim a) => Show (Vector a) Source # 
Instance details

Defined in Data.Vector.Primitive

Prim a => Semigroup (Vector a) Source # 
Instance details

Defined in Data.Vector.Primitive

Methods

(<>) :: Vector a -> Vector a -> Vector a Source #

sconcat :: NonEmpty (Vector a) -> Vector a Source #

stimes :: Integral b => b -> Vector a -> Vector a Source #

Prim a => Monoid (Vector a) Source # 
Instance details

Defined in Data.Vector.Primitive

NFData (Vector a) Source # 
Instance details

Defined in Data.Vector.Primitive

Methods

rnf :: Vector a -> () Source #

type Mutable Vector Source # 
Instance details

Defined in Data.Vector.Primitive

type Item (Vector a) Source # 
Instance details

Defined in Data.Vector.Primitive

type Item (Vector a) = a

data MVector s a Source #

Mutable vectors of primitive types.

Constructors

MVector !Int !Int !(MutableByteArray s)

offset, length, underlying mutable byte array

Instances

Instances details
Prim a => MVector MVector a Source # 
Instance details

Defined in Data.Vector.Primitive.Mutable

NFData1 (MVector s) Source # 
Instance details

Defined in Data.Vector.Primitive.Mutable

Methods

liftRnf :: (a -> ()) -> MVector s a -> () Source #

NFData (MVector s a) Source # 
Instance details

Defined in Data.Vector.Primitive.Mutable

Methods

rnf :: MVector s a -> () Source #

class Prim a Source #

Class of types supporting primitive array operations. This includes interfacing with GC-managed memory (functions suffixed with ByteArray#) and interfacing with unmanaged memory (functions suffixed with Addr#). Endianness is platform-dependent.

Instances

Instances details
Prim Char 
Instance details

Defined in Data.Primitive.Types

Prim Double 
Instance details

Defined in Data.Primitive.Types

Prim Float 
Instance details

Defined in Data.Primitive.Types

Prim Int 
Instance details

Defined in Data.Primitive.Types

Prim Int8 
Instance details

Defined in Data.Primitive.Types

Prim Int16 
Instance details

Defined in Data.Primitive.Types

Prim Int32 
Instance details

Defined in Data.Primitive.Types

Prim Int64 
Instance details

Defined in Data.Primitive.Types

Prim Word 
Instance details

Defined in Data.Primitive.Types

Prim Word8 
Instance details

Defined in Data.Primitive.Types

Prim Word16 
Instance details

Defined in Data.Primitive.Types

Prim Word32 
Instance details

Defined in Data.Primitive.Types

Prim Word64 
Instance details

Defined in Data.Primitive.Types

Prim CDev 
Instance details

Defined in Data.Primitive.Types

Prim CIno 
Instance details

Defined in Data.Primitive.Types

Prim CMode 
Instance details

Defined in Data.Primitive.Types

Prim COff 
Instance details

Defined in Data.Primitive.Types

Prim CPid 
Instance details

Defined in Data.Primitive.Types

Prim CSsize 
Instance details

Defined in Data.Primitive.Types

Prim CGid 
Instance details

Defined in Data.Primitive.Types

Prim CNlink 
Instance details

Defined in Data.Primitive.Types

Prim CUid 
Instance details

Defined in Data.Primitive.Types

Prim CCc 
Instance details

Defined in Data.Primitive.Types

Prim CSpeed 
Instance details

Defined in Data.Primitive.Types

Prim CTcflag 
Instance details

Defined in Data.Primitive.Types

Prim CRLim 
Instance details

Defined in Data.Primitive.Types

Prim CBlkSize 
Instance details

Defined in Data.Primitive.Types

Prim CBlkCnt 
Instance details

Defined in Data.Primitive.Types

Prim CClockId 
Instance details

Defined in Data.Primitive.Types

Prim CFsBlkCnt 
Instance details

Defined in Data.Primitive.Types

Prim CFsFilCnt 
Instance details

Defined in Data.Primitive.Types

Prim CId 
Instance details

Defined in Data.Primitive.Types

Prim CKey 
Instance details

Defined in Data.Primitive.Types

Prim CTimer 
Instance details

Defined in Data.Primitive.Types

Prim Fd 
Instance details

Defined in Data.Primitive.Types

Prim CChar 
Instance details

Defined in Data.Primitive.Types

Prim CSChar 
Instance details

Defined in Data.Primitive.Types

Prim CUChar 
Instance details

Defined in Data.Primitive.Types

Prim CShort 
Instance details

Defined in Data.Primitive.Types

Prim CUShort 
Instance details

Defined in Data.Primitive.Types

Prim CInt 
Instance details

Defined in Data.Primitive.Types

Prim CUInt 
Instance details

Defined in Data.Primitive.Types

Prim CLong 
Instance details

Defined in Data.Primitive.Types

Prim CULong 
Instance details

Defined in Data.Primitive.Types

Prim CLLong 
Instance details

Defined in Data.Primitive.Types

Prim CULLong 
Instance details

Defined in Data.Primitive.Types

Prim CBool 
Instance details

Defined in Data.Primitive.Types

Prim CFloat 
Instance details

Defined in Data.Primitive.Types

Prim CDouble 
Instance details

Defined in Data.Primitive.Types

Prim CPtrdiff 
Instance details

Defined in Data.Primitive.Types

Prim CSize 
Instance details

Defined in Data.Primitive.Types

Prim CWchar 
Instance details

Defined in Data.Primitive.Types

Prim CSigAtomic 
Instance details

Defined in Data.Primitive.Types

Prim CClock 
Instance details

Defined in Data.Primitive.Types

Prim CTime 
Instance details

Defined in Data.Primitive.Types

Prim CUSeconds 
Instance details

Defined in Data.Primitive.Types

Prim CSUSeconds 
Instance details

Defined in Data.Primitive.Types

Prim CIntPtr 
Instance details

Defined in Data.Primitive.Types

Prim CUIntPtr 
Instance details

Defined in Data.Primitive.Types

Prim CIntMax 
Instance details

Defined in Data.Primitive.Types

Prim CUIntMax 
Instance details

Defined in Data.Primitive.Types

Prim WordPtr

Since: primitive-0.7.1.0

Instance details

Defined in Data.Primitive.Types

Prim IntPtr

Since: primitive-0.7.1.0

Instance details

Defined in Data.Primitive.Types

Prim (StablePtr a) 
Instance details

Defined in Data.Primitive.Types

Prim (Ptr a) 
Instance details

Defined in Data.Primitive.Types

Prim (FunPtr a) 
Instance details

Defined in Data.Primitive.Types

Prim a => Prim (Min a)

Since: primitive-0.6.5.0

Instance details

Defined in Data.Primitive.Types

Prim a => Prim (Max a)

Since: primitive-0.6.5.0

Instance details

Defined in Data.Primitive.Types

Prim a => Prim (First a)

Since: primitive-0.6.5.0

Instance details

Defined in Data.Primitive.Types

Prim a => Prim (Last a)

Since: primitive-0.6.5.0

Instance details

Defined in Data.Primitive.Types

Prim a => Prim (Identity a)

Since: primitive-0.6.5.0

Instance details

Defined in Data.Primitive.Types

Prim a => Prim (Dual a)

Since: primitive-0.6.5.0

Instance details

Defined in Data.Primitive.Types

Prim a => Prim (Sum a)

Since: primitive-0.6.5.0

Instance details

Defined in Data.Primitive.Types

Prim a => Prim (Product a)

Since: primitive-0.6.5.0

Instance details

Defined in Data.Primitive.Types

Prim a => Prim (Down a)

Since: primitive-0.6.5.0

Instance details

Defined in Data.Primitive.Types

Prim a => Prim (Const a b)

Since: primitive-0.6.5.0

Instance details

Defined in Data.Primitive.Types

Accessors

Length information

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

O(1) Yield the length of the vector

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

O(1) Test whether a vector is empty

Indexing

(!) :: Prim a => Vector a -> Int -> a Source #

O(1) Indexing

(!?) :: Prim a => Vector a -> Int -> Maybe a Source #

O(1) Safe indexing

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

O(1) First element

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

O(1) Last element

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

O(1) Unsafe indexing without bounds checking

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

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

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

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

Monadic indexing

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

O(1) Indexing in a monad.

The monad allows operations to be strict in the vector when necessary. Suppose vector copying is implemented like this:

copy mv v = ... write mv i (v ! i) ...

For lazy vectors, v ! i would not be evaluated which means that mv would unnecessarily retain a reference to v in each element written.

With indexM, copying can be implemented like this instead:

copy mv v = ... do
                  x <- indexM v i
                  write mv i x

Here, no references to v are retained because indexing (but not the elements) is evaluated eagerly.

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

O(1) First element of a vector in a monad. See indexM for an explanation of why this is useful.

lastM :: (Prim a, Monad m) => Vector a -> m a Source #

O(1) Last element of a vector in a monad. See indexM for an explanation of why this is useful.

unsafeIndexM :: (Prim a, Monad m) => Vector a -> Int -> m a Source #

O(1) Indexing in a monad without bounds checks. See indexM for an explanation of why this is useful.

unsafeHeadM :: (Prim a, Monad m) => Vector a -> m a Source #

O(1) First element in a monad without checking for empty vectors. See indexM for an explanation of why this is useful.

unsafeLastM :: (Prim a, Monad m) => Vector a -> m a Source #

O(1) Last element in a monad without checking for empty vectors. See indexM for an explanation of why this is useful.

Extracting subvectors (slicing)

slice Source #

Arguments

:: Prim a 
=> Int

i starting index

-> Int

n length

-> Vector a 
-> Vector a 

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

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

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

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

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

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

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

drop :: Prim a => Int -> Vector a -> Vector a Source #

O(1) Yield all but the first n elements without copying. The vector may contain less than n elements in which case an empty vector is returned.

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

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

Since: 0.12.2.0

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

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

Since: 0.12.2.0

unsafeSlice Source #

Arguments

:: Prim a 
=> Int

i starting index

-> Int

n length

-> Vector a 
-> Vector a 

O(1) Yield a slice of the vector without copying. The vector must contain at least i+n elements but this is not checked.

unsafeInit :: Prim a => Vector a -> Vector a Source #

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

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

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

unsafeTake :: Prim a => Int -> Vector a -> Vector a Source #

O(1) Yield the first n elements without copying. The vector must contain at least n elements but this is not checked.

unsafeDrop :: Prim a => Int -> Vector a -> Vector a Source #

O(1) Yield all but the first n elements without copying. The vector must contain at least n elements but this is not checked.

Construction

Initialisation

empty :: Prim a => Vector a Source #

O(1) Empty vector

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

O(1) Vector with exactly one element

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

O(n) Vector of the given length with the same value in each position

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

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

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

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

Expand
>>> import qualified Data.Vector.Primitive as VP
>>> VP.iterateN 0 undefined undefined :: VP.Vector Int
[]
>>> VP.iterateN 26 succ 'a'
"abcdefghijklmnopqrstuvwxyz"

Since: 0.7.1

Monadic initialisation

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

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

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

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

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

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

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

Execute the monadic action and freeze the resulting vector.

create (do { v <- new 2; write v 0 'a'; write v 1 'b'; return v }) = <a,b>

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

Execute the monadic action and freeze the resulting vectors.

Unfolding

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

O(n) Construct a vector with exactly n elements by repeatedly applying the generator function to a seed. The generator function yields the next element and the new seed.

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

Since: 0.12.2.0

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

O(n) Construct a vector with exactly n elements by repeatedly applying the monadic generator function to a seed. The generator function yields the next element and the new seed.

Since: 0.12.2.0

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

O(n) Construct a vector with n elements by repeatedly applying the generator function to the already constructed part of the vector.

constructN 3 f = let a = f <> ; b = f <a> ; c = f <a,b> in <a,b,c>

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

O(n) Construct a vector with n elements from right to left by repeatedly applying the generator function to the already constructed part of the vector.

constructrN 3 f = let a = f <> ; b = f<a> ; c = f <b,a> in <c,b,a>

Enumeration

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

O(n) Yield a vector of the given length containing the values x, x+1 etc. This operation is usually more efficient than enumFromTo.

enumFromN 5 3 = <5,6,7>

enumFromStepN :: (Prim a, Num a) => a -> a -> Int -> Vector a Source #

O(n) Yield a vector of the given length containing the values x, x+y, x+y+y etc. This operations is usually more efficient than enumFromThenTo.

enumFromStepN 1 0.1 5 = <1,1.1,1.2,1.3,1.4>

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

O(n) Enumerate values from x to y.

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

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

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

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

Concatenation

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

O(n) Prepend an element

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

O(n) Append an element

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

O(m+n) Concatenate two vectors

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

O(n) Concatenate all vectors in the list

Restricting memory usage

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

O(n) Yield the argument but force it not to retain any extra memory, possibly by copying it.

This is especially useful when dealing with slices. For example:

force (slice 0 2 <huge vector>)

Here, the slice retains a reference to the huge vector. Forcing it creates a copy of just the elements that belong to the slice and allows the huge vector to be garbage collected.

Modifying vectors

Bulk updates

(//) Source #

Arguments

:: Prim a 
=> Vector a

initial vector (of length m)

-> [(Int, a)]

list of index/value pairs (of length n)

-> Vector a 

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

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

update_ Source #

Arguments

:: Prim a 
=> Vector a

initial vector (of length m)

-> Vector Int

index vector (of length n1)

-> Vector a

value vector (of length n2)

-> Vector a 

O(m+min(n1,n2)) For each index i from the index vector and the corresponding value a from the value vector, replace the element of the initial vector at position i by a.

update_ <5,9,2,7>  <2,0,2> <1,3,8> = <3,9,8,7>

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

Same as (//) but without bounds checking.

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

Same as update_ but without bounds checking.

Accumulations

accum Source #

Arguments

:: Prim a 
=> (a -> b -> a)

accumulating function f

-> Vector a

initial vector (of length m)

-> [(Int, b)]

list of index/value pairs (of length n)

-> Vector a 

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

Examples

Expand
>>> import qualified Data.Vector.Primitive as VP
>>> VP.accum (+) (VP.fromList [1000.0,2000.0,3000.0]) [(2,4),(1,6),(0,3),(1,10)]
[1003.0,2016.0,3004.0]

accumulate_ Source #

Arguments

:: (Prim a, Prim b) 
=> (a -> b -> a)

accumulating function f

-> Vector a

initial vector (of length m)

-> Vector Int

index vector (of length n1)

-> Vector b

value vector (of length n2)

-> Vector a 

O(m+min(n1,n2)) For each index i from the index vector and the corresponding value b from the the value vector, replace the element of the initial vector at position i by f a b.

accumulate_ (+) <5,9,2> <2,1,0,1> <4,6,3,7> = <5+3, 9+6+7, 2+4>

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

Same as accum but without bounds checking.

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

Same as accumulate_ but without bounds checking.

Permutations

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

O(n) Reverse a vector

backpermute :: Prim a => Vector a -> Vector Int -> Vector a Source #

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 :: Prim a => Vector a -> Vector Int -> Vector a Source #

Same as backpermute but without bounds checking.

Safe destructive updates

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

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

modify (\v -> write v 0 'x') (replicate 3 'a') = <'x','a','a'>

Elementwise operations

Mapping

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

O(n) Map a function over a vector

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

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

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

Map a function over a vector and concatenate the results.

Monadic mapping

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

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

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

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

Since: 0.12.2.0

mapM_ :: (Monad m, Prim a) => (a -> m b) -> Vector a -> m () Source #

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

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

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

Since: 0.12.2.0

forM :: (Monad m, Prim a, Prim b) => Vector a -> (a -> m b) -> m (Vector b) Source #

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

forM_ :: (Monad m, Prim a) => Vector a -> (a -> m b) -> m () Source #

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

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

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

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

Zip three vectors with the given function.

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

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

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

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

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

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

Zip three vectors and their indices with the given function.

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

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

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

Monadic zipping

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

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

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

O(min(m,n)) Zip the two vectors with a monadic action that also takes the element index and yield a vector of results

Since: 0.12.2.0

zipWithM_ :: (Monad m, Prim a, Prim b) => (a -> b -> m c) -> Vector a -> Vector b -> m () Source #

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

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

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

Since: 0.12.2.0

Working with predicates

Filtering

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

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

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

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

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

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

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

O(n) Drop repeated adjacent elements.

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

O(n) Drop elements when predicate returns Nothing

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

O(n) Drop elements when predicate, applied to index and value, returns Nothing

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

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

Since: 0.12.2.0

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

O(n) Apply monadic function to each element of vector and its index. Discards elements returning Nothing.

Since: 0.12.2.0

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

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

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

Partitioning

partition :: Prim a => (a -> Bool) -> Vector a -> (Vector a, Vector a) Source #

O(n) Split the vector in two parts, the first one containing those elements that satisfy the predicate and the second one those that don't. The relative order of the elements is preserved at the cost of a sometimes reduced performance compared to unstablePartition.

unstablePartition :: Prim a => (a -> Bool) -> Vector a -> (Vector a, Vector a) Source #

O(n) Split the vector in two parts, the first one containing those elements that satisfy the predicate and the second one those that don't. The order of the elements is not preserved but the operation is often faster than partition.

partitionWith :: (Prim a, Prim b, Prim c) => (a -> Either b c) -> Vector a -> (Vector b, Vector 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

span :: Prim a => (a -> Bool) -> Vector a -> (Vector a, Vector a) Source #

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

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

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

Searching

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

O(n) Check if the vector contains an element

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

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

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

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

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

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

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