Data.Vector.Storable

vector-0.13.2.0: Efficient Arrays

Copyright | (c) Roman Leshchinskiy 2009-2010 Alexey Kuleshevich 2020-2022 Aleksey Khudyakov 2020-2022 Andrew Lelechenko 2020-2022
License | BSD-style
Maintainer | Haskell Libraries Team <libraries@haskell.org>
Stability | experimental
Portability | non-portable
Safe Haskell | None
Language | Haskell2010

Data.Vector.Storable

Contents

- Storable vectors
- Accessors
  - Length information
  - Indexing
  - Monadic indexing
  - Extracting subvectors (slicing)
- Construction
  - Initialisation
  - Monadic initialisation
  - Unfolding
  - Enumeration
  - Concatenation
  - Restricting memory usage
- Modifying vectors
  - Bulk updates
  - Accumulations
  - Permutations
  - Safe destructive updates
- Elementwise operations
  - Mapping
  - Monadic mapping
  - Zipping
  - Monadic zipping
- Working with predicates
  - Filtering
  - Partitioning
  - Searching
- Folding
  - Specialised folds
  - Monadic folds
- Scans
  - Comparisons
- Utilities
  - Comparisons
- Conversions
  - Lists
  - Other vector types
  - Mutable vectors
- Raw pointers
- Re-exports

Description

`Storable`-based vectors.

Synopsis

- data Vector a
- data MVector s a = MVector !Int !(ForeignPtr a)
- length :: Storable a => Vector a -> Int
- null :: Storable a => Vector a -> Bool
- (!) :: Storable a => Vector a -> Int -> a
- (!?) :: Storable a => Vector a -> Int -> Maybe a
- head :: Storable a => Vector a -> a
- last :: Storable a => Vector a -> a
- unsafeIndex :: Storable a => Vector a -> Int -> a
- unsafeHead :: Storable a => Vector a -> a
- unsafeLast :: Storable a => Vector a -> a
- indexM :: (Storable a, Monad m) => Vector a -> Int -> m a
- headM :: (Storable a, Monad m) => Vector a -> m a
- lastM :: (Storable a, Monad m) => Vector a -> m a
- unsafeIndexM :: (Storable a, Monad m) => Vector a -> Int -> m a
- unsafeHeadM :: (Storable a, Monad m) => Vector a -> m a
- unsafeLastM :: (Storable a, Monad m) => Vector a -> m a
- slice :: Storable a => Int -> Int -> Vector a -> Vector a
- init :: Storable a => Vector a -> Vector a
- tail :: Storable a => 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)
- uncons :: Storable a => Vector a -> Maybe (a, Vector a)
- unsnoc :: Storable a => Vector a -> Maybe (Vector a, a)
- unsafeSlice :: Storable a => Int -> Int -> Vector a -> Vector a
- unsafeInit :: Storable a => Vector a -> Vector a
- unsafeTail :: Storable a => Vector a -> Vector a
- unsafeTake :: Storable a => Int -> Vector a -> Vector a
- unsafeDrop :: Storable a => Int -> 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
- unfoldrExactN :: Storable a => Int -> (b -> (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)
- unfoldrExactNM :: (Monad m, Storable a) => Int -> (b -> m (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
- (//) :: Storable a => Vector a -> [(Int, a)] -> Vector a
- update_ :: Storable a => Vector a -> Vector Int -> Vector a -> Vector a
- unsafeUpd :: Storable a => Vector a -> [(Int, a)] -> Vector a
- unsafeUpdate_ :: Storable a => Vector a -> Vector Int -> Vector a -> Vector a
- accum :: Storable a => (a -> b -> a) -> Vector a -> [(Int, b)] -> Vector a
- accumulate_ :: (Storable a, Storable b) => (a -> b -> a) -> Vector a -> Vector Int -> Vector b -> Vector a
- unsafeAccum :: Storable a => (a -> b -> a) -> Vector a -> [(Int, b)] -> Vector a
- unsafeAccumulate_ :: (Storable a, Storable b) => (a -> b -> a) -> Vector a -> Vector Int -> Vector b -> Vector a
- reverse :: Storable a => Vector a -> Vector a
- backpermute :: Storable a => Vector a -> Vector Int -> Vector a
- unsafeBackpermute :: Storable a => Vector a -> Vector Int -> 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)
- imapM :: (Monad m, Storable a, Storable b) => (Int -> a -> m b) -> Vector a -> m (Vector b)
- mapM_ :: (Monad m, Storable a) => (a -> m b) -> Vector a -> m ()
- imapM_ :: (Monad m, Storable a) => (Int -> 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 ()
- iforM :: (Monad m, Storable a, Storable b) => Vector a -> (Int -> a -> m b) -> m (Vector b)
- iforM_ :: (Monad m, Storable a) => Vector a -> (Int -> 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)
- izipWithM :: (Monad m, Storable a, Storable b, Storable c) => (Int -> 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 ()
- izipWithM_ :: (Monad m, Storable a, Storable b) => (Int -> 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
- filterM :: (Monad m, Storable a) => (a -> m Bool) -> Vector a -> m (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
- mapMaybeM :: (Monad m, Storable a, Storable b) => (a -> m (Maybe b)) -> Vector a -> m (Vector b)
- imapMaybeM :: (Monad m, Storable a, Storable b) => (Int -> a -> m (Maybe b)) -> Vector a -> m (Vector b)
- 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)
- partitionWith :: (Storable a, Storable b, Storable c) => (a -> Either b c) -> Vector a -> (Vector b, Vector c)
- span :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
- break :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
- spanR :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
- breakR :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
- groupBy :: Storable a => (a -> a -> Bool) -> Vector a -> [Vector a]
- group :: (Storable a, Eq 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
- findIndexR :: 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
- foldl1 :: Storable a => (a -> a -> a) -> Vector a -> a
- foldl' :: Storable b => (a -> b -> a) -> a -> Vector b -> a
- foldl1' :: Storable a => (a -> a -> a) -> Vector a -> a
- foldr :: Storable a => (a -> b -> b) -> b -> Vector a -> b
- foldr1 :: Storable a => (a -> a -> a) -> Vector a -> a
- foldr' :: Storable a => (a -> b -> b) -> b -> Vector a -> b
- foldr1' :: Storable a => (a -> a -> a) -> Vector a -> a
- 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
- foldMap :: (Monoid m, Storable a) => (a -> m) -> Vector a -> m
- foldMap' :: (Monoid m, Storable a) => (a -> m) -> Vector a -> m
- 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
- maximum :: (Storable a, Ord a) => Vector a -> a
- maximumBy :: Storable a => (a -> a -> Ordering) -> Vector a -> a
- maximumOn :: (Ord b, Storable a) => (a -> b) -> Vector a -> a
- minimum :: (Storable a, Ord a) => Vector a -> a
- minimumBy :: Storable a => (a -> a -> Ordering) -> Vector a -> a
- minimumOn :: (Ord b, Storable a) => (a -> b) -> Vector a -> a
- minIndex :: (Storable a, Ord a) => Vector a -> Int
- minIndexBy :: Storable a => (a -> a -> Ordering) -> Vector a -> Int
- maxIndex :: (Storable a, Ord a) => Vector a -> Int
- maxIndexBy :: Storable a => (a -> a -> Ordering) -> Vector a -> Int
- foldM :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m a
- ifoldM :: (Monad m, Storable b) => (a -> Int -> b -> m a) -> a -> Vector b -> m a
- foldM' :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m a
- ifoldM' :: (Monad m, Storable b) => (a -> Int -> b -> m a) -> a -> Vector b -> m a
- fold1M :: (Monad m, Storable a) => (a -> a -> m a) -> Vector a -> m a
- fold1M' :: (Monad m, Storable a) => (a -> a -> m a) -> Vector a -> m a
- foldM_ :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m ()
- ifoldM_ :: (Monad m, Storable b) => (a -> Int -> b -> m a) -> a -> Vector b -> m ()
- foldM'_ :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m ()
- ifoldM'_ :: (Monad m, Storable b) => (a -> Int -> b -> m a) -> a -> Vector b -> m ()
- fold1M_ :: (Monad m, Storable a) => (a -> a -> m a) -> Vector a -> m ()
- fold1M'_ :: (Monad m, Storable a) => (a -> a -> m a) -> Vector a -> 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
- scanl1 :: Storable a => (a -> a -> a) -> Vector a -> Vector a
- scanl1' :: Storable a => (a -> a -> a) -> Vector a -> Vector a
- iscanl :: (Storable a, Storable b) => (Int -> a -> b -> a) -> a -> Vector b -> Vector a
- iscanl' :: (Storable a, Storable b) => (Int -> 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
- scanr1 :: Storable a => (a -> a -> a) -> Vector a -> Vector a
- scanr1' :: Storable a => (a -> a -> a) -> Vector a -> Vector a
- iscanr :: (Storable a, Storable b) => (Int -> a -> b -> b) -> b -> Vector a -> Vector b
- iscanr' :: (Storable a, Storable b) => (Int -> a -> b -> b) -> b -> Vector a -> Vector b
- eqBy :: (Storable a, Storable b) => (a -> b -> Bool) -> Vector a -> Vector b -> Bool
- cmpBy :: (Storable a, Storable b) => (a -> b -> Ordering) -> Vector a -> Vector b -> Ordering
- isSameVector :: Storable a => Vector a -> Vector a -> Bool
- 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
- unsafeCast :: (Storable a, Storable b) => Vector a -> Vector b
- unsafeCoerceVector :: Coercible a b => Vector a -> Vector b
- 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 ()
- unsafeFreeze :: (Storable a, PrimMonad m) => MVector (PrimState m) a -> m (Vector a)
- unsafeThaw :: (Storable a, PrimMonad m) => Vector a -> m (MVector (PrimState m) a)
- unsafeCopy :: (Storable a, PrimMonad m) => MVector (PrimState m) a -> Vector a -> m ()
- unsafeFromForeignPtr :: Storable a => ForeignPtr a -> Int -> Int -> Vector a
- unsafeFromForeignPtr0 :: ForeignPtr a -> Int -> Vector a
- unsafeToForeignPtr :: Vector a -> (ForeignPtr a, Int, Int)
- unsafeToForeignPtr0 :: Vector a -> (ForeignPtr a, Int)
- unsafeWith :: Storable a => Vector a -> (Ptr a -> IO b) -> IO b
- class Storable a

# Storable vectors

data Vector a #

`Storable`-based vectors.

#### Instances

Instances details

NFData1 Vector # | Since: 0.12.1.0
Instance details Defined in Data.Vector.Storable Methods liftRnf :: (a -> ()) -> Vector a -> () #
Storable a => Vector Vector a # |
Instance details Defined in Data.Vector.Storable Methods basicUnsafeFreeze :: Mutable Vector s a -> ST s (Vector a) # basicUnsafeThaw :: Vector a -> ST s (Mutable Vector s a) # basicLength :: Vector a -> Int # basicUnsafeSlice :: Int -> Int -> Vector a -> Vector a # basicUnsafeIndexM :: Vector a -> Int -> Box a # basicUnsafeCopy :: Mutable Vector s a -> Vector a -> ST s () # elemseq :: Vector a -> a -> b -> b #
NFData (Vector a) # |
Instance details Defined in Data.Vector.Storable Methods rnf :: Vector a -> () #
Storable a => Monoid (Vector a) # |
Instance details Defined in Data.Vector.Storable Methods mempty :: Vector a # mappend :: Vector a -> Vector a -> Vector a # mconcat :: [Vector a] -> Vector a #
Storable a => Semigroup (Vector a) # |
Instance details Defined in Data.Vector.Storable Methods (<>) :: Vector a -> Vector a -> Vector a # sconcat :: NonEmpty (Vector a) -> Vector a # stimes :: Integral b => b -> Vector a -> Vector a #
(Data a, Storable a) => Data (Vector a) # |
Instance details Defined in Data.Vector.Storable Methods 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 => IsList (Vector a) # |
Instance details Defined in Data.Vector.Storable Associated Types
type Item (Vector a) |
Instance details Defined in Data.Vector.Storable type Item (Vector a) = a
Methods fromList :: [Item (Vector a)] -> Vector a # fromListN :: Int -> [Item (Vector a)] -> Vector a # toList :: Vector a -> [Item (Vector a)] #
(Read a, Storable a) => Read (Vector a) # |
Instance details Defined in Data.Vector.Storable Methods readsPrec :: Int -> ReadS (Vector a) # readList :: ReadS [Vector a] # readPrec :: ReadPrec (Vector a) # readListPrec :: ReadPrec [Vector a] #
(Show a, Storable a) => Show (Vector a) # |
Instance details Defined in Data.Vector.Storable Methods showsPrec :: Int -> Vector a -> ShowS # show :: Vector a -> String # showList :: [Vector a] -> ShowS #
(Storable a, Eq a) => Eq (Vector a) # |
Instance details Defined in Data.Vector.Storable Methods (==) :: Vector a -> Vector a -> Bool # (/=) :: Vector a -> Vector a -> Bool #
(Storable a, Ord a) => Ord (Vector a) # |
Instance details Defined in Data.Vector.Storable Methods compare :: Vector a -> Vector a -> Ordering # (<) :: Vector a -> Vector a -> Bool # (<=) :: Vector a -> Vector a -> Bool # (>) :: Vector a -> Vector a -> Bool # (>=) :: Vector a -> Vector a -> Bool # max :: Vector a -> Vector a -> Vector a # min :: Vector a -> Vector a -> Vector a #
type Mutable Vector # |
Instance details Defined in Data.Vector.Storable type Mutable Vector = MVector
type Item (Vector a) # |
Instance details Defined in Data.Vector.Storable type Item (Vector a) = a

data MVector s a #

Mutable `Storable`-based vectors.

Constructors

MVector !Int !(ForeignPtr a) |

#### Instances

Instances details

Storable a => MVector MVector a # |
Instance details Defined in Data.Vector.Storable.Mutable Methods basicLength :: MVector s a -> Int # basicUnsafeSlice :: Int -> Int -> MVector s a -> MVector s a # basicOverlaps :: MVector s a -> MVector s a -> Bool # basicUnsafeNew :: Int -> ST s (MVector s a) # basicInitialize :: MVector s a -> ST s () # basicUnsafeReplicate :: Int -> a -> ST s (MVector s a) # basicUnsafeRead :: MVector s a -> Int -> ST s a # basicUnsafeWrite :: MVector s a -> Int -> a -> ST s () # basicClear :: MVector s a -> ST s () # basicSet :: MVector s a -> a -> ST s () # basicUnsafeCopy :: MVector s a -> MVector s a -> ST s () # basicUnsafeMove :: MVector s a -> MVector s a -> ST s () # basicUnsafeGrow :: MVector s a -> Int -> ST s (MVector s a) #
NFData1 (MVector s) # |
Instance details Defined in Data.Vector.Storable.Mutable Methods liftRnf :: (a -> ()) -> MVector s a -> () #
NFData (MVector s a) # |
Instance details Defined in Data.Vector.Storable.Mutable Methods rnf :: MVector s a -> () #

# Accessors

## Length information

length :: Storable a => Vector a -> Int #

O(1) Yield the length of the vector.

null :: Storable a => Vector a -> Bool #

O(1) Test whether a vector is empty.

## Indexing

(!) :: Storable a => Vector a -> Int -> a #

O(1) Indexing.

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

O(1) Safe indexing.

head :: Storable a => Vector a -> a #

O(1) First element.

last :: Storable a => Vector a -> a #

O(1) Last element.

unsafeIndex :: Storable a => Vector a -> Int -> a #

O(1) Unsafe indexing without bounds checking.

unsafeHead :: Storable a => Vector a -> a #

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

unsafeLast :: Storable a => Vector a -> a #

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

## Monadic indexing

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

O(1) Indexing in a monad.

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

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

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

With `indexM`, copying can be implemented like this instead:

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

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

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

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

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

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

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

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

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

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

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

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 #

Arguments

:: Storable 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 :: Storable a => Vector a -> Vector a #

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

tail :: Storable a => Vector a -> Vector a #

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

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.

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

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 :: Storable a => Vector a -> Maybe (a, Vector a) #

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

Since: 0.12.2.0

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

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

Since: 0.12.2.0

unsafeSlice #

Arguments

:: Storable 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 :: Storable a => Vector a -> Vector a #

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

unsafeTail :: Storable a => Vector a -> Vector a #

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

unsafeTake :: Storable a => Int -> Vector a -> Vector a #

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

unsafeDrop :: Storable a => Int -> Vector a -> Vector a #

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 :: Storable a => Vector a #

O(1) The empty vector.

singleton :: Storable a => a -> Vector a #

O(1) A vector with exactly one element.

replicate :: Storable a => Int -> a -> Vector a #

O(n) A 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 the function \(\max(n - 1, 0)\) times to an initial value, producing a vector of length \(\max(n, 0)\). The 0th element will contain the initial value, which is why there is one less function application than the number of elements in the produced vector.

\( \underbrace{x, f (x), f (f (x)), \ldots}_{\max(0,n)\rm{~elements}} \)

### Examples

Expand

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

Since: 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 the monadic function \(\max(n - 1, 0)\) times to an initial value, producing a vector of length \(\max(n, 0)\). The 0th element will contain the initial value, which is why there is one less function application than the number of elements in the produced vector.

For a non-monadic version, see `iterateN`.

Since: 0.12.0.0

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

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

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

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

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, Storable a) => (b -> m (Maybe (a, b))) -> b -> m (Vector a) #

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, Storable a) => Int -> (b -> m (Maybe (a, b))) -> b -> m (Vector a) #

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, Storable a) => Int -> (b -> m (a, b)) -> b -> m (Vector a) #

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 :: 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 2 5 = <1,3,5,7,9>

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 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 possible, use `enumFromStepN` instead.

## Concatenation

cons :: Storable a => a -> Vector a -> Vector a #

O(n) Prepend an element.

snoc :: Storable a => Vector a -> a -> Vector a #

O(n) Append an element.

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

O(m+n) Concatenate two vectors.

concat :: Storable a => [Vector a] -> Vector a #

O(n) Concatenate all vectors in the list.

## Restricting memory usage

force :: Storable a => Vector a -> Vector a #

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

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

    force (slice 0 2 <huge vector>)

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

# Modifying vectors

## Bulk updates

(//) #

Arguments

:: Storable 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 of index/value pairs, replace the vector element at position `i` by `a`.

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

update_ #

Arguments

:: Storable 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 :: Storable a => Vector a -> [(Int, a)] -> Vector a #

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

unsafeUpdate_ :: Storable a => Vector a -> Vector Int -> Vector a -> Vector a #

Same as `update_`, but without bounds checking.

## Accumulations

accum #

Arguments

:: Storable 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.Storable as VS
    >>> VS.accum (+) (VS.fromList [1000,2000,3000 :: Int]) [(2,4),(1,6),(0,3),(1,10)]
    [1003,2016,3004]

accumulate_ #

Arguments

:: (Storable a, Storable 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 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 :: Storable a => (a -> b -> a) -> Vector a -> [(Int, b)] -> Vector a #

Same as `accum`, but without bounds checking.

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

Same as `accumulate_`, but without bounds checking.

## Permutations

reverse :: Storable a => Vector a -> Vector a #

O(n) Reverse a vector.

backpermute :: Storable a => Vector a -> Vector Int -> Vector a #

O(n) Yield the vector obtained by replacing each element `i` of the index vector by `xs`!`i`. This is equivalent to ``map` (xs`!`) is`, but is often much more efficient.

    backpermute <a,b,c,d> <0,3,2,3,1,0> = <a,d,c,d,b,a>

unsafeBackpermute :: Storable a => Vector a -> Vector Int -> Vector a #

Same as `backpermute`, but without bounds checking.

## Safe destructive updates

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

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

#### Examples

Expand

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

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

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

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, Storable a) => (a -> m b) -> Vector a -> m () #

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

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

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, 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_``.

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

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, Storable a) => Vector a -> (Int -> a -> m b) -> m () #

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 :: (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.

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

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

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

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

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

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

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

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

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

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

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

#### Examples

Expand

    >>> import qualified Data.Vector.Storable as VS
    >>> VS.uniq $ VS.fromList [1,3,3,200,3 :: Int]
    [1,3,200,3]

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

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

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

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

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

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

Since: 0.12.2.0

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

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

Since: 0.12.2.0

takeWhile :: Storable a => (a -> Bool) -> Vector a -> Vector a #

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

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

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

Does not fuse.

#### Examples

Expand

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

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.

Does not fuse.

#### Examples

Expand

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

spanR :: 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.

Does not fuse.

#### Examples

Expand

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

breakR :: 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.

Does not fuse.

@since NEXT_VERSION

#### Examples

Expand

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

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

O(n) Split a vector into a list of slices, using a predicate function.

The concatenation of this list of slices is equal to the argument vector, and each slice contains only equal elements, as determined by the equality predicate function.

Does not fuse.

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

See also `groupBy`, `group`.

Since: 0.13.0.1

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

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

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

Does not fuse.

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

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

See also `group`.

Since: 0.13.0.1

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

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

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

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

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

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

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

Does not fuse.

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

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

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

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

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

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

# Folding

foldl :: Storable b => (a -> b -> a) -> a -> Vector b -> a #

O(n) Left fold.

foldl1 :: Storable a => (a -> a -> a) -> Vector a -> a #

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

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

O(n) Left fold with strict accumulator.

foldl1' :: Storable a => (a -> a -> a) -> Vector a -> a #

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

foldr :: Storable a => (a -> b -> b) -> b -> Vector a -> b #

O(n) Right fold.

foldr1 :: Storable a => (a -> a -> a) -> Vector a -> a #

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

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

O(n) Right fold with a strict accumulator.

foldr1' :: Storable a => (a -> a -> a) -> Vector a -> a #

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

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

O(n) Left fold using a 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 using a function applied to each element and its index.

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

O(n) Right fold using a 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 using a function applied to each element and its index.

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

O(n) Map each element of the structure to a monoid and combine the results. It uses the same implementation as the corresponding method of the `Foldable` type class. Note that it's implemented in terms of `foldr` and won't fuse with functions that traverse the vector from left to right (`map`, `generate`, etc.).

Since: 0.12.2.0

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

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

Since: 0.12.2.0

## Specialised folds

all :: Storable a => (a -> Bool) -> Vector a -> Bool #

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

#### Examples

Expand

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

Expand

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

and :: Vector Bool -> Bool #

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

#### Examples

Expand

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

or :: Vector Bool -> Bool #

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

#### Examples

Expand

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

Expand

    >>> 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 product of the elements.

#### Examples

Expand

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

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

O(n) Yield the maximum element of the vector. The vector may not be empty. In case of a tie, the first occurrence wins.

#### Examples

Expand

    >>> import qualified Data.Vector.Storable as VS
    >>> VS.maximum $ VS.fromList [2, 1 :: Int]
    2

maximumBy :: Storable a => (a -> a -> Ordering) -> Vector a -> a #

O(n) Yield the maximum element of the vector according to the given comparison function. The vector may not be empty. In case of a tie, the first occurrence wins. This behavior is different from `maximumBy` which returns the last tie.

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

O(n) Yield the maximum element of the vector by comparing the results of a key function on each element. In case of a tie, the first occurrence wins. The vector may not be empty.

Since: 0.13.0.0

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

O(n) Yield the minimum element of the vector. The vector may not be empty. In case of a tie, the first occurrence wins.

#### Examples

Expand

    >>> import qualified Data.Vector.Storable as VS
    >>> VS.minimum $ VS.fromList [2, 1 :: Int]
    1

minimumBy :: Storable a => (a -> a -> Ordering) -> Vector a -> a #

O(n) Yield the minimum element of the vector according to the given comparison function. The vector may not be empty. In case of a tie, the first occurrence wins.

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

O(n) Yield the minimum element of the vector by comparing the results of a key function on each element. In case of a tie, the first occurrence wins. The vector may not be empty.

Since: 0.13.0.0

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

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

minIndexBy :: Storable a => (a -> a -> Ordering) -> Vector a -> Int #

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

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

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

maxIndexBy :: Storable a => (a -> a -> Ordering) -> Vector a -> Int #

O(n) Yield the index of the maximum element of the vector according to the given comparison function. The vector may not be empty. In case of a tie, the first occurrence wins.

## Monadic folds

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

O(n) Monadic fold.

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

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

Since: 0.12.2.0

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

O(n) Monadic fold with strict accumulator.

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

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

Since: 0.12.2.0

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

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

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

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

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

O(n) Monadic fold that discards the result.

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

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

Since: 0.12.2.0

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

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

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

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

Since: 0.12.2.0

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

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

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

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

# Scans

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

O(n) Left-to-right prescan.

    prescanl f z = init . scanl f z

#### Examples

Expand

    >>> import qualified Data.Vector.Storable as VS
    >>> VS.prescanl (+) 0 (VS.fromList [1,2,3,4 :: Int])
    [0,1,3,6]

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

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

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

O(n) Left-to-right postscan.

    postscanl f z = tail . scanl f z

#### Examples

Expand

    >>> import qualified Data.Vector.Storable as VS
    >>> VS.postscanl (+) 0 (VS.fromList [1,2,3,4 :: Int])
    [1,3,6,10]

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

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

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

O(n) Left-to-right scan.

    scanl f z <x1,...,xn> = <y1,...,y(n+1)>
      where y1 = z
            yi = f y(i-1) x(i-1)

#### Examples

Expand

    >>> import qualified Data.Vector.Storable as VS
    >>> VS.scanl (+) 0 (VS.fromList [1,2,3,4 :: Int])
    [0,1,3,6,10]

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

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

scanl1 :: Storable a => (a -> a -> a) -> Vector a -> Vector a #

O(n) Initial-value free left-to-right scan over a vector.

    scanl f <x1,...,xn> = <y1,...,yn>
      where y1 = x1
            yi = f y(i-1) xi

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

#### Examples

Expand

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

scanl1' :: Storable a => (a -> a -> a) -> Vector a -> Vector a #

O(n) Initial-value free left-to-right scan over a vector with a strict accumulator.

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

#### Examples

Expand

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

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

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

Since: 0.12.2.0

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

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

Since: 0.12.2.0

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

O(n) Right-to-left prescan.

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

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

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

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

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

O(n) Right-to-left scan.

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

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

scanr1 :: Storable a => (a -> a -> a) -> Vector a -> Vector a #

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

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

#### Examples

Expand

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

scanr1' :: Storable a => (a -> a -> a) -> Vector a -> Vector a #

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

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

#### Examples

Expand

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

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

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

Since: 0.12.2.0

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

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

Since: 0.12.2.0

## Comparisons

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

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

Since: 0.12.2.0

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

O(n) Compare two vectors using supplied the comparison function for vector elements. Comparison works the same as for lists.

    cmpBy compare == compare

Since: 0.12.2.0

# Utilities

## Comparisons

isSameVector :: Storable a => Vector a -> Vector a -> Bool #

Checks whether two values are the same vector: they have same length and share the same buffer.

    >>> import qualified Data.Vector.Storable as VS
    >>> let xs = VS.fromList [0/0::Double] in VS.isSameVector xs xs
    True

# Conversions

## Lists

toList :: Storable a => Vector a -> [a] #

O(n) Convert a vector to a list.

fromList :: Storable a => [a] -> Vector a #

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

Since: 0.4

fromListN :: Storable a => Int -> [a] -> Vector a #

O(n) Convert the first `n` elements of a list to a vector. It's expected that the supplied list will be exactly `n` elements long. As an optimization, this function allocates a buffer for `n` elements, which could be used for DoS-attacks by exhausting the memory if an attacker controls that parameter.

    fromListN n xs = fromList (take n xs)

#### Examples

Expand

    >>> import qualified Data.Vector.Storable as VS
    >>> VS.fromListN 3 [1,2,3,4,5 :: Int]
    [1,2,3]
    >>> VS.fromListN 3 [1 :: Int]
    [1]

## Other vector types

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

O(n) Convert between different vector types.

unsafeCast :: (Storable a, Storable b) => Vector a -> Vector b #

O(1) Unsafely cast a vector from one element type to another. This operation just changes the type of the underlying pointer and does not modify the elements.

The resulting vector contains as many elements as can fit into the underlying memory block.

unsafeCoerceVector :: Coercible a b => Vector a -> Vector b #

O(1) Unsafely coerce a mutable vector from one element type to another, representationally equal type. The operation just changes the type of the underlying pointer and does not modify the elements.

This is marginally safer than `unsafeCast`, since this function imposes an extra `Coercible` constraint. This function is still not safe, however, since it cannot guarantee that the two types have memory-compatible `Storable` instances.

## Mutable vectors

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

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

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

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

copy :: (Storable a, PrimMonad m) => MVector (PrimState m) a -> Vector a -> m () #

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

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

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

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

O(1) Unsafely convert an immutable vector to a mutable one without copying. Note that this is a very dangerous function and generally it's only safe to read from the resulting vector. In this case, the immutable vector could be used safely as well.

Problems with mutation happen because GHC has a lot of freedom to introduce sharing. As a result mutable vectors produced by `unsafeThaw` may or may not share the same underlying buffer. For example:

    foo = do
      let vec = V.generate 10 id
      mvec <- V.unsafeThaw vec
      do_something mvec

Here GHC could lift `vec` outside of foo which means that all calls to `do_something` will use same buffer with possibly disastrous results. Whether such aliasing happens or not depends on the program in question, optimization levels, and GHC flags.

All in all, attempts to modify a vector produced by `unsafeThaw` fall out of domain of software engineering and into realm of black magic, dark rituals, and unspeakable horrors. The only advice that could be given is: "Don't attempt to mutate a vector produced by `unsafeThaw` unless you know how to prevent GHC from aliasing buffers accidentally. We don't."

unsafeCopy :: (Storable a, PrimMonad m) => MVector (PrimState m) a -> Vector a -> m () #

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

# Raw pointers

unsafeFromForeignPtr #

Arguments

:: Storable a |
=> ForeignPtr a | pointer
-> Int | offset
-> Int | length
-> Vector a |

O(1) Create a vector from a `ForeignPtr` with an offset and a length.

The data may not be modified through the pointer afterwards.

If your offset is 0 it is more efficient to use `unsafeFromForeignPtr0`.

unsafeFromForeignPtr0 #

Arguments

:: ForeignPtr a | pointer
-> Int | length
-> Vector a |

O(1) Create a vector from a `ForeignPtr` and a length.

It is assumed the pointer points directly to the data (no offset). Use `unsafeFromForeignPtr` if you need to specify an offset.

The data may not be modified through the pointer afterwards.

unsafeToForeignPtr :: Vector a -> (ForeignPtr a, Int, Int) #

O(1) Yield the underlying `ForeignPtr` together with the offset to the data and its length. The data may not be modified through the `ForeignPtr`.

unsafeToForeignPtr0 :: Vector a -> (ForeignPtr a, Int) #

O(1) Yield the underlying `ForeignPtr` together with its length.

You can assume that the pointer points directly to the data (no offset).

The data may not be modified through the `ForeignPtr`.

unsafeWith :: Storable a => Vector a -> (Ptr a -> IO b) -> IO b #

Pass a pointer to the vector's data to the IO action. The data may not be modified through the 'Ptr.

# Re-exports

class Storable a #

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 ``Ptr` a`, for some `a` 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`.

Minimal complete definition

sizeOf, alignment, (peek | peekElemOff | peekByteOff), (poke | pokeElemOff | pokeByteOff)

#### Instances

Instances details

Storable Fingerprint | @since base-4.4.0.0
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Fingerprint -> Int # alignment :: Fingerprint -> Int # peekElemOff :: Ptr Fingerprint -> Int -> IO Fingerprint # pokeElemOff :: Ptr Fingerprint -> Int -> Fingerprint -> IO () # peekByteOff :: Ptr b -> Int -> IO Fingerprint # pokeByteOff :: Ptr b -> Int -> Fingerprint -> IO () # peek :: Ptr Fingerprint -> IO Fingerprint # poke :: Ptr Fingerprint -> Fingerprint -> IO () #
Storable CBool |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CBool -> Int # alignment :: CBool -> Int # peekElemOff :: Ptr CBool -> Int -> IO CBool # pokeElemOff :: Ptr CBool -> Int -> CBool -> IO () # peekByteOff :: Ptr b -> Int -> IO CBool # pokeByteOff :: Ptr b -> Int -> CBool -> IO () # peek :: Ptr CBool -> IO CBool # poke :: Ptr CBool -> CBool -> IO () #
Storable CChar |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CChar -> Int # alignment :: CChar -> Int # peekElemOff :: Ptr CChar -> Int -> IO CChar # pokeElemOff :: Ptr CChar -> Int -> CChar -> IO () # peekByteOff :: Ptr b -> Int -> IO CChar # pokeByteOff :: Ptr b -> Int -> CChar -> IO () # peek :: Ptr CChar -> IO CChar # poke :: Ptr CChar -> CChar -> IO () #
Storable CClock |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CClock -> Int # alignment :: CClock -> Int # peekElemOff :: Ptr CClock -> Int -> IO CClock # pokeElemOff :: Ptr CClock -> Int -> CClock -> IO () # peekByteOff :: Ptr b -> Int -> IO CClock # pokeByteOff :: Ptr b -> Int -> CClock -> IO () # peek :: Ptr CClock -> IO CClock # poke :: Ptr CClock -> CClock -> IO () #
Storable CDouble |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CDouble -> Int # alignment :: CDouble -> Int # peekElemOff :: Ptr CDouble -> Int -> IO CDouble # pokeElemOff :: Ptr CDouble -> Int -> CDouble -> IO () # peekByteOff :: Ptr b -> Int -> IO CDouble # pokeByteOff :: Ptr b -> Int -> CDouble -> IO () # peek :: Ptr CDouble -> IO CDouble # poke :: Ptr CDouble -> CDouble -> IO () #
Storable CFloat |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CFloat -> Int # alignment :: CFloat -> Int # peekElemOff :: Ptr CFloat -> Int -> IO CFloat # pokeElemOff :: Ptr CFloat -> Int -> CFloat -> IO () # peekByteOff :: Ptr b -> Int -> IO CFloat # pokeByteOff :: Ptr b -> Int -> CFloat -> IO () # peek :: Ptr CFloat -> IO CFloat # poke :: Ptr CFloat -> CFloat -> IO () #
Storable CInt |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CInt -> Int # alignment :: CInt -> Int # peekElemOff :: Ptr CInt -> Int -> IO CInt # pokeElemOff :: Ptr CInt -> Int -> CInt -> IO () # peekByteOff :: Ptr b -> Int -> IO CInt # pokeByteOff :: Ptr b -> Int -> CInt -> IO () # peek :: Ptr CInt -> IO CInt # poke :: Ptr CInt -> CInt -> IO () #
Storable CIntMax |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CIntMax -> Int # alignment :: CIntMax -> Int # peekElemOff :: Ptr CIntMax -> Int -> IO CIntMax # pokeElemOff :: Ptr CIntMax -> Int -> CIntMax -> IO () # peekByteOff :: Ptr b -> Int -> IO CIntMax # pokeByteOff :: Ptr b -> Int -> CIntMax -> IO () # peek :: Ptr CIntMax -> IO CIntMax # poke :: Ptr CIntMax -> CIntMax -> IO () #
Storable CIntPtr |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CIntPtr -> Int # alignment :: CIntPtr -> Int # peekElemOff :: Ptr CIntPtr -> Int -> IO CIntPtr # pokeElemOff :: Ptr CIntPtr -> Int -> CIntPtr -> IO () # peekByteOff :: Ptr b -> Int -> IO CIntPtr # pokeByteOff :: Ptr b -> Int -> CIntPtr -> IO () # peek :: Ptr CIntPtr -> IO CIntPtr # poke :: Ptr CIntPtr -> CIntPtr -> IO () #
Storable CLLong |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CLLong -> Int # alignment :: CLLong -> Int # peekElemOff :: Ptr CLLong -> Int -> IO CLLong # pokeElemOff :: Ptr CLLong -> Int -> CLLong -> IO () # peekByteOff :: Ptr b -> Int -> IO CLLong # pokeByteOff :: Ptr b -> Int -> CLLong -> IO () # peek :: Ptr CLLong -> IO CLLong # poke :: Ptr CLLong -> CLLong -> IO () #
Storable CLong |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CLong -> Int # alignment :: CLong -> Int # peekElemOff :: Ptr CLong -> Int -> IO CLong # pokeElemOff :: Ptr CLong -> Int -> CLong -> IO () # peekByteOff :: Ptr b -> Int -> IO CLong # pokeByteOff :: Ptr b -> Int -> CLong -> IO () # peek :: Ptr CLong -> IO CLong # poke :: Ptr CLong -> CLong -> IO () #
Storable CPtrdiff |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CPtrdiff -> Int # alignment :: CPtrdiff -> Int # peekElemOff :: Ptr CPtrdiff -> Int -> IO CPtrdiff # pokeElemOff :: Ptr CPtrdiff -> Int -> CPtrdiff -> IO () # peekByteOff :: Ptr b -> Int -> IO CPtrdiff # pokeByteOff :: Ptr b -> Int -> CPtrdiff -> IO () # peek :: Ptr CPtrdiff -> IO CPtrdiff # poke :: Ptr CPtrdiff -> CPtrdiff -> IO () #
Storable CSChar |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CSChar -> Int # alignment :: CSChar -> Int # peekElemOff :: Ptr CSChar -> Int -> IO CSChar # pokeElemOff :: Ptr CSChar -> Int -> CSChar -> IO () # peekByteOff :: Ptr b -> Int -> IO CSChar # pokeByteOff :: Ptr b -> Int -> CSChar -> IO () # peek :: Ptr CSChar -> IO CSChar # poke :: Ptr CSChar -> CSChar -> IO () #
Storable CSUSeconds |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CSUSeconds -> Int # alignment :: CSUSeconds -> Int # peekElemOff :: Ptr CSUSeconds -> Int -> IO CSUSeconds # pokeElemOff :: Ptr CSUSeconds -> Int -> CSUSeconds -> IO () # peekByteOff :: Ptr b -> Int -> IO CSUSeconds # pokeByteOff :: Ptr b -> Int -> CSUSeconds -> IO () # peek :: Ptr CSUSeconds -> IO CSUSeconds # poke :: Ptr CSUSeconds -> CSUSeconds -> IO () #
Storable CShort |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CShort -> Int # alignment :: CShort -> Int # peekElemOff :: Ptr CShort -> Int -> IO CShort # pokeElemOff :: Ptr CShort -> Int -> CShort -> IO () # peekByteOff :: Ptr b -> Int -> IO CShort # pokeByteOff :: Ptr b -> Int -> CShort -> IO () # peek :: Ptr CShort -> IO CShort # poke :: Ptr CShort -> CShort -> IO () #
Storable CSigAtomic |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CSigAtomic -> Int # alignment :: CSigAtomic -> Int # peekElemOff :: Ptr CSigAtomic -> Int -> IO CSigAtomic # pokeElemOff :: Ptr CSigAtomic -> Int -> CSigAtomic -> IO () # peekByteOff :: Ptr b -> Int -> IO CSigAtomic # pokeByteOff :: Ptr b -> Int -> CSigAtomic -> IO () # peek :: Ptr CSigAtomic -> IO CSigAtomic # poke :: Ptr CSigAtomic -> CSigAtomic -> IO () #
Storable CSize |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CSize -> Int # alignment :: CSize -> Int # peekElemOff :: Ptr CSize -> Int -> IO CSize # pokeElemOff :: Ptr CSize -> Int -> CSize -> IO () # peekByteOff :: Ptr b -> Int -> IO CSize # pokeByteOff :: Ptr b -> Int -> CSize -> IO () # peek :: Ptr CSize -> IO CSize # poke :: Ptr CSize -> CSize -> IO () #
Storable CTime |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CTime -> Int # alignment :: CTime -> Int # peekElemOff :: Ptr CTime -> Int -> IO CTime # pokeElemOff :: Ptr CTime -> Int -> CTime -> IO () # peekByteOff :: Ptr b -> Int -> IO CTime # pokeByteOff :: Ptr b -> Int -> CTime -> IO () # peek :: Ptr CTime -> IO CTime # poke :: Ptr CTime -> CTime -> IO () #
Storable CUChar |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CUChar -> Int # alignment :: CUChar -> Int # peekElemOff :: Ptr CUChar -> Int -> IO CUChar # pokeElemOff :: Ptr CUChar -> Int -> CUChar -> IO () # peekByteOff :: Ptr b -> Int -> IO CUChar # pokeByteOff :: Ptr b -> Int -> CUChar -> IO () # peek :: Ptr CUChar -> IO CUChar # poke :: Ptr CUChar -> CUChar -> IO () #
Storable CUInt |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CUInt -> Int # alignment :: CUInt -> Int # peekElemOff :: Ptr CUInt -> Int -> IO CUInt # pokeElemOff :: Ptr CUInt -> Int -> CUInt -> IO () # peekByteOff :: Ptr b -> Int -> IO CUInt # pokeByteOff :: Ptr b -> Int -> CUInt -> IO () # peek :: Ptr CUInt -> IO CUInt # poke :: Ptr CUInt -> CUInt -> IO () #
Storable CUIntMax |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CUIntMax -> Int # alignment :: CUIntMax -> Int # peekElemOff :: Ptr CUIntMax -> Int -> IO CUIntMax # pokeElemOff :: Ptr CUIntMax -> Int -> CUIntMax -> IO () # peekByteOff :: Ptr b -> Int -> IO CUIntMax # pokeByteOff :: Ptr b -> Int -> CUIntMax -> IO () # peek :: Ptr CUIntMax -> IO CUIntMax # poke :: Ptr CUIntMax -> CUIntMax -> IO () #
Storable CUIntPtr |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CUIntPtr -> Int # alignment :: CUIntPtr -> Int # peekElemOff :: Ptr CUIntPtr -> Int -> IO CUIntPtr # pokeElemOff :: Ptr CUIntPtr -> Int -> CUIntPtr -> IO () # peekByteOff :: Ptr b -> Int -> IO CUIntPtr # pokeByteOff :: Ptr b -> Int -> CUIntPtr -> IO () # peek :: Ptr CUIntPtr -> IO CUIntPtr # poke :: Ptr CUIntPtr -> CUIntPtr -> IO () #
Storable CULLong |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CULLong -> Int # alignment :: CULLong -> Int # peekElemOff :: Ptr CULLong -> Int -> IO CULLong # pokeElemOff :: Ptr CULLong -> Int -> CULLong -> IO () # peekByteOff :: Ptr b -> Int -> IO CULLong # pokeByteOff :: Ptr b -> Int -> CULLong -> IO () # peek :: Ptr CULLong -> IO CULLong # poke :: Ptr CULLong -> CULLong -> IO () #
Storable CULong |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CULong -> Int # alignment :: CULong -> Int # peekElemOff :: Ptr CULong -> Int -> IO CULong # pokeElemOff :: Ptr CULong -> Int -> CULong -> IO () # peekByteOff :: Ptr b -> Int -> IO CULong # pokeByteOff :: Ptr b -> Int -> CULong -> IO () # peek :: Ptr CULong -> IO CULong # poke :: Ptr CULong -> CULong -> IO () #
Storable CUSeconds |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CUSeconds -> Int # alignment :: CUSeconds -> Int # peekElemOff :: Ptr CUSeconds -> Int -> IO CUSeconds # pokeElemOff :: Ptr CUSeconds -> Int -> CUSeconds -> IO () # peekByteOff :: Ptr b -> Int -> IO CUSeconds # pokeByteOff :: Ptr b -> Int -> CUSeconds -> IO () # peek :: Ptr CUSeconds -> IO CUSeconds # poke :: Ptr CUSeconds -> CUSeconds -> IO () #
Storable CUShort |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CUShort -> Int # alignment :: CUShort -> Int # peekElemOff :: Ptr CUShort -> Int -> IO CUShort # pokeElemOff :: Ptr CUShort -> Int -> CUShort -> IO () # peekByteOff :: Ptr b -> Int -> IO CUShort # pokeByteOff :: Ptr b -> Int -> CUShort -> IO () # peek :: Ptr CUShort -> IO CUShort # poke :: Ptr CUShort -> CUShort -> IO () #
Storable CWchar |
Instance details Defined in GHC.Internal.Foreign.C.Types Methods sizeOf :: CWchar -> Int # alignment :: CWchar -> Int # peekElemOff :: Ptr CWchar -> Int -> IO CWchar # pokeElemOff :: Ptr CWchar -> Int -> CWchar -> IO () # peekByteOff :: Ptr b -> Int -> IO CWchar # pokeByteOff :: Ptr b -> Int -> CWchar -> IO () # peek :: Ptr CWchar -> IO CWchar # poke :: Ptr CWchar -> CWchar -> IO () #
Storable IntPtr |
Instance details Defined in GHC.Internal.Foreign.Ptr Methods sizeOf :: IntPtr -> Int # alignment :: IntPtr -> Int # peekElemOff :: Ptr IntPtr -> Int -> IO IntPtr # pokeElemOff :: Ptr IntPtr -> Int -> IntPtr -> IO () # peekByteOff :: Ptr b -> Int -> IO IntPtr # pokeByteOff :: Ptr b -> Int -> IntPtr -> IO () # peek :: Ptr IntPtr -> IO IntPtr # poke :: Ptr IntPtr -> IntPtr -> IO () #
Storable WordPtr |
Instance details Defined in GHC.Internal.Foreign.Ptr Methods sizeOf :: WordPtr -> Int # alignment :: WordPtr -> Int # peekElemOff :: Ptr WordPtr -> Int -> IO WordPtr # pokeElemOff :: Ptr WordPtr -> Int -> WordPtr -> IO () # peekByteOff :: Ptr b -> Int -> IO WordPtr # pokeByteOff :: Ptr b -> Int -> WordPtr -> IO () # peek :: Ptr WordPtr -> IO WordPtr # poke :: Ptr WordPtr -> WordPtr -> IO () #
Storable Int16 | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Int16 -> Int # alignment :: Int16 -> Int # peekElemOff :: Ptr Int16 -> Int -> IO Int16 # pokeElemOff :: Ptr Int16 -> Int -> Int16 -> IO () # peekByteOff :: Ptr b -> Int -> IO Int16 # pokeByteOff :: Ptr b -> Int -> Int16 -> IO () # peek :: Ptr Int16 -> IO Int16 # poke :: Ptr Int16 -> Int16 -> IO () #
Storable Int32 | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Int32 -> Int # alignment :: Int32 -> Int # peekElemOff :: Ptr Int32 -> Int -> IO Int32 # pokeElemOff :: Ptr Int32 -> Int -> Int32 -> IO () # peekByteOff :: Ptr b -> Int -> IO Int32 # pokeByteOff :: Ptr b -> Int -> Int32 -> IO () # peek :: Ptr Int32 -> IO Int32 # poke :: Ptr Int32 -> Int32 -> IO () #
Storable Int64 | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Int64 -> Int # alignment :: Int64 -> Int # peekElemOff :: Ptr Int64 -> Int -> IO Int64 # pokeElemOff :: Ptr Int64 -> Int -> Int64 -> IO () # peekByteOff :: Ptr b -> Int -> IO Int64 # pokeByteOff :: Ptr b -> Int -> Int64 -> IO () # peek :: Ptr Int64 -> IO Int64 # poke :: Ptr Int64 -> Int64 -> IO () #
Storable Int8 | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Int8 -> Int # alignment :: Int8 -> Int # peekElemOff :: Ptr Int8 -> Int -> IO Int8 # pokeElemOff :: Ptr Int8 -> Int -> Int8 -> IO () # peekByteOff :: Ptr b -> Int -> IO Int8 # pokeByteOff :: Ptr b -> Int -> Int8 -> IO () # peek :: Ptr Int8 -> IO Int8 # poke :: Ptr Int8 -> Int8 -> IO () #
Storable IoSubSystem | @since base-4.9.0.0
Instance details Defined in GHC.Internal.RTS.Flags Methods sizeOf :: IoSubSystem -> Int # alignment :: IoSubSystem -> Int # peekElemOff :: Ptr IoSubSystem -> Int -> IO IoSubSystem # pokeElemOff :: Ptr IoSubSystem -> Int -> IoSubSystem -> IO () # peekByteOff :: Ptr b -> Int -> IO IoSubSystem # pokeByteOff :: Ptr b -> Int -> IoSubSystem -> IO () # peek :: Ptr IoSubSystem -> IO IoSubSystem # poke :: Ptr IoSubSystem -> IoSubSystem -> IO () #
Storable CBlkCnt |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CBlkCnt -> Int # alignment :: CBlkCnt -> Int # peekElemOff :: Ptr CBlkCnt -> Int -> IO CBlkCnt # pokeElemOff :: Ptr CBlkCnt -> Int -> CBlkCnt -> IO () # peekByteOff :: Ptr b -> Int -> IO CBlkCnt # pokeByteOff :: Ptr b -> Int -> CBlkCnt -> IO () # peek :: Ptr CBlkCnt -> IO CBlkCnt # poke :: Ptr CBlkCnt -> CBlkCnt -> IO () #
Storable CBlkSize |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CBlkSize -> Int # alignment :: CBlkSize -> Int # peekElemOff :: Ptr CBlkSize -> Int -> IO CBlkSize # pokeElemOff :: Ptr CBlkSize -> Int -> CBlkSize -> IO () # peekByteOff :: Ptr b -> Int -> IO CBlkSize # pokeByteOff :: Ptr b -> Int -> CBlkSize -> IO () # peek :: Ptr CBlkSize -> IO CBlkSize # poke :: Ptr CBlkSize -> CBlkSize -> IO () #
Storable CCc |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CCc -> Int # alignment :: CCc -> Int # peekElemOff :: Ptr CCc -> Int -> IO CCc # pokeElemOff :: Ptr CCc -> Int -> CCc -> IO () # peekByteOff :: Ptr b -> Int -> IO CCc # pokeByteOff :: Ptr b -> Int -> CCc -> IO () # peek :: Ptr CCc -> IO CCc # poke :: Ptr CCc -> CCc -> IO () #
Storable CClockId |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CClockId -> Int # alignment :: CClockId -> Int # peekElemOff :: Ptr CClockId -> Int -> IO CClockId # pokeElemOff :: Ptr CClockId -> Int -> CClockId -> IO () # peekByteOff :: Ptr b -> Int -> IO CClockId # pokeByteOff :: Ptr b -> Int -> CClockId -> IO () # peek :: Ptr CClockId -> IO CClockId # poke :: Ptr CClockId -> CClockId -> IO () #
Storable CDev |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CDev -> Int # alignment :: CDev -> Int # peekElemOff :: Ptr CDev -> Int -> IO CDev # pokeElemOff :: Ptr CDev -> Int -> CDev -> IO () # peekByteOff :: Ptr b -> Int -> IO CDev # pokeByteOff :: Ptr b -> Int -> CDev -> IO () # peek :: Ptr CDev -> IO CDev # poke :: Ptr CDev -> CDev -> IO () #
Storable CFsBlkCnt |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CFsBlkCnt -> Int # alignment :: CFsBlkCnt -> Int # peekElemOff :: Ptr CFsBlkCnt -> Int -> IO CFsBlkCnt # pokeElemOff :: Ptr CFsBlkCnt -> Int -> CFsBlkCnt -> IO () # peekByteOff :: Ptr b -> Int -> IO CFsBlkCnt # pokeByteOff :: Ptr b -> Int -> CFsBlkCnt -> IO () # peek :: Ptr CFsBlkCnt -> IO CFsBlkCnt # poke :: Ptr CFsBlkCnt -> CFsBlkCnt -> IO () #
Storable CFsFilCnt |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CFsFilCnt -> Int # alignment :: CFsFilCnt -> Int # peekElemOff :: Ptr CFsFilCnt -> Int -> IO CFsFilCnt # pokeElemOff :: Ptr CFsFilCnt -> Int -> CFsFilCnt -> IO () # peekByteOff :: Ptr b -> Int -> IO CFsFilCnt # pokeByteOff :: Ptr b -> Int -> CFsFilCnt -> IO () # peek :: Ptr CFsFilCnt -> IO CFsFilCnt # poke :: Ptr CFsFilCnt -> CFsFilCnt -> IO () #
Storable CGid |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CGid -> Int # alignment :: CGid -> Int # peekElemOff :: Ptr CGid -> Int -> IO CGid # pokeElemOff :: Ptr CGid -> Int -> CGid -> IO () # peekByteOff :: Ptr b -> Int -> IO CGid # pokeByteOff :: Ptr b -> Int -> CGid -> IO () # peek :: Ptr CGid -> IO CGid # poke :: Ptr CGid -> CGid -> IO () #
Storable CId |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CId -> Int # alignment :: CId -> Int # peekElemOff :: Ptr CId -> Int -> IO CId # pokeElemOff :: Ptr CId -> Int -> CId -> IO () # peekByteOff :: Ptr b -> Int -> IO CId # pokeByteOff :: Ptr b -> Int -> CId -> IO () # peek :: Ptr CId -> IO CId # poke :: Ptr CId -> CId -> IO () #
Storable CIno |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CIno -> Int # alignment :: CIno -> Int # peekElemOff :: Ptr CIno -> Int -> IO CIno # pokeElemOff :: Ptr CIno -> Int -> CIno -> IO () # peekByteOff :: Ptr b -> Int -> IO CIno # pokeByteOff :: Ptr b -> Int -> CIno -> IO () # peek :: Ptr CIno -> IO CIno # poke :: Ptr CIno -> CIno -> IO () #
Storable CKey |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CKey -> Int # alignment :: CKey -> Int # peekElemOff :: Ptr CKey -> Int -> IO CKey # pokeElemOff :: Ptr CKey -> Int -> CKey -> IO () # peekByteOff :: Ptr b -> Int -> IO CKey # pokeByteOff :: Ptr b -> Int -> CKey -> IO () # peek :: Ptr CKey -> IO CKey # poke :: Ptr CKey -> CKey -> IO () #
Storable CMode |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CMode -> Int # alignment :: CMode -> Int # peekElemOff :: Ptr CMode -> Int -> IO CMode # pokeElemOff :: Ptr CMode -> Int -> CMode -> IO () # peekByteOff :: Ptr b -> Int -> IO CMode # pokeByteOff :: Ptr b -> Int -> CMode -> IO () # peek :: Ptr CMode -> IO CMode # poke :: Ptr CMode -> CMode -> IO () #
Storable CNfds |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CNfds -> Int # alignment :: CNfds -> Int # peekElemOff :: Ptr CNfds -> Int -> IO CNfds # pokeElemOff :: Ptr CNfds -> Int -> CNfds -> IO () # peekByteOff :: Ptr b -> Int -> IO CNfds # pokeByteOff :: Ptr b -> Int -> CNfds -> IO () # peek :: Ptr CNfds -> IO CNfds # poke :: Ptr CNfds -> CNfds -> IO () #
Storable CNlink |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CNlink -> Int # alignment :: CNlink -> Int # peekElemOff :: Ptr CNlink -> Int -> IO CNlink # pokeElemOff :: Ptr CNlink -> Int -> CNlink -> IO () # peekByteOff :: Ptr b -> Int -> IO CNlink # pokeByteOff :: Ptr b -> Int -> CNlink -> IO () # peek :: Ptr CNlink -> IO CNlink # poke :: Ptr CNlink -> CNlink -> IO () #
Storable COff |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: COff -> Int # alignment :: COff -> Int # peekElemOff :: Ptr COff -> Int -> IO COff # pokeElemOff :: Ptr COff -> Int -> COff -> IO () # peekByteOff :: Ptr b -> Int -> IO COff # pokeByteOff :: Ptr b -> Int -> COff -> IO () # peek :: Ptr COff -> IO COff # poke :: Ptr COff -> COff -> IO () #
Storable CPid |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CPid -> Int # alignment :: CPid -> Int # peekElemOff :: Ptr CPid -> Int -> IO CPid # pokeElemOff :: Ptr CPid -> Int -> CPid -> IO () # peekByteOff :: Ptr b -> Int -> IO CPid # pokeByteOff :: Ptr b -> Int -> CPid -> IO () # peek :: Ptr CPid -> IO CPid # poke :: Ptr CPid -> CPid -> IO () #
Storable CRLim |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CRLim -> Int # alignment :: CRLim -> Int # peekElemOff :: Ptr CRLim -> Int -> IO CRLim # pokeElemOff :: Ptr CRLim -> Int -> CRLim -> IO () # peekByteOff :: Ptr b -> Int -> IO CRLim # pokeByteOff :: Ptr b -> Int -> CRLim -> IO () # peek :: Ptr CRLim -> IO CRLim # poke :: Ptr CRLim -> CRLim -> IO () #
Storable CSocklen |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CSocklen -> Int # alignment :: CSocklen -> Int # peekElemOff :: Ptr CSocklen -> Int -> IO CSocklen # pokeElemOff :: Ptr CSocklen -> Int -> CSocklen -> IO () # peekByteOff :: Ptr b -> Int -> IO CSocklen # pokeByteOff :: Ptr b -> Int -> CSocklen -> IO () # peek :: Ptr CSocklen -> IO CSocklen # poke :: Ptr CSocklen -> CSocklen -> IO () #
Storable CSpeed |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CSpeed -> Int # alignment :: CSpeed -> Int # peekElemOff :: Ptr CSpeed -> Int -> IO CSpeed # pokeElemOff :: Ptr CSpeed -> Int -> CSpeed -> IO () # peekByteOff :: Ptr b -> Int -> IO CSpeed # pokeByteOff :: Ptr b -> Int -> CSpeed -> IO () # peek :: Ptr CSpeed -> IO CSpeed # poke :: Ptr CSpeed -> CSpeed -> IO () #
Storable CSsize |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CSsize -> Int # alignment :: CSsize -> Int # peekElemOff :: Ptr CSsize -> Int -> IO CSsize # pokeElemOff :: Ptr CSsize -> Int -> CSsize -> IO () # peekByteOff :: Ptr b -> Int -> IO CSsize # pokeByteOff :: Ptr b -> Int -> CSsize -> IO () # peek :: Ptr CSsize -> IO CSsize # poke :: Ptr CSsize -> CSsize -> IO () #
Storable CTcflag |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CTcflag -> Int # alignment :: CTcflag -> Int # peekElemOff :: Ptr CTcflag -> Int -> IO CTcflag # pokeElemOff :: Ptr CTcflag -> Int -> CTcflag -> IO () # peekByteOff :: Ptr b -> Int -> IO CTcflag # pokeByteOff :: Ptr b -> Int -> CTcflag -> IO () # peek :: Ptr CTcflag -> IO CTcflag # poke :: Ptr CTcflag -> CTcflag -> IO () #
Storable CTimer |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CTimer -> Int # alignment :: CTimer -> Int # peekElemOff :: Ptr CTimer -> Int -> IO CTimer # pokeElemOff :: Ptr CTimer -> Int -> CTimer -> IO () # peekByteOff :: Ptr b -> Int -> IO CTimer # pokeByteOff :: Ptr b -> Int -> CTimer -> IO () # peek :: Ptr CTimer -> IO CTimer # poke :: Ptr CTimer -> CTimer -> IO () #
Storable CUid |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: CUid -> Int # alignment :: CUid -> Int # peekElemOff :: Ptr CUid -> Int -> IO CUid # pokeElemOff :: Ptr CUid -> Int -> CUid -> IO () # peekByteOff :: Ptr b -> Int -> IO CUid # pokeByteOff :: Ptr b -> Int -> CUid -> IO () # peek :: Ptr CUid -> IO CUid # poke :: Ptr CUid -> CUid -> IO () #
Storable Fd |
Instance details Defined in GHC.Internal.System.Posix.Types Methods sizeOf :: Fd -> Int # alignment :: Fd -> Int # peekElemOff :: Ptr Fd -> Int -> IO Fd # pokeElemOff :: Ptr Fd -> Int -> Fd -> IO () # peekByteOff :: Ptr b -> Int -> IO Fd # pokeByteOff :: Ptr b -> Int -> Fd -> IO () # peek :: Ptr Fd -> IO Fd # poke :: Ptr Fd -> Fd -> IO () #
Storable Word16 | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Word16 -> Int # alignment :: Word16 -> Int # peekElemOff :: Ptr Word16 -> Int -> IO Word16 # pokeElemOff :: Ptr Word16 -> Int -> Word16 -> IO () # peekByteOff :: Ptr b -> Int -> IO Word16 # pokeByteOff :: Ptr b -> Int -> Word16 -> IO () # peek :: Ptr Word16 -> IO Word16 # poke :: Ptr Word16 -> Word16 -> IO () #
Storable Word32 | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Word32 -> Int # alignment :: Word32 -> Int # peekElemOff :: Ptr Word32 -> Int -> IO Word32 # pokeElemOff :: Ptr Word32 -> Int -> Word32 -> IO () # peekByteOff :: Ptr b -> Int -> IO Word32 # pokeByteOff :: Ptr b -> Int -> Word32 -> IO () # peek :: Ptr Word32 -> IO Word32 # poke :: Ptr Word32 -> Word32 -> IO () #
Storable Word64 | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Word64 -> Int # alignment :: Word64 -> Int # peekElemOff :: Ptr Word64 -> Int -> IO Word64 # pokeElemOff :: Ptr Word64 -> Int -> Word64 -> IO () # peekByteOff :: Ptr b -> Int -> IO Word64 # pokeByteOff :: Ptr b -> Int -> Word64 -> IO () # peek :: Ptr Word64 -> IO Word64 # poke :: Ptr Word64 -> Word64 -> IO () #
Storable Word8 | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Word8 -> Int # alignment :: Word8 -> Int # peekElemOff :: Ptr Word8 -> Int -> IO Word8 # pokeElemOff :: Ptr Word8 -> Int -> Word8 -> IO () # peekByteOff :: Ptr b -> Int -> IO Word8 # pokeByteOff :: Ptr b -> Int -> Word8 -> IO () # peek :: Ptr Word8 -> IO Word8 # poke :: Ptr Word8 -> Word8 -> IO () #
Storable () | @since base-4.9.0.0
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: () -> Int # alignment :: () -> Int # peekElemOff :: Ptr () -> Int -> IO () # pokeElemOff :: Ptr () -> Int -> () -> IO () # peekByteOff :: Ptr b -> Int -> IO () # pokeByteOff :: Ptr b -> Int -> () -> IO () # peek :: Ptr () -> IO () # poke :: Ptr () -> () -> IO () #
Storable Bool | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Bool -> Int # alignment :: Bool -> Int # peekElemOff :: Ptr Bool -> Int -> IO Bool # pokeElemOff :: Ptr Bool -> Int -> Bool -> IO () # peekByteOff :: Ptr b -> Int -> IO Bool # pokeByteOff :: Ptr b -> Int -> Bool -> IO () # peek :: Ptr Bool -> IO Bool # poke :: Ptr Bool -> Bool -> IO () #
Storable Char | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Char -> Int # alignment :: Char -> Int # peekElemOff :: Ptr Char -> Int -> IO Char # pokeElemOff :: Ptr Char -> Int -> Char -> IO () # peekByteOff :: Ptr b -> Int -> IO Char # pokeByteOff :: Ptr b -> Int -> Char -> IO () # peek :: Ptr Char -> IO Char # poke :: Ptr Char -> Char -> IO () #
Storable Double | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Double -> Int # alignment :: Double -> Int # peekElemOff :: Ptr Double -> Int -> IO Double # pokeElemOff :: Ptr Double -> Int -> Double -> IO () # peekByteOff :: Ptr b -> Int -> IO Double # pokeByteOff :: Ptr b -> Int -> Double -> IO () # peek :: Ptr Double -> IO Double # poke :: Ptr Double -> Double -> IO () #
Storable Float | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Float -> Int # alignment :: Float -> Int # peekElemOff :: Ptr Float -> Int -> IO Float # pokeElemOff :: Ptr Float -> Int -> Float -> IO () # peekByteOff :: Ptr b -> Int -> IO Float # pokeByteOff :: Ptr b -> Int -> Float -> IO () # peek :: Ptr Float -> IO Float # poke :: Ptr Float -> Float -> IO () #
Storable Int | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Int -> Int # alignment :: Int -> Int # peekElemOff :: Ptr Int -> Int -> IO Int # pokeElemOff :: Ptr Int -> Int -> Int -> IO () # peekByteOff :: Ptr b -> Int -> IO Int # pokeByteOff :: Ptr b -> Int -> Int -> IO () # peek :: Ptr Int -> IO Int # poke :: Ptr Int -> Int -> IO () #
Storable Word | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Word -> Int # alignment :: Word -> Int # peekElemOff :: Ptr Word -> Int -> IO Word # pokeElemOff :: Ptr Word -> Int -> Word -> IO () # peekByteOff :: Ptr b -> Int -> IO Word # pokeByteOff :: Ptr b -> Int -> Word -> IO () # peek :: Ptr Word -> IO Word # poke :: Ptr Word -> Word -> IO () #
Storable a => Storable (Complex a) | Since: base-4.8.0.0
Instance details Defined in Data.Complex Methods sizeOf :: Complex a -> Int # alignment :: Complex a -> Int # peekElemOff :: Ptr (Complex a) -> Int -> IO (Complex a) # pokeElemOff :: Ptr (Complex a) -> Int -> Complex a -> IO () # peekByteOff :: Ptr b -> Int -> IO (Complex a) # pokeByteOff :: Ptr b -> Int -> Complex a -> IO () # peek :: Ptr (Complex a) -> IO (Complex a) # poke :: Ptr (Complex a) -> Complex a -> IO () #
Storable a => Storable (Identity a) | @since base-4.9.0.0
Instance details Defined in GHC.Internal.Data.Functor.Identity Methods sizeOf :: Identity a -> Int # alignment :: Identity a -> Int # peekElemOff :: Ptr (Identity a) -> Int -> IO (Identity a) # pokeElemOff :: Ptr (Identity a) -> Int -> Identity a -> IO () # peekByteOff :: Ptr b -> Int -> IO (Identity a) # pokeByteOff :: Ptr b -> Int -> Identity a -> IO () # peek :: Ptr (Identity a) -> IO (Identity a) # poke :: Ptr (Identity a) -> Identity a -> IO () #
Storable a => Storable (Down a) | @since base-4.14.0.0
Instance details Defined in GHC.Internal.Data.Ord Methods sizeOf :: Down a -> Int # alignment :: Down a -> Int # peekElemOff :: Ptr (Down a) -> Int -> IO (Down a) # pokeElemOff :: Ptr (Down a) -> Int -> Down a -> IO () # peekByteOff :: Ptr b -> Int -> IO (Down a) # pokeByteOff :: Ptr b -> Int -> Down a -> IO () # peek :: Ptr (Down a) -> IO (Down a) # poke :: Ptr (Down a) -> Down a -> IO () #
Storable (ConstPtr a) |
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: ConstPtr a -> Int # alignment :: ConstPtr a -> Int # peekElemOff :: Ptr (ConstPtr a) -> Int -> IO (ConstPtr a) # pokeElemOff :: Ptr (ConstPtr a) -> Int -> ConstPtr a -> IO () # peekByteOff :: Ptr b -> Int -> IO (ConstPtr a) # pokeByteOff :: Ptr b -> Int -> ConstPtr a -> IO () # peek :: Ptr (ConstPtr a) -> IO (ConstPtr a) # poke :: Ptr (ConstPtr a) -> ConstPtr a -> IO () #
Storable (FunPtr a) | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: FunPtr a -> Int # alignment :: FunPtr a -> Int # peekElemOff :: Ptr (FunPtr a) -> Int -> IO (FunPtr a) # pokeElemOff :: Ptr (FunPtr a) -> Int -> FunPtr a -> IO () # peekByteOff :: Ptr b -> Int -> IO (FunPtr a) # pokeByteOff :: Ptr b -> Int -> FunPtr a -> IO () # peek :: Ptr (FunPtr a) -> IO (FunPtr a) # poke :: Ptr (FunPtr a) -> FunPtr a -> IO () #
Storable (Ptr a) | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Ptr a -> Int # alignment :: Ptr a -> Int # peekElemOff :: Ptr (Ptr a) -> Int -> IO (Ptr a) # pokeElemOff :: Ptr (Ptr a) -> Int -> Ptr a -> IO () # peekByteOff :: Ptr b -> Int -> IO (Ptr a) # pokeByteOff :: Ptr b -> Int -> Ptr a -> IO () # peek :: Ptr (Ptr a) -> IO (Ptr a) # poke :: Ptr (Ptr a) -> Ptr a -> IO () #
(Storable a, Integral a) => Storable (Ratio a) | @since base-4.8.0.0
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: Ratio a -> Int # alignment :: Ratio a -> Int # peekElemOff :: Ptr (Ratio a) -> Int -> IO (Ratio a) # pokeElemOff :: Ptr (Ratio a) -> Int -> Ratio a -> IO () # peekByteOff :: Ptr b -> Int -> IO (Ratio a) # pokeByteOff :: Ptr b -> Int -> Ratio a -> IO () # peek :: Ptr (Ratio a) -> IO (Ratio a) # poke :: Ptr (Ratio a) -> Ratio a -> IO () #
Storable (StablePtr a) | @since base-2.01
Instance details Defined in GHC.Internal.Foreign.Storable Methods sizeOf :: StablePtr a -> Int # alignment :: StablePtr a -> Int # peekElemOff :: Ptr (StablePtr a) -> Int -> IO (StablePtr a) # pokeElemOff :: Ptr (StablePtr a) -> Int -> StablePtr a -> IO () # peekByteOff :: Ptr b -> Int -> IO (StablePtr a) # pokeByteOff :: Ptr b -> Int -> StablePtr a -> IO () # peek :: Ptr (StablePtr a) -> IO (StablePtr a) # poke :: Ptr (StablePtr a) -> StablePtr a -> IO () #
Prim a => Storable (PrimStorable a) |
Instance details Defined in Data.Primitive.Types Methods sizeOf :: PrimStorable a -> Int # alignment :: PrimStorable a -> Int # peekElemOff :: Ptr (PrimStorable a) -> Int -> IO (PrimStorable a) # pokeElemOff :: Ptr (PrimStorable a) -> Int -> PrimStorable a -> IO () # peekByteOff :: Ptr b -> Int -> IO (PrimStorable a) # pokeByteOff :: Ptr b -> Int -> PrimStorable a -> IO () # peek :: Ptr (PrimStorable a) -> IO (PrimStorable a) # poke :: Ptr (PrimStorable a) -> PrimStorable a -> IO () #
Storable a => Storable (Const a b) | @since base-4.9.0.0
Instance details Defined in GHC.Internal.Data.Functor.Const Methods sizeOf :: Const a b -> Int # alignment :: Const a b -> Int # peekElemOff :: Ptr (Const a b) -> Int -> IO (Const a b) # pokeElemOff :: Ptr (Const a b) -> Int -> Const a b -> IO () # peekByteOff :: Ptr b0 -> Int -> IO (Const a b) # pokeByteOff :: Ptr b0 -> Int -> Const a b -> IO () # peek :: Ptr (Const a b) -> IO (Const a b) # poke :: Ptr (Const a b) -> Const a b -> IO () #