# LANGUAGE CPP #
{-# LANGUAGE DeriveDataTypeable #-}
# LANGUAGE FlexibleInstances #
# LANGUAGE MultiParamTypeClasses #
{-# LANGUAGE RankNTypes #-}
# LANGUAGE RoleAnnotations #
# LANGUAGE ScopedTypeVariables #
# LANGUAGE TypeFamilies #
-- |
-- Module      : Data.Vector.Storable
  Copyright    : ( c ) Roman Leshchinskiy 2009 - 2010
                      2020 - 2022
                      2020 - 2022
                      2020 - 2022
-- License     : BSD-style
--
  Maintainer   : Haskell Libraries Team <  >
-- Stability   : experimental
-- Portability : non-portable
--
-- 'Storable'-based vectors.

module Data.Vector.Storable (
  -- * Storable vectors
  Vector, MVector(..),

  -- * Accessors

  -- ** Length information
  length, null,

  -- ** Indexing
  (!), (!?), head, last,
  unsafeIndex, unsafeHead, unsafeLast,

  -- ** Monadic indexing
  indexM, headM, lastM,
  unsafeIndexM, unsafeHeadM, unsafeLastM,

  -- ** Extracting subvectors (slicing)
  slice, init, tail, take, drop, splitAt, uncons, unsnoc,
  unsafeSlice, unsafeInit, unsafeTail, unsafeTake, unsafeDrop,

  -- * Construction

  -- ** Initialisation
  empty, singleton, replicate, generate, iterateN,

  * *  initialisation
  replicateM, generateM, iterateNM, create, createT,

  -- ** Unfolding
  unfoldr, unfoldrN, unfoldrExactN,
  unfoldrM, unfoldrNM, unfoldrExactNM,
  constructN, constructrN,

  -- ** Enumeration
  enumFromN, enumFromStepN, enumFromTo, enumFromThenTo,

  -- ** Concatenation
  cons, snoc, (++), concat,

  -- ** Restricting memory usage
  force,

  -- * Modifying vectors

  -- ** Bulk updates
  (//), update_,
  unsafeUpd, unsafeUpdate_,

  -- ** Accumulations
  accum, accumulate_,
  unsafeAccum, unsafeAccumulate_,

  -- ** Permutations
  reverse, backpermute, unsafeBackpermute,

  -- ** Safe destructive updates
  modify,

  *  operations

  -- ** Mapping
  map, imap, concatMap,

  * *  mapping
  mapM, imapM, mapM_, imapM_, forM, forM_,
  iforM, iforM_,

  -- ** Zipping
  zipWith, zipWith3, zipWith4, zipWith5, zipWith6,
  izipWith, izipWith3, izipWith4, izipWith5, izipWith6,

  * *  zipping
  zipWithM, izipWithM, zipWithM_, izipWithM_,

  -- * Working with predicates

  -- ** Filtering
  filter, ifilter, filterM, uniq,
  mapMaybe, imapMaybe,
  mapMaybeM, imapMaybeM,
  takeWhile, dropWhile,

  -- ** Partitioning
  partition, unstablePartition, partitionWith, span, break, groupBy, group,

  -- ** Searching
  elem, notElem, find, findIndex, findIndices, elemIndex, elemIndices,

  -- * Folding
  foldl, foldl1, foldl', foldl1', foldr, foldr1, foldr', foldr1',
  ifoldl, ifoldl', ifoldr, ifoldr',
  foldMap, foldMap',

  -- ** Specialised folds
  all, any, and, or,
  sum, product,
  maximum, maximumBy, maximumOn,
  minimum, minimumBy, minimumOn,
  minIndex, minIndexBy, maxIndex, maxIndexBy,

  * *  folds
  foldM, ifoldM, foldM', ifoldM',
  fold1M, fold1M', foldM_, ifoldM_,
  foldM'_, ifoldM'_, fold1M_, fold1M'_,

  -- * Scans
  prescanl, prescanl',
  postscanl, postscanl',
  scanl, scanl', scanl1, scanl1',
  iscanl, iscanl',
  prescanr, prescanr',
  postscanr, postscanr',
  scanr, scanr', scanr1, scanr1',
  iscanr, iscanr',

  -- ** Comparisons
  eqBy, cmpBy,

  -- * Utilities
  -- ** Comparisons
  isSameVector,

  -- * Conversions

  -- ** Lists
  toList, fromList, fromListN,

  -- ** Other vector types
  G.convert, unsafeCast,
  unsafeCoerceVector,

  -- ** Mutable vectors
  freeze, thaw, copy, unsafeFreeze, unsafeThaw, unsafeCopy,

  -- * Raw pointers
  unsafeFromForeignPtr, unsafeFromForeignPtr0,
  unsafeToForeignPtr,   unsafeToForeignPtr0,
  unsafeWith,

  -- * Re-exports
  Storable
) where

import qualified Data.Vector.Generic          as G
import           Data.Vector.Storable.Mutable ( MVector(..) )
import Data.Vector.Storable.Internal
import qualified Data.Vector.Fusion.Bundle as Bundle

import Foreign.Storable
import Foreign.ForeignPtr
import Foreign.Ptr
import Foreign.Marshal.Array ( advancePtr, copyArray )

import Control.DeepSeq ( NFData(rnf)
#if MIN_VERSION_deepseq(1,4,3)
                       , NFData1(liftRnf)
#endif
                       )

import Control.Monad.ST ( ST )
import Control.Monad.Primitive

import Prelude hiding ( length, null,
                        replicate, (++), concat,
                        head, last,
                        init, tail, take, drop, splitAt, reverse,
                        map, concatMap,
                        zipWith, zipWith3, zip, zip3, unzip, unzip3,
                        filter, takeWhile, dropWhile, span, break,
                        elem, notElem,
                        foldl, foldl1, foldr, foldr1, foldMap,
                        all, any, and, or, sum, product, minimum, maximum,
                        scanl, scanl1, scanr, scanr1,
                        enumFromTo, enumFromThenTo,
                        mapM, mapM_ )

import Data.Typeable  ( Typeable )
import Data.Data      ( Data(..) )
import Text.Read      ( Read(..), readListPrecDefault )
import Data.Semigroup ( Semigroup(..) )
import Data.Coerce
import qualified GHC.Exts as Exts
import Unsafe.Coerce

-- Data.Vector.Internal.Check is unused
#define NOT_VECTOR_MODULE
#include "vector.h"

type role Vector nominal

  | /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 can not guarantee that the two types have memory - compatible
-- 'Storable' instances.
unsafeCoerceVector :: Coercible a b => Vector a -> Vector b
unsafeCoerceVector = unsafeCoerce

-- | 'Storable'-based vectors.
data Vector a = Vector {-# UNPACK #-} !Int
                       {-# UNPACK #-} !(ForeignPtr a)
        deriving ( Typeable )

instance NFData (Vector a) where
  rnf (Vector _ _) = ()

#if MIN_VERSION_deepseq(1,4,3)
-- | @since 0.12.1.0
instance NFData1 Vector where
  liftRnf _ (Vector _ _) = ()
#endif

instance (Show a, Storable a) => Show (Vector a) where
  showsPrec = G.showsPrec

instance (Read a, Storable a) => Read (Vector a) where
  readPrec = G.readPrec
  readListPrec = readListPrecDefault

instance (Data a, Storable a) => Data (Vector a) where
  gfoldl       = G.gfoldl
  toConstr _   = G.mkVecConstr "Data.Vector.Storable.Vector"
  gunfold      = G.gunfold
  dataTypeOf _ = G.mkVecType "Data.Vector.Storable.Vector"
  dataCast1    = G.dataCast


type instance G.Mutable Vector = MVector

instance Storable a => G.Vector Vector a where
# INLINE basicUnsafeFreeze #
  basicUnsafeFreeze (MVector n fp) = return $ Vector n fp

# INLINE basicUnsafeThaw #
  basicUnsafeThaw (Vector n fp) = return $ MVector n fp

# INLINE basicLength #
  basicLength (Vector n _) = n

# INLINE basicUnsafeSlice #
  basicUnsafeSlice i n (Vector _ fp) = Vector n (updPtr (`advancePtr` i) fp)

# INLINE basicUnsafeIndexM #
  basicUnsafeIndexM (Vector _ fp) i = return
                                    . unsafeInlineIO
                                    $ unsafeWithForeignPtr fp $ \p ->
                                      peekElemOff p i

# INLINE basicUnsafeCopy #
  basicUnsafeCopy (MVector n fp) (Vector _ fq)
    = unsafePrimToPrim
    $ unsafeWithForeignPtr fp $ \p ->
      unsafeWithForeignPtr fq $ \q ->
      copyArray p q n

# INLINE elemseq #
  elemseq _ = seq

-- See 
instance (Storable a, Eq a) => Eq (Vector a) where
# INLINE (= =) #
  xs == ys = Bundle.eq (G.stream xs) (G.stream ys)

-- See 
instance (Storable a, Ord a) => Ord (Vector a) where
# INLINE compare #
  compare xs ys = Bundle.cmp (G.stream xs) (G.stream ys)

  {-# INLINE (<) #-}
  xs < ys = Bundle.cmp (G.stream xs) (G.stream ys) == LT

  {-# INLINE (<=) #-}
  xs <= ys = Bundle.cmp (G.stream xs) (G.stream ys) /= GT

  {-# INLINE (>) #-}
  xs > ys = Bundle.cmp (G.stream xs) (G.stream ys) == GT

  {-# INLINE (>=) #-}
  xs >= ys = Bundle.cmp (G.stream xs) (G.stream ys) /= LT

instance Storable a => Semigroup (Vector a) where
  {-# INLINE (<>) #-}
  (<>) = (++)

# INLINE sconcat #
  sconcat = G.concatNE

instance Storable a => Monoid (Vector a) where
# INLINE mempty #
  mempty = empty

# INLINE mappend #
  mappend = (<>)

# INLINE mconcat #
  mconcat = concat

instance Storable a => Exts.IsList (Vector a) where
  type Item (Vector a) = a
  fromList = fromList
  fromListN = fromListN
  toList = toList

-- Length
-- ------

-- | /O(1)/ Yield the length of the vector.
length :: Storable a => Vector a -> Int
# INLINE length #
length = G.length

-- | /O(1)/ Test whether a vector is empty.
null :: Storable a => Vector a -> Bool
# INLINE null #
null = G.null

-- Indexing
-- --------

-- | O(1) Indexing.
(!) :: Storable a => Vector a -> Int -> a
{-# INLINE (!) #-}
(!) = (G.!)

-- | O(1) Safe indexing.
(!?) :: Storable a => Vector a -> Int -> Maybe a
{-# INLINE (!?) #-}
(!?) = (G.!?)

  | /O(1)/ First element .
head :: Storable a => Vector a -> a
# INLINE head #
head = G.head

-- | /O(1)/ Last element.
last :: Storable a => Vector a -> a
# INLINE last #
last = G.last

-- | /O(1)/ Unsafe indexing without bounds checking.
unsafeIndex :: Storable a => Vector a -> Int -> a
# INLINE unsafeIndex #
unsafeIndex = G.unsafeIndex

  | /O(1)/ First element , without checking if the vector is empty .
unsafeHead :: Storable a => Vector a -> a
# INLINE unsafeHead #
unsafeHead = G.unsafeHead

-- | /O(1)/ Last element, without checking if the vector is empty.
unsafeLast :: Storable a => Vector a -> a
# INLINE unsafeLast #
unsafeLast = G.unsafeLast

  Monadic indexing
-- ----------------

-- | /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.
indexM :: (Storable a, Monad m) => Vector a -> Int -> m a
{-# INLINE indexM #-}
indexM = G.indexM

  | /O(1)/ First element of a vector in a monad . See ' indexM ' for an
-- explanation of why this is useful.
headM :: (Storable a, Monad m) => Vector a -> m a
# INLINE headM #
headM = G.headM

-- | /O(1)/ Last 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
# INLINE lastM #
lastM = G.lastM

-- | /O(1)/ Indexing in a monad, without bounds checks. See 'indexM' for an
-- explanation of why this is useful.
unsafeIndexM :: (Storable a, Monad m) => Vector a -> Int -> m a
# INLINE unsafeIndexM #
unsafeIndexM = G.unsafeIndexM

  | /O(1)/ First element in a monad , without checking for empty vectors .
-- See 'indexM' for an explanation of why this is useful.
unsafeHeadM :: (Storable a, Monad m) => Vector a -> m a
# INLINE unsafeHeadM #
unsafeHeadM = G.unsafeHeadM

-- | /O(1)/ Last 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
# INLINE unsafeLastM #
unsafeLastM = G.unsafeLastM

-- Extracting subvectors (slicing)
-- -------------------------------

-- | /O(1)/ Yield a slice of the vector without copying it. The vector must
-- contain at least @i+n@ elements.
slice :: Storable a
  ^ @i@ starting index
      -> Int   -- ^ @n@ length
      -> Vector a
      -> Vector a
# INLINE slice #
slice = G.slice

-- | /O(1)/ Yield all but the last element without copying. The vector may not
-- be empty.
init :: Storable a => Vector a -> Vector a
# INLINE init #
init = G.init

  | /O(1)/ Yield all but the first element without copying . The vector may not
-- be empty.
tail :: Storable a => Vector a -> Vector a
# INLINE tail #
tail = G.tail

  | /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 .
take :: Storable a => Int -> Vector a -> Vector a
{-# INLINE take #-}
take = G.take

  | /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 .
drop :: Storable a => Int -> Vector a -> Vector a
{-# INLINE drop #-}
drop = G.drop

  | /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
splitAt :: Storable a => Int -> Vector a -> (Vector a, Vector a)
# INLINE splitAt #
splitAt = G.splitAt

-- | /O(1)/ Yield the 'head' and 'tail' of the vector, or 'Nothing' if
-- the vector is empty.
--
-- @since 0.12.2.0
uncons :: Storable a => Vector a -> Maybe (a, Vector a)
# INLINE uncons #
uncons = G.uncons

-- | /O(1)/ Yield the 'last' and 'init' of the vector, or 'Nothing' if
-- the vector is empty.
--
-- @since 0.12.2.0
unsnoc :: Storable a => Vector a -> Maybe (Vector a, a)
# INLINE unsnoc #
unsnoc = G.unsnoc

-- | /O(1)/ Yield a slice of the vector without copying. The vector must
-- contain at least @i+n@ elements, but this is not checked.
  ^ @i@ starting index
                       -> Int   -- ^ @n@ length
                       -> Vector a
                       -> Vector a
# INLINE unsafeSlice #
unsafeSlice = G.unsafeSlice

-- | /O(1)/ Yield all but the last element without copying. The vector may not
-- be empty, but this is not checked.
unsafeInit :: Storable a => Vector a -> Vector a
{-# INLINE unsafeInit #-}
unsafeInit = G.unsafeInit

  | /O(1)/ Yield all but the first element without copying . The vector may not
-- be empty, but this is not checked.
unsafeTail :: Storable a => Vector a -> Vector a
# INLINE unsafeTail #
unsafeTail = G.unsafeTail

  | /O(1)/ Yield the first @n@ elements without copying . The vector must
-- contain at least @n@ elements, but this is not checked.
unsafeTake :: Storable a => Int -> Vector a -> Vector a
# INLINE unsafeTake #
unsafeTake = G.unsafeTake

  | /O(1)/ Yield all but 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
# INLINE unsafeDrop #
unsafeDrop = G.unsafeDrop

-- Initialisation
-- --------------

-- | /O(1)/ The empty vector.
empty :: Storable a => Vector a
{-# INLINE empty #-}
empty = G.empty

  | /O(1)/ A vector with exactly one element .
singleton :: Storable a => a -> Vector a
# INLINE singleton #
singleton = G.singleton

-- | /O(n)/ A vector of the given length with the same value in each position.
replicate :: Storable a => Int -> a -> Vector a
# INLINE replicate #
replicate = G.replicate

  | /O(n)/ Construct a vector of the given length by applying the function to
-- each index.
generate :: Storable a => Int -> (Int -> a) -> Vector a
# INLINE generate #
generate = G.generate

  | /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__
--
  > > > 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
iterateN :: Storable a => Int -> (a -> a) -> a -> Vector a
# INLINE iterateN #
iterateN = G.iterateN

-- Unfolding
-- ---------

  | /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>
unfoldr :: Storable a => (b -> Maybe (a, b)) -> b -> Vector a
# INLINE unfoldr #
unfoldr = G.unfoldr

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

  | /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
unfoldrExactN :: (Storable a) => Int -> (b -> (a, b)) -> b -> Vector a
# INLINE unfoldrExactN #
unfoldrExactN = G.unfoldrExactN

  | /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.
unfoldrM :: (Monad m, Storable a) => (b -> m (Maybe (a, b))) -> b -> m (Vector a)
# INLINE unfoldrM #
unfoldrM = G.unfoldrM

  | /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)
# INLINE unfoldrNM #
unfoldrNM = G.unfoldrNM

  | /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
unfoldrExactNM :: (Monad m, Storable a) => Int -> (b -> m (a, b)) -> b -> m (Vector a)
# INLINE unfoldrExactNM #
unfoldrExactNM = G.unfoldrExactNM

  | /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 >
constructN :: Storable a => Int -> (Vector a -> a) -> Vector a
# INLINE constructN #
constructN = G.constructN

  | /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>
constructrN :: Storable a => Int -> (Vector a -> a) -> Vector a
# INLINE constructrN #
constructrN = G.constructrN

-- Enumeration
-- -----------

-- | /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 >
enumFromN :: (Storable a, Num a) => a -> Int -> Vector a
# INLINE enumFromN #
enumFromN = G.enumFromN

-- | /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 >
enumFromStepN :: (Storable a, Num a) => a -> a -> Int -> Vector a
# INLINE enumFromStepN #
enumFromStepN = G.enumFromStepN

  | /O(n)/ Enumerate values from @x@ to @y@.
--
  /WARNING:/ This operation can be very inefficient . If possible , use
-- 'enumFromN' instead.
enumFromTo :: (Storable a, Enum a) => a -> a -> Vector a
# INLINE enumFromTo #
enumFromTo = G.enumFromTo

  | /O(n)/ Enumerate values from @x@ to @y@ with a specific step 
--
  /WARNING:/ This operation can be very inefficient . If possible , use
  ' enumFromStepN ' instead .
enumFromThenTo :: (Storable a, Enum a) => a -> a -> a -> Vector a
{-# INLINE enumFromThenTo #-}
enumFromThenTo = G.enumFromThenTo

-- Concatenation
-- -------------

-- | /O(n)/ Prepend an element.
cons :: Storable a => a -> Vector a -> Vector a
# INLINE cons #
cons = G.cons

-- | /O(n)/ Append an element.
snoc :: Storable a => Vector a -> a -> Vector a
# INLINE snoc #
snoc = G.snoc

infixr 5 ++
  | /O(m+n)/ Concatenate two vectors .
(++) :: Storable a => Vector a -> Vector a -> Vector a
# INLINE ( + + ) #
(++) = (G.++)

  | /O(n)/  all vectors in the list .
concat :: Storable a => [Vector a] -> Vector a
# INLINE concat #
concat = G.concat

  Monadic initialisation
-- ----------------------

-- | /O(n)/ Execute the monadic action the given number of times and store the
-- results in a vector.
replicateM :: (Monad m, Storable a) => Int -> m a -> m (Vector a)
# INLINE replicateM #
replicateM = G.replicateM

  | /O(n)/ Construct a vector of the given length by applying the monadic
-- action to each index.
generateM :: (Monad m, Storable a) => Int -> (Int -> m a) -> m (Vector a)
# INLINE generateM #
generateM = G.generateM

  | /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
iterateNM :: (Monad m, Storable a) => Int -> (a -> m a) -> a -> m (Vector a)
# INLINE iterateNM #
iterateNM = G.iterateNM

-- | 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'\ >
-- @
create :: Storable a => (forall s. ST s (MVector s a)) -> Vector a
# INLINE create #
-- NOTE: eta-expanded due to 
create p = G.create p

-- | Execute the monadic action and freeze the resulting vectors.
createT :: (Traversable f, Storable a) => (forall s. ST s (f (MVector s a))) -> f (Vector a)
# INLINE createT #
createT p = G.createT p

-- Restricting memory usage
-- ------------------------

-- | /O(n)/ Yield the argument, but force it not to retain any extra memory,
-- possibly by copying it.
--
-- This is especially useful when dealing with slices. For example:
--
  > force ( slice 0 2 < huge vector > )
--
-- Here, the slice retains a reference to the huge vector. Forcing it creates
-- a copy of just the elements that belong to the slice and allows the huge
-- vector to be garbage collected.
force :: Storable a => Vector a -> Vector a
# INLINE force #
force = G.force

-- Bulk updates
-- ------------

-- | /O(m+n)/ For each pair @(i,a)@ from the list of index/value pairs,
  replace the vector element at position @i@ by 
--
  > < 5,9,2,7 > // [ ( 2,1),(0,3),(2,8 ) ] = < 3,9,8,7 >
--
(//) :: Storable a => Vector a   -- ^ initial vector (of length @m@)
                -> [(Int, a)] -- ^ list of index/value pairs (of length @n@)
                -> Vector a
{-# INLINE (//) #-}
(//) = (G.//)

  | /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 
--
  > update _ < 5,9,2,7 >   < 2,0,2 > < 1,3,8 > = < 3,9,8,7 >
--
update_ :: 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
{-# INLINE update_ #-}
update_ = G.update_

-- | Same as ('//'), but without bounds checking.
unsafeUpd :: Storable a => Vector a -> [(Int, a)] -> Vector a
# INLINE unsafeUpd #
unsafeUpd = G.unsafeUpd

-- | Same as 'update_', but without bounds checking.
unsafeUpdate_ :: Storable a => Vector a -> Vector Int -> Vector a -> Vector a
{-# INLINE unsafeUpdate_ #-}
unsafeUpdate_ = G.unsafeUpdate_

-- Accumulations
-- -------------

-- | /O(m+n)/ For each pair @(i,b)@ from the list, replace the vector element
  @a@ at position @i@ by @f a b@.
--
-- ==== __Examples__
--
  > > > 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 ]
accum :: Storable a
  ^ accumulating function @f@
      -> Vector a      -- ^ initial vector (of length @m@)
      -> [(Int,b)]     -- ^ list of index/value pairs (of length @n@)
      -> Vector a
# INLINE accum #
accum = G.accum

  | /O(m+min(n1,n2))/ For each index @i@ from the index vector and the
  corresponding value @b@ from the the value vector ,
-- replace the element of the initial vector at
  position @i@ by @f a b@.
--
  > accumulate _ ( + ) < 5,9,2 > < 2,1,0,1 > < 4,6,3,7 > = < 5 + 3 , 9 + 6 + 7 , 2 + 4 >
--
accumulate_ :: (Storable a, Storable b)
  ^ 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
{-# INLINE accumulate_ #-}
accumulate_ = G.accumulate_

-- | Same as 'accum', but without bounds checking.
unsafeAccum :: Storable a => (a -> b -> a) -> Vector a -> [(Int,b)] -> Vector a
# INLINE unsafeAccum #
unsafeAccum = G.unsafeAccum

-- | Same as 'accumulate_', but without bounds checking.
unsafeAccumulate_ :: (Storable a, Storable b) =>
               (a -> b -> a) -> Vector a -> Vector Int -> Vector b -> Vector a
{-# INLINE unsafeAccumulate_ #-}
unsafeAccumulate_ = G.unsafeAccumulate_

-- Permutations
-- ------------

-- | /O(n)/ Reverse a vector.
reverse :: Storable a => Vector a -> Vector a
# INLINE reverse #
reverse = G.reverse

  | /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 >
backpermute :: Storable a => Vector a -> Vector Int -> Vector a
# INLINE backpermute #
backpermute = G.backpermute

-- | Same as 'backpermute', but without bounds checking.
unsafeBackpermute :: Storable a => Vector a -> Vector Int -> Vector a
{-# INLINE unsafeBackpermute #-}
unsafeBackpermute = G.unsafeBackpermute

-- Safe destructive updates
-- ------------------------

-- | Apply a destructive operation to a vector. The operation will be
-- performed in place if it is safe to do so and will modify a copy of the
-- vector otherwise.
--
-- @
  modify ( \\v - > write v 0 \'x\ ' ) ( ' replicate ' 3 \'a\ ' ) = \<\'x\',\'a\',\'a\'\ >
-- @
modify :: Storable a => (forall s. MVector s a -> ST s ()) -> Vector a -> Vector a
# INLINE modify #
modify p = G.modify p

-- Mapping
-- -------

-- | /O(n)/ Map a function over a vector.
map :: (Storable a, Storable b) => (a -> b) -> Vector a -> Vector b
# INLINE map #
map = G.map

-- | /O(n)/ Apply a function to every element of a vector and its index.
imap :: (Storable a, Storable b) => (Int -> a -> b) -> Vector a -> Vector b
# INLINE imap #
imap = G.imap

-- | Map a function over a vector and concatenate the results.
concatMap :: (Storable a, Storable b) => (a -> Vector b) -> Vector a -> Vector b
# INLINE concatMap #
concatMap = G.concatMap

  Monadic mapping
-- ---------------

-- | /O(n)/ Apply the monadic action to all elements of the vector, yielding a
-- vector of results.
mapM :: (Monad m, Storable a, Storable b) => (a -> m b) -> Vector a -> m (Vector b)
# INLINE mapM #
mapM = G.mapM

-- | /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
imapM :: (Monad m, Storable a, Storable b)
      => (Int -> a -> m b) -> Vector a -> m (Vector b)
# INLINE imapM #
imapM = G.imapM

-- | /O(n)/ Apply the monadic action to all elements of a vector and ignore the
-- results.
mapM_ :: (Monad m, Storable a) => (a -> m b) -> Vector a -> m ()
{-# INLINE mapM_ #-}
mapM_ = G.mapM_

-- | /O(n)/ Apply the monadic action to every element of a vector and its
-- index, ignoring the results.
--
-- @since 0.12.2.0
imapM_ :: (Monad m, Storable a) => (Int -> a -> m b) -> Vector a -> m ()
{-# INLINE imapM_ #-}
imapM_ = G.imapM_

-- | /O(n)/ Apply the monadic action to all elements of the vector, yielding a
  vector of results . Equivalent to  ' mapM'@.
forM :: (Monad m, Storable a, Storable b) => Vector a -> (a -> m b) -> m (Vector b)
# INLINE forM #
forM = G.forM

-- | /O(n)/ Apply the monadic action to all elements of a vector and ignore the
  results . Equivalent to  ' mapM_'@.
forM_ :: (Monad m, Storable a) => Vector a -> (a -> m b) -> m ()
{-# INLINE forM_ #-}
forM_ = G.forM_

-- | /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, Storable b) => Vector a -> (Int -> a -> m b) -> m (Vector b)
# INLINE iforM #
iforM = G.iforM

-- | /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
iforM_ :: (Monad m, Storable a) => Vector a -> (Int -> a -> m b) -> m ()
{-# INLINE iforM_ #-}
iforM_ = G.iforM_

-- Zipping
-- -------

  | /O(min(m , n))/ Zip two vectors with the given function .
zipWith :: (Storable a, Storable b, Storable c)
        => (a -> b -> c) -> Vector a -> Vector b -> Vector c
# INLINE zipWith #
zipWith = G.zipWith

  | Zip three 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
# INLINE zipWith3 #
zipWith3 = G.zipWith3

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
# INLINE zipWith4 #
zipWith4 = G.zipWith4

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
# INLINE zipWith5 #
zipWith5 = G.zipWith5

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
# INLINE zipWith6 #
zipWith6 = G.zipWith6

  | /O(min(m , n))/ Zip two vectors with a function that also takes the
-- elements' indices.
izipWith :: (Storable a, Storable b, Storable c)
         => (Int -> a -> b -> c) -> Vector a -> Vector b -> Vector c
{-# INLINE izipWith #-}
izipWith = G.izipWith

  | Zip three vectors and their indices with the given function .
izipWith3 :: (Storable a, Storable b, Storable c, Storable d)
          => (Int -> a -> b -> c -> d)
          -> Vector a -> Vector b -> Vector c -> Vector d
# INLINE izipWith3 #
izipWith3 = G.izipWith3

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
# INLINE izipWith4 #
izipWith4 = G.izipWith4

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
# INLINE izipWith5 #
izipWith5 = G.izipWith5

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
# INLINE izipWith6 #
izipWith6 = G.izipWith6

  | Checks whether two values are the same vector : they have same length
-- and share the same buffer.
--
  > > > let xs = fromList [ 0/0::Double ] in isSameVector xs xs
-- True
isSameVector :: (Storable a) => Vector a -> Vector a -> Bool
# INLINE isSameVector #
isSameVector (Vector n1 ptr1) (Vector n2 ptr2) = n1 == n2 && ptr1 == ptr2


  Monadic zipping
-- ---------------

  | /O(min(m , n))/ Zip the two vectors with the monadic action and yield a
-- vector of results.
zipWithM :: (Monad m, Storable a, Storable b, Storable c)
         => (a -> b -> m c) -> Vector a -> Vector b -> m (Vector c)
# INLINE zipWithM #
zipWithM = G.zipWithM

  | /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
izipWithM :: (Monad m, Storable a, Storable b, Storable c)
          => (Int -> a -> b -> m c) -> Vector a -> Vector b -> m (Vector c)
# INLINE izipWithM #
izipWithM = G.izipWithM

  | /O(min(m , n))/ Zip the two vectors with the monadic action and ignore the
-- results.
zipWithM_ :: (Monad m, Storable a, Storable b)
          => (a -> b -> m c) -> Vector a -> Vector b -> m ()
# INLINE zipWithM _ #
zipWithM_ = G.zipWithM_

  | /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
izipWithM_ :: (Monad m, Storable a, Storable b)
           => (Int -> a -> b -> m c) -> Vector a -> Vector b -> m ()
# INLINE izipWithM _ #
izipWithM_ = G.izipWithM_

-- Filtering
-- ---------

-- | /O(n)/ Drop all elements that do not satisfy the predicate.
filter :: Storable a => (a -> Bool) -> Vector a -> Vector a
# INLINE filter #
filter = G.filter

-- | /O(n)/ Drop all elements that do not satisfy the predicate which is applied to
-- the values and their indices.
ifilter :: Storable a => (Int -> a -> Bool) -> Vector a -> Vector a
# INLINE ifilter #
ifilter = G.ifilter

  | /O(n)/ Drop repeated adjacent elements . The first element in each group is returned .
--
-- ==== __Examples__
--
  > > > import qualified Data . Vector . Storable as VS
  > > > VS.uniq $ VS.fromList [ 1,3,3,200,3 : : Int ]
  [ 1,3,200,3 ]
uniq :: (Storable a, Eq a) => Vector a -> Vector a
# INLINE uniq #
uniq = G.uniq

-- | /O(n)/ Map the values and collect the 'Just' results.
mapMaybe :: (Storable a, Storable b) => (a -> Maybe b) -> Vector a -> Vector b
# INLINE mapMaybe #
mapMaybe = G.mapMaybe

-- | /O(n)/ Map the indices/values and collect the 'Just' results.
imapMaybe :: (Storable a, Storable b) => (Int -> a -> Maybe b) -> Vector a -> Vector b
# INLINE imapMaybe #
imapMaybe = G.imapMaybe

-- | /O(n)/ Drop all elements that do not satisfy the monadic predicate.
filterM :: (Monad m, Storable a) => (a -> m Bool) -> Vector a -> m (Vector a)
# INLINE filterM #
filterM = G.filterM

-- | /O(n)/ Apply the monadic function to each element of the vector and
-- discard elements returning 'Nothing'.
--
-- @since 0.12.2.0
mapMaybeM
  :: (Monad m, Storable a, Storable b)
  => (a -> m (Maybe b)) -> Vector a -> m (Vector b)
# INLINE mapMaybeM #
mapMaybeM = G.mapMaybeM

-- | /O(n)/ Apply the monadic function to each element of the vector and its index.
-- 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)
# INLINE imapMaybeM #
imapMaybeM = G.imapMaybeM

-- | /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.
takeWhile :: Storable a => (a -> Bool) -> Vector a -> Vector a
# INLINE takeWhile #
takeWhile = G.takeWhile

-- | /O(n)/ Drop the longest prefix of elements that satisfy the predicate
-- without copying.
dropWhile :: Storable a => (a -> Bool) -> Vector a -> Vector a
# INLINE dropWhile #
dropWhile = G.dropWhile

-- Parititioning
-- -------------

  | /O(n)/ Split the vector in two parts , the first one containing those
  elements that satisfy the predicate and the second one those that do n't . The
-- relative order of the elements is preserved at the cost of a sometimes
-- reduced performance compared to 'unstablePartition'.
partition :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
# INLINE partition #
partition = G.partition

  | /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
partitionWith :: (Storable a, Storable b, Storable c) => (a -> Either b c) -> Vector a -> (Vector b, Vector c)
# INLINE partitionWith #
partitionWith = G.partitionWith

  | /O(n)/ Split the vector in two parts , the first one containing those
  elements that satisfy the predicate and the second one those that do n't .
-- The order of the elements is not preserved, but the operation is often
-- faster than 'partition'.
unstablePartition :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
# INLINE unstablePartition #
unstablePartition = G.unstablePartition

-- | /O(n)/ Split the vector into the longest prefix of elements that satisfy
-- the predicate and the rest without copying.
span :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
# INLINE span #
span = G.span

-- | /O(n)/ Split the vector into the longest prefix of elements that do not
-- satisfy the predicate and the rest without copying.
break :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
# INLINE break #
break = G.break

-- | /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 .  ( isUpper )
  > > > VS.groupBy ( \a b - > isUpper a = = isUpper b ) ( VS.fromList " Mississippi River " )
  [ " M","ississippi " , " R","iver " ]
--
  See also ' Data . List.groupBy ' , ' group ' .
--
  @since 0.13.0.1
groupBy :: Storable a => (a -> a -> Bool) -> Vector a -> [Vector a]
{-# INLINE groupBy #-}
groupBy = G.groupBy

-- | /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 'Data.List.group'.
--
  @since 0.13.0.1
group :: (Storable a, Eq a) => Vector a -> [Vector a]
{-# INLINE group #-}
group = G.groupBy (==)

-- Searching
-- ---------

infix 4 `elem`
-- | /O(n)/ Check if the vector contains an element.
elem :: (Storable a, Eq a) => a -> Vector a -> Bool
# INLINE elem #
elem = G.elem

infix 4 `notElem`
-- | /O(n)/ Check if the vector does not contain an element (inverse of 'elem').
notElem :: (Storable a, Eq a) => a -> Vector a -> Bool
# INLINE notElem #
notElem = G.notElem

  | /O(n)/ Yield ' Just ' the first element matching the predicate or ' Nothing '
-- if no such element exists.
find :: Storable a => (a -> Bool) -> Vector a -> Maybe a
{-# INLINE find #-}
find = G.find

  | /O(n)/ Yield ' Just ' the index of the first element matching the predicate
-- or 'Nothing' if no such element exists.
findIndex :: Storable a => (a -> Bool) -> Vector a -> Maybe Int
# INLINE findIndex #
findIndex = G.findIndex

-- | /O(n)/ Yield the indices of elements satisfying the predicate in ascending
-- order.
findIndices :: Storable a => (a -> Bool) -> Vector a -> Vector Int
# INLINE findIndices #
findIndices = G.findIndices

  | /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'.
elemIndex :: (Storable a, Eq a) => a -> Vector a -> Maybe Int
{-# INLINE elemIndex #-}
elemIndex = G.elemIndex

-- | /O(n)/ Yield the indices of all occurrences of the given element in
-- ascending order. This is a specialised version of 'findIndices'.
elemIndices :: (Storable a, Eq a) => a -> Vector a -> Vector Int
# INLINE elemIndices #
elemIndices = G.elemIndices

-- Folding
-- -------

-- | /O(n)/ Left fold.
foldl :: Storable b => (a -> b -> a) -> a -> Vector b -> a
{-# INLINE foldl #-}
foldl = G.foldl

-- | /O(n)/ Left fold on non-empty vectors.
foldl1 :: Storable a => (a -> a -> a) -> Vector a -> a
# INLINE foldl1 #
foldl1 = G.foldl1

-- | /O(n)/ Left fold with strict accumulator.
foldl' :: Storable b => (a -> b -> a) -> a -> Vector b -> a
{-# INLINE foldl' #-}
foldl' = G.foldl'

-- | /O(n)/ Left fold on non-empty vectors with strict accumulator.
foldl1' :: Storable a => (a -> a -> a) -> Vector a -> a
{-# INLINE foldl1' #-}
foldl1' = G.foldl1'

-- | /O(n)/ Right fold.
foldr :: Storable a => (a -> b -> b) -> b -> Vector a -> b
# INLINE foldr #
foldr = G.foldr

-- | /O(n)/ Right fold on non-empty vectors.
foldr1 :: Storable a => (a -> a -> a) -> Vector a -> a
# INLINE foldr1 #
foldr1 = G.foldr1

-- | /O(n)/ Right fold with a strict accumulator.
foldr' :: Storable a => (a -> b -> b) -> b -> Vector a -> b
# INLINE foldr ' #
foldr' = G.foldr'

-- | /O(n)/ Right fold on non-empty vectors with strict accumulator.
foldr1' :: Storable a => (a -> a -> a) -> Vector a -> a
# INLINE foldr1 ' #
foldr1' = G.foldr1'

-- | /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
# INLINE ifoldl #
ifoldl = G.ifoldl

-- | /O(n)/ Left fold with strict accumulator using a function applied to each element
-- and its index.
ifoldl' :: Storable b => (a -> Int -> b -> a) -> a -> Vector b -> a
{-# INLINE ifoldl' #-}
ifoldl' = G.ifoldl'

-- | /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
# INLINE ifoldr #
ifoldr = G.ifoldr

-- | /O(n)/ Right 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
# INLINE ifoldr ' #
ifoldr' = G.ifoldr'

-- | /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
{-# INLINE foldMap #-}
foldMap = G.foldMap

-- | /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
foldMap' :: (Monoid m, Storable a) => (a -> m) -> Vector a -> m
{-# INLINE foldMap' #-}
foldMap' = G.foldMap'

  Specialised folds
-- -----------------

-- | /O(n)/ Check if all elements satisfy the predicate.
--
-- ==== __Examples__
--
  > > > import qualified Data . Vector . Storable as VS
  > > > VS.all even $ VS.fromList [ 2 , 4 , 12 : : Int ]
-- True
  > > > VS.all even $ VS.fromList [ 2 , 4 , 13 : : Int ]
-- False
  > > > VS.all even ( VS.empty : : VS.Vector Int )
-- True
all :: Storable a => (a -> Bool) -> Vector a -> Bool
# INLINE all #
all = G.all

-- | /O(n)/ Check if any element satisfies the predicate.
--
-- ==== __Examples__
--
  > > > import qualified Data . Vector . Storable as VS
  > > > VS.any even $ VS.fromList [ 1 , 3 , 7 : : Int ]
-- False
  > > > VS.any even $ VS.fromList [ 3 , 2 , 13 : : Int ]
-- True
-- >>> VS.any even (VS.empty :: VS.Vector Int)
-- False
any :: Storable a => (a -> Bool) -> Vector a -> Bool
# INLINE any #
any = G.any

-- | /O(n)/ Check if all elements are 'True'.
--
-- ==== __Examples__
--
  > > > import qualified Data . Vector . Storable as VS
  > > > VS.and $ VS.fromList [ True , False ]
-- False
-- >>> VS.and VS.empty
-- True
and :: Vector Bool -> Bool
# INLINE and #
and = G.and

-- | /O(n)/ Check if any element is 'True'.
--
-- ==== __Examples__
--
  > > > import qualified Data . Vector . Storable as VS
-- >>> VS.or $ VS.fromList [True, False]
-- True
-- >>> VS.or VS.empty
-- False
or :: Vector Bool -> Bool
# INLINE or #
or = G.or

-- | /O(n)/ Compute the sum of the elements.
--
-- ==== __Examples__
--
  > > > import qualified Data . Vector . Storable as VS
  > > > VS.sum $ VS.fromList [ 300,20,1 : : Int ]
  321
  > > > VS.sum ( VS.empty : : VS.Vector Int )
  0
sum :: (Storable a, Num a) => Vector a -> a
# INLINE sum #
sum = G.sum

-- | /O(n)/ Compute the product of the elements.
--
-- ==== __Examples__
--
  > > > import qualified Data . Vector . Storable as VS
  > > > VS.product $ VS.fromList [ 1,2,3,4 : : Int ]
  24
  > > > VS.product ( VS.empty : : VS.Vector Int )
  1
product :: (Storable a, Num a) => Vector a -> a
# INLINE product #
product = G.product

-- | /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__
--
  > > > import qualified Data . Vector . Storable as VS
  > > > VS.maximum $ VS.fromList [ 2 , 1 : : Int ]
  2
maximum :: (Storable a, Ord a) => Vector a -> a
# INLINE maximum #
maximum = G.maximum

-- | /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
-- 'Data.List.maximumBy' which returns the last tie.
maximumBy :: Storable a => (a -> a -> Ordering) -> Vector a -> a
{-# INLINE maximumBy #-}
maximumBy = G.maximumBy

-- | /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
maximumOn :: (Ord b, Storable a) => (a -> b) -> Vector a -> a
# INLINE maximumOn #
maximumOn = G.maximumOn

-- | /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__
--
  > > > import qualified Data . Vector . Storable as VS
  > > > VS.minimum $ VS.fromList [ 2 , 1 : : Int ]
  1
minimum :: (Storable a, Ord a) => Vector a -> a
# INLINE minimum #
minimum = G.minimum

-- | /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 .
minimumBy :: Storable a => (a -> a -> Ordering) -> Vector a -> a
# INLINE minimumBy #
minimumBy = G.minimumBy

-- | /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
minimumOn :: (Ord b, Storable a) => (a -> b) -> Vector a -> a
# INLINE minimumOn #
minimumOn = G.minimumOn

-- | /O(n)/ Yield the index of the maximum element of the vector. The vector
-- may not be empty.
maxIndex :: (Storable a, Ord a) => Vector a -> Int
# INLINE maxIndex #
maxIndex = G.maxIndex

-- | /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 .
maxIndexBy :: Storable a => (a -> a -> Ordering) -> Vector a -> Int
# INLINE maxIndexBy #
maxIndexBy = G.maxIndexBy

-- | /O(n)/ Yield the index of the minimum element of the vector. The vector
-- may not be empty.
minIndex :: (Storable a, Ord a) => Vector a -> Int
# INLINE minIndex #
minIndex = G.minIndex

-- | /O(n)/ Yield the index of the minimum element of the vector according to
-- the given comparison function. The vector may not be empty.
minIndexBy :: Storable a => (a -> a -> Ordering) -> Vector a -> Int
# INLINE minIndexBy #
minIndexBy = G.minIndexBy

  Monadic folds
-- -------------

  | /O(n)/  fold .
foldM :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m a
# INLINE foldM #
foldM = G.foldM

  | /O(n)/ Monadic fold using a function applied to each element and its index .
--
-- @since 0.12.2.0
ifoldM :: (Monad m, Storable b) => (a -> Int -> b -> m a) -> a -> Vector b -> m a
# INLINE ifoldM #
ifoldM = G.ifoldM

  | /O(n)/ Monadic fold over non - empty vectors .
fold1M :: (Monad m, Storable a) => (a -> a -> m a) -> Vector a -> m a
# INLINE fold1 M #
fold1M = G.fold1M

  | /O(n)/  fold with strict accumulator .
foldM' :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m a
# INLINE foldM ' #
foldM' = G.foldM'

  | /O(n)/  fold with strict accumulator using a function applied to each
-- element and its index.
--
-- @since 0.12.2.0
ifoldM' :: (Monad m, Storable b) => (a -> Int -> b -> m a) -> a -> Vector b -> m a
# INLINE ifoldM ' #
ifoldM' = G.ifoldM'

  | /O(n)/ Monadic fold over non - empty vectors with strict accumulator .
fold1M' :: (Monad m, Storable a) => (a -> a -> m a) -> Vector a -> m a
# INLINE fold1 M ' #
fold1M' = G.fold1M'

  | /O(n)/  fold that discards the result .
foldM_ :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m ()
# INLINE foldM _ #
foldM_ = G.foldM_

  | /O(n)/  fold that discards the result using a function applied to
-- each element and its index.
--
-- @since 0.12.2.0
ifoldM_ :: (Monad m, Storable b) => (a -> Int -> b -> m a) -> a -> Vector b -> m ()
# INLINE ifoldM _ #
ifoldM_ = G.ifoldM_

  | /O(n)/ Monadic fold over non - empty vectors that discards the result .
fold1M_ :: (Monad m, Storable a) => (a -> a -> m a) -> Vector a -> m ()
# INLINE fold1 M _ #
fold1M_ = G.fold1M_

  | /O(n)/  fold with strict accumulator that discards the result .
foldM'_ :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m ()
{-# INLINE foldM'_ #-}
foldM'_ = G.foldM'_

  | /O(n)/  fold with strict accumulator that discards the result
-- using a function applied to each element and its index.
--
-- @since 0.12.2.0
ifoldM'_ :: (Monad m, Storable b)
         => (a -> Int -> b -> m a) -> a -> Vector b -> m ()
# INLINE ifoldM ' _ #
ifoldM'_ = G.ifoldM'_

  | /O(n)/ Monadic fold over non - empty vectors with strict accumulator
-- that discards the result.
fold1M'_ :: (Monad m, Storable a) => (a -> a -> m a) -> Vector a -> m ()
# INLINE fold1 M ' _ #
fold1M'_ = G.fold1M'_

-- Scans
-- -----

-- | /O(n)/ Left-to-right prescan.
--
-- @
  prescanl f z = ' init ' . '  ' f z
-- @
--
-- ==== __Examples__
--
  > > > 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
# INLINE prescanl #
prescanl = G.prescanl

-- | /O(n)/ Left-to-right prescan with strict accumulator.
prescanl' :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a
{-# INLINE prescanl' #-}
prescanl' = G.prescanl'

  | /O(n)/ Left - to - right postscan .
--
-- @
  postscanl f z = ' tail ' . '  ' f z
-- @
--
-- ==== __Examples__
--
  > > > 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
# INLINE postscanl #
postscanl = G.postscanl

  | /O(n)/ Left - to - right postscan with strict accumulator .
postscanl' :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a
# INLINE postscanl ' #
postscanl' = G.postscanl'

-- | /O(n)/ Left-to-right scan.
--
  >  f z < x1, ... ,xn > = < y1, ... ,y(n+1 ) >
-- >   where y1 = z
-- >         yi = f y(i-1) x(i-1)
--
-- ==== __Examples__
--
  > > > import qualified Data . Vector . Storable as VS
  > > >  ( + ) 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
# INLINE scanl #
scanl = G.scanl

-- | /O(n)/ Left-to-right scan with strict accumulator.
scanl' :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a
{-# INLINE scanl' #-}
scanl' = G.scanl'

-- | /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
# INLINE iscanl #
iscanl = G.iscanl

-- | /O(n)/ Left-to-right scan over a vector (strictly) with its index.
--
-- @since 0.12.2.0
iscanl' :: (Storable a, Storable b) => (Int -> a -> b -> a) -> a -> Vector b -> Vector a
# INLINE iscanl ' #
iscanl' = G.iscanl'

-- | /O(n)/ Initial-value free left-to-right scan over a vector.
--
  >  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__
  > > > 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
# INLINE scanl1 #
scanl1 = G.scanl1

-- | /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__
  > > > 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
# INLINE scanl1 ' #
scanl1' = G.scanl1'

-- | /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
# INLINE prescanr #
prescanr = G.prescanr

-- | /O(n)/ Right-to-left prescan with strict accumulator.
prescanr' :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b
{-# INLINE prescanr' #-}
prescanr' = G.prescanr'

  | /O(n)/ Right - to - left postscan .
postscanr :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b
# INLINE postscanr #
postscanr = G.postscanr

  | /O(n)/ Right - to - left postscan with strict accumulator .
postscanr' :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b
{-# INLINE postscanr' #-}
postscanr' = G.postscanr'

-- | /O(n)/ Right-to-left scan.
scanr :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b
# INLINE scanr #
scanr = G.scanr

-- | /O(n)/ Right-to-left scan with strict accumulator.
scanr' :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b
{-# INLINE scanr' #-}
scanr' = G.scanr'

-- | /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
# INLINE iscanr #
iscanr = G.iscanr

-- | /O(n)/ Right-to-left scan over a vector (strictly) with its index.
--
-- @since 0.12.2.0
iscanr' :: (Storable a, Storable b) => (Int -> a -> b -> b) -> b -> Vector a -> Vector b
# INLINE iscanr ' #
iscanr' = G.iscanr'

-- | /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__
  > > > 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
# INLINE scanr1 #
scanr1 = G.scanr1

-- | /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__
  > > > 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
# INLINE scanr1 ' #
scanr1' = G.scanr1'

-- Comparisons
-- ------------------------

  | /O(n)/ Check if two vectors are equal using the supplied equality
-- predicate.
--
-- @since 0.12.2.0
eqBy :: (Storable a, Storable b) => (a -> b -> Bool) -> Vector a -> Vector b -> Bool
# INLINE eqBy #
eqBy = G.eqBy

  | /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
cmpBy :: (Storable a, Storable b) => (a -> b -> Ordering) -> Vector a -> Vector b -> Ordering
cmpBy = G.cmpBy

-- Conversions - Lists
-- ------------------------

-- | /O(n)/ Convert a vector to a list.
toList :: Storable a => Vector a -> [a]
# INLINE toList #
toList = G.toList

-- | /O(n)/ Convert a list to a vector.
fromList :: Storable a => [a] -> Vector a
# INLINE fromList #
fromList = G.fromList

  | /O(n)/ Convert the first @n@ elements of a list to a vector . It 's
  expected that the supplied list will be exactly @n@ elements long . As
  an optimization , this function allocates a buffer for @n@ elements , which
-- could be used for DoS-attacks by exhausting the memory if an attacker controls
-- that parameter.
--
-- @
-- fromListN n xs = 'fromList' ('take' n xs)
-- @
--
-- ==== __Examples__
--
  > > > import qualified Data . Vector . Storable as VS
  > > > VS.fromListN 3 [ 1,2,3,4,5 : : Int ]
-- [1,2,3]
  > > > VS.fromListN 3 [ 1 : : Int ]
  [ 1 ]
fromListN :: Storable a => Int -> [a] -> Vector a
# INLINE fromListN #
fromListN = G.fromListN

-- Conversions - Unsafe casts
-- --------------------------

  | /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.
unsafeCast :: forall a b. (Storable a, Storable b) => Vector a -> Vector b
# INLINE unsafeCast #
unsafeCast (Vector n fp)
  = Vector ((n * sizeOf (undefined :: a)) `div` sizeOf (undefined :: b))
           (castForeignPtr fp)

-- Conversions - Mutable vectors
-- -----------------------------

-- | /O(1)/ Unsafely convert a mutable vector to an immutable one without
-- copying. The mutable vector may not be used after this operation.
unsafeFreeze
        :: (Storable a, PrimMonad m) => MVector (PrimState m) a -> m (Vector a)
# INLINE unsafeFreeze #
unsafeFreeze = G.unsafeFreeze

-- | /O(n)/ Yield an immutable copy of the mutable vector.
freeze :: (Storable a, PrimMonad m) => MVector (PrimState m) a -> m (Vector a)
# INLINE freeze #
freeze = G.freeze

  | /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  = V.generate 10 i d
  >       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 do n't . "
unsafeThaw
        :: (Storable a, PrimMonad m) => Vector a -> m (MVector (PrimState m) a)
# INLINE unsafeThaw #
unsafeThaw = G.unsafeThaw

-- | /O(n)/ Yield a mutable copy of an immutable vector.
thaw :: (Storable a, PrimMonad m) => Vector a -> m (MVector (PrimState m) a)
# INLINE thaw #
thaw = G.thaw

  | /O(n)/ Copy an immutable vector into a mutable one . The two vectors must
-- have the same length. This is not checked.
unsafeCopy
  :: (Storable a, PrimMonad m) => MVector (PrimState m) a -> Vector a -> m ()
# INLINE unsafeCopy #
unsafeCopy = G.unsafeCopy

  | /O(n)/ Copy an immutable vector into a mutable one . The two vectors must
-- have the same length.
copy :: (Storable a, PrimMonad m) => MVector (PrimState m) a -> Vector a -> m ()
# INLINE copy #
copy = G.copy

  Conversions - Raw pointers
-- --------------------------

-- | /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 ' .
unsafeFromForeignPtr :: Storable a
                     => ForeignPtr a    -- ^ pointer
                     -> Int             -- ^ offset
                     -> Int             -- ^ length
                     -> Vector a
{-# INLINE_FUSED unsafeFromForeignPtr #-}
unsafeFromForeignPtr fp i n = unsafeFromForeignPtr0 fp' n
    where
      fp' = updPtr (`advancePtr` i) fp

# RULES 
 " unsafeFromForeignPtr fp 0 n - > unsafeFromForeignPtr0 fp n " forall fp n. 
   unsafeFromForeignPtr fp 0 n = unsafeFromForeignPtr0 fp n    #
"unsafeFromForeignPtr fp 0 n -> unsafeFromForeignPtr0 fp n " forall fp n.
  unsafeFromForeignPtr fp 0 n = unsafeFromForeignPtr0 fp n   #-}


-- | /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.
unsafeFromForeignPtr0 :: ForeignPtr a    -- ^ pointer
                      -> Int             -- ^ length
                      -> Vector a
# INLINE unsafeFromForeignPtr0 #
unsafeFromForeignPtr0 fp n = Vector n fp

-- | /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'.
unsafeToForeignPtr :: Vector a -> (ForeignPtr a, Int, Int)
# INLINE unsafeToForeignPtr #
unsafeToForeignPtr (Vector n fp) = (fp, 0, n)

-- | /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'.
unsafeToForeignPtr0 :: Vector a -> (ForeignPtr a, Int)
# INLINE unsafeToForeignPtr0 #
unsafeToForeignPtr0 (Vector n fp) = (fp, n)

  | Pass a pointer to the vector 's data to the IO action . The data may not be
-- modified through the 'Ptr.
unsafeWith :: Storable a => Vector a -> (Ptr a -> IO b) -> IO b
# INLINE unsafeWith #
unsafeWith (Vector _ fp) = withForeignPtr fp

# LANGUAGE DeriveDataTypeable #
# LANGUAGE RankNTypes #
 |
 Module      : Data.Vector.Storable
 License     : BSD-style

 Stability   : experimental
 Portability : non-portable

 'Storable'-based vectors.
 * Storable vectors
 * Accessors
 ** Length information
 ** Indexing
 ** Monadic indexing
 ** Extracting subvectors (slicing)
 * Construction
 ** Initialisation
 ** Unfolding
 ** Enumeration
 ** Concatenation
 ** Restricting memory usage
 * Modifying vectors
 ** Bulk updates
 ** Accumulations
 ** Permutations
 ** Safe destructive updates
 ** Mapping
 ** Zipping
 * Working with predicates
 ** Filtering
 ** Partitioning
 ** Searching
 * Folding
 ** Specialised folds
 * Scans
 ** Comparisons
 * Utilities
 ** Comparisons
 * Conversions
 ** Lists
 ** Other vector types
 ** Mutable vectors
 * Raw pointers
 * Re-exports
 Data.Vector.Internal.Check is unused
 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,
 'Storable' instances.
 | 'Storable'-based vectors.
# UNPACK #
# UNPACK #
 | @since 0.12.1.0
 See 
 See 
# INLINE (<) #
# INLINE (<=) #
# INLINE (>) #
# INLINE (>=) #
# INLINE (<>) #
 Length
 ------
 | /O(1)/ Yield the length of the vector.
 | /O(1)/ Test whether a vector is empty.
 Indexing
 --------
 | O(1) Indexing.
# INLINE (!) #
 | O(1) Safe indexing.
# INLINE (!?) #
 | /O(1)/ Last element.
 | /O(1)/ Unsafe indexing without bounds checking.
 | /O(1)/ Last element, without checking if the vector is empty.
 ----------------
 | /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@

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

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

 element) is evaluated eagerly.
# INLINE indexM #
 explanation of why this is useful.
 | /O(1)/ Last element of a vector in a monad. See 'indexM' for an
 explanation of why this is useful.
 | /O(1)/ Indexing in a monad, without bounds checks. See 'indexM' for an
 explanation of why this is useful.
 See 'indexM' for an explanation of why this is useful.
 | /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)
 -------------------------------
 | /O(1)/ Yield a slice of the vector without copying it. The vector must
 contain at least @i+n@ elements.
 ^ @n@ length
 | /O(1)/ Yield all but the last element without copying. The vector may not
 be empty.
 be empty.
# INLINE take #
# INLINE drop #

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

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

 @since 0.12.2.0
 | /O(1)/ Yield the 'last' and 'init' of the vector, or 'Nothing' if
 the vector is empty.

 @since 0.12.2.0
 | /O(1)/ Yield a slice of the vector without copying. The vector must
 contain at least @i+n@ elements, but this is not checked.
 ^ @n@ length
 | /O(1)/ Yield all but the last element without copying. The vector may not
 be empty, but this is not checked.
# INLINE unsafeInit #
 be empty, but this is not checked.
 contain at least @n@ elements, but this is not checked.
 must contain at least @n@ elements, but this is not checked.
 Initialisation
 --------------
 | /O(1)/ The empty vector.
# INLINE empty #
 | /O(n)/ A vector of the given length with the same value in each position.
 each index.

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

 ===__Examples__

 >>> VS.iterateN 0 undefined undefined :: VS.Vector Int
 []
 >>> VS.iterateN 26 succ 'a'
 "abcdefghijklmnopqrstuvwxyz"

 Unfolding
 ---------
 to a seed. The generator function yields 'Just' the next element and the
 new seed or 'Nothing' if there are no more elements.

 >  = <10,9,8,7,6,5,4,3,2,1>
 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.

 the generator function to a seed. The generator function yields the
 next element and the new seed.


 @since 0.12.2.0
 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.
 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.
 applying the monadic generator function to a seed. The generator
 function yields the next element and the new seed.

 @since 0.12.2.0
 generator function to the already constructed part of the vector.

 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
 -----------
 | /O(n)/ Yield a vector of the given length, containing the values @x@, @x+1@
 etc. This operation is usually more efficient than 'enumFromTo'.

 | /O(n)/ Yield a vector of the given length, containing the values @x@, @x+y@,


 'enumFromN' instead.

# INLINE enumFromThenTo #
 Concatenation
 -------------
 | /O(n)/ Prepend an element.
 | /O(n)/ Append an element.
 ----------------------
 | /O(n)/ Execute the monadic action the given number of times and store the
 results in a vector.
 action to each index.

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

 @since 0.12.0.0
 | Execute the monadic action and freeze the resulting vector.

 @
 @
 NOTE: eta-expanded due to 
 | Execute the monadic action and freeze the resulting vectors.
 Restricting memory usage
 ------------------------
 | /O(n)/ Yield the argument, but force it not to retain any extra memory,
 possibly by copying it.

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


 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.
 Bulk updates
 ------------
 | /O(m+n)/ For each pair @(i,a)@ from the list of index/value pairs,


 ^ initial vector (of length @m@)
 ^ list of index/value pairs (of length @n@)
# INLINE (//) #
 corresponding value @a@ from the value vector, replace the element of the


 ^ initial vector (of length @m@)
 ^ index vector (of length @n1@)
 ^ value vector (of length @n2@)
# INLINE update_ #
 | Same as ('//'), but without bounds checking.
 | Same as 'update_', but without bounds checking.
# INLINE unsafeUpdate_ #
 Accumulations
 -------------
 | /O(m+n)/ For each pair @(i,b)@ from the list, replace the vector element

 ==== __Examples__

 ^ initial vector (of length @m@)
 ^ list of index/value pairs (of length @n@)
 replace the element of the initial vector at


 ^ initial vector (of length @m@)
 ^ index vector (of length @n1@)
 ^ value vector (of length @n2@)
# INLINE accumulate_ #
 | Same as 'accum', but without bounds checking.
 | Same as 'accumulate_', but without bounds checking.
# INLINE unsafeAccumulate_ #
 Permutations
 ------------
 | /O(n)/ Reverse a vector.
 often much more efficient.

 | Same as 'backpermute', but without bounds checking.
# INLINE unsafeBackpermute #
 Safe destructive updates
 ------------------------
 | Apply a destructive operation to a vector. The operation will be
 performed in place if it is safe to do so and will modify a copy of the
 vector otherwise.

 @
 @
 Mapping
 -------
 | /O(n)/ Map a function over a vector.
 | /O(n)/ Apply a function to every element of a vector and its index.
 | Map a function over a vector and concatenate the results.
 ---------------
 | /O(n)/ Apply the monadic action to all elements of the vector, yielding a
 vector of results.
 | /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
 | /O(n)/ Apply the monadic action to all elements of a vector and ignore the
 results.
# INLINE mapM_ #
 | /O(n)/ Apply the monadic action to every element of a vector and its
 index, ignoring the results.

 @since 0.12.2.0
# INLINE imapM_ #
 | /O(n)/ Apply the monadic action to all elements of the vector, yielding a
 | /O(n)/ Apply the monadic action to all elements of a vector and ignore the
# INLINE forM_ #
 | /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
 | /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
# INLINE iforM_ #
 Zipping
 -------
 elements' indices.
# INLINE izipWith #
 and share the same buffer.

 True
 ---------------
 vector of results.
 the element index and yield a vector of results.

 @since 0.12.2.0
 results.
 the element index and ignore the results.

 @since 0.12.2.0
 Filtering
 ---------
 | /O(n)/ Drop all elements that do not satisfy the predicate.
 | /O(n)/ Drop all elements that do not satisfy the predicate which is applied to
 the values and their indices.

 ==== __Examples__

 | /O(n)/ Map the values and collect the 'Just' results.
 | /O(n)/ Map the indices/values and collect the 'Just' results.
 | /O(n)/ Drop all elements that do not satisfy the monadic predicate.
 | /O(n)/ Apply the monadic function to each element of the vector and
 discard elements returning 'Nothing'.

 @since 0.12.2.0
 | /O(n)/ Apply the monadic function to each element of the vector and its index.
 Discard elements returning 'Nothing'.

 @since 0.12.2.0
 | /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.
 | /O(n)/ Drop the longest prefix of elements that satisfy the predicate
 without copying.
 Parititioning
 -------------
 relative order of the elements is preserved at the cost of a sometimes
 reduced performance compared to 'unstablePartition'.
 The relative order of the elements is preserved.

 @since 0.12.1.0
 The order of the elements is not preserved, but the operation is often
 faster than 'partition'.
 | /O(n)/ Split the vector into the longest prefix of elements that satisfy
 the predicate and the rest without copying.
 | /O(n)/ Split the vector into the longest prefix of elements that do not
 satisfy the predicate and the rest without copying.
 | /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.



# INLINE groupBy #
 | /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 (==)'.

 ["M","i","ss","i","ss","i","pp","i"]

 See also 'Data.List.group'.

# INLINE group #
 Searching
 ---------
 | /O(n)/ Check if the vector contains an element.
 | /O(n)/ Check if the vector does not contain an element (inverse of 'elem').
 if no such element exists.
# INLINE find #
 or 'Nothing' if no such element exists.
 | /O(n)/ Yield the indices of elements satisfying the predicate in ascending
 order.
 'Nothing' if the vector does not contain the element. This is a specialised
 version of 'findIndex'.
# INLINE elemIndex #
 | /O(n)/ Yield the indices of all occurrences of the given element in
 ascending order. This is a specialised version of 'findIndices'.
 Folding
 -------
 | /O(n)/ Left fold.
# INLINE foldl #
 | /O(n)/ Left fold on non-empty vectors.
 | /O(n)/ Left fold with strict accumulator.
# INLINE foldl' #
 | /O(n)/ Left fold on non-empty vectors with strict accumulator.
# INLINE foldl1' #
 | /O(n)/ Right fold.
 | /O(n)/ Right fold on non-empty vectors.
 | /O(n)/ Right fold with a strict accumulator.
 | /O(n)/ Right fold on non-empty vectors with strict accumulator.
 | /O(n)/ Left fold using a function applied to each element and its index.
 | /O(n)/ Left fold with strict accumulator using a function applied to each element
 and its index.
# INLINE ifoldl' #
 | /O(n)/ Right fold using a function applied to each element and its index.
 | /O(n)/ Right fold with strict accumulator using a function applied to each
 element and its index.
 | /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
# INLINE foldMap #
 | /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
# INLINE foldMap' #
 -----------------
 | /O(n)/ Check if all elements satisfy the predicate.

 ==== __Examples__

 True
 False
 True
 | /O(n)/ Check if any element satisfies the predicate.

 ==== __Examples__

 False
 True
 >>> VS.any even (VS.empty :: VS.Vector Int)
 False
 | /O(n)/ Check if all elements are 'True'.

 ==== __Examples__

 False
 >>> VS.and VS.empty
 True
 | /O(n)/ Check if any element is 'True'.

 ==== __Examples__

 >>> VS.or $ VS.fromList [True, False]
 True
 >>> VS.or VS.empty
 False
 | /O(n)/ Compute the sum of the elements.

 ==== __Examples__

 | /O(n)/ Compute the product of the elements.

 ==== __Examples__

 | /O(n)/ Yield the maximum element of the vector. The vector may not be

 ==== __Examples__

 | /O(n)/ Yield the maximum element of the vector according to the
 given comparison function. The vector may not be empty. In case of
 'Data.List.maximumBy' which returns the last tie.
# INLINE maximumBy #
 | /O(n)/ Yield the maximum element of the vector by comparing the results
 wins. The vector may not be empty.

 @since 0.13.0.0
 | /O(n)/ Yield the minimum element of the vector. The vector may not be

 ==== __Examples__

 | /O(n)/ Yield the minimum element of the vector according to the
 given comparison function. The vector may not be empty. In case of
 | /O(n)/ Yield the minimum element of the vector by comparing the results
 wins. The vector may not be empty.

 @since 0.13.0.0
 | /O(n)/ Yield the index of the maximum element of the vector. The vector
 may not be empty.
 | /O(n)/ Yield the index of the maximum element of the vector
 according to the given comparison function. The vector may not be
 | /O(n)/ Yield the index of the minimum element of the vector. The vector
 may not be empty.
 | /O(n)/ Yield the index of the minimum element of the vector according to
 the given comparison function. The vector may not be empty.
 -------------

 @since 0.12.2.0
 element and its index.

 @since 0.12.2.0
 each element and its index.

 @since 0.12.2.0
# INLINE foldM'_ #
 using a function applied to each element and its index.

 @since 0.12.2.0
 that discards the result.
 Scans
 -----
 | /O(n)/ Left-to-right prescan.

 @
 @

 ==== __Examples__

 >>> VS.prescanl (+) 0 (VS.fromList [1,2,3,4 :: Int])
 [0,1,3,6]
 | /O(n)/ Left-to-right prescan with strict accumulator.
# INLINE prescanl' #

 @
 @

 ==== __Examples__

 >>> VS.postscanl (+) 0 (VS.fromList [1,2,3,4 :: Int])
 | /O(n)/ Left-to-right scan.

 >   where y1 = z
 >         yi = f y(i-1) x(i-1)

 ==== __Examples__

 [0,1,3,6,10]
 | /O(n)/ Left-to-right scan with strict accumulator.
# INLINE scanl' #
 | /O(n)/ Left-to-right scan over a vector with its index.

 @since 0.12.2.0
 | /O(n)/ Left-to-right scan over a vector (strictly) with its index.

 @since 0.12.2.0
 | /O(n)/ Initial-value free left-to-right scan over a vector.

 >   where y1 = x1
 >         yi = f y(i-1) xi

 results in an error; instead it produces an empty vector.

 ==== __Examples__
 [1,3,3,5,5]
 []
 | /O(n)/ Initial-value free left-to-right scan over a vector with a strict accumulator.

 results in an error; instead it produces an empty vector.

 ==== __Examples__
 [1,3,3,5,5]
 []
 | /O(n)/ Right-to-left prescan.

 @
 prescanr f z = 'reverse' . 'prescanl' (flip f) z . 'reverse'
 @
 | /O(n)/ Right-to-left prescan with strict accumulator.
# INLINE prescanr' #
# INLINE postscanr' #
 | /O(n)/ Right-to-left scan.
 | /O(n)/ Right-to-left scan with strict accumulator.
# INLINE scanr' #
 | /O(n)/ Right-to-left scan over a vector with its index.

 @since 0.12.2.0
 | /O(n)/ Right-to-left scan over a vector (strictly) with its index.

 @since 0.12.2.0
 | /O(n)/ Right-to-left, initial-value free scan over a vector.

 results in an error; instead it produces an empty vector.

 ==== __Examples__
 [1,1,2,2,4]
 []
 | /O(n)/ Right-to-left, initial-value free scan over a vector with a strict
 accumulator.

 results in an error; instead it produces an empty vector.

 ==== __Examples__
 [1,1,2,2,4]
 []
 Comparisons
 ------------------------
 predicate.

 @since 0.12.2.0
 vector elements. Comparison works the same as for lists.

 > cmpBy compare == compare

 @since 0.12.2.0
 Conversions - Lists
 ------------------------
 | /O(n)/ Convert a vector to a list.
 | /O(n)/ Convert a list to a vector.
 could be used for DoS-attacks by exhausting the memory if an attacker controls
 that parameter.

 @
 fromListN n xs = 'fromList' ('take' n xs)
 @

 ==== __Examples__

 [1,2,3]
 Conversions - Unsafe casts
 --------------------------
 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.
 Conversions - Mutable vectors
 -----------------------------
 | /O(1)/ Unsafely convert a mutable vector to an immutable one without
 copying. The mutable vector may not be used after this operation.
 | /O(n)/ Yield an immutable copy of the mutable vector.
 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.

 introduce sharing. As a result mutable vectors produced by
 @unsafeThaw@ may or may not share the same underlying buffer. For
 example:

 > foo = do
 >   do_something mvec

 @do_something@ will use same buffer with possibly disastrous
 results. Whether such aliasing happens or not depends on the program in

 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
 | /O(n)/ Yield a mutable copy of an immutable vector.
 have the same length. This is not checked.
 have the same length.
 --------------------------
 | /O(1)/ Create a vector from a 'ForeignPtr' with an offset and a length.

 The data may not be modified through the pointer afterwards.

 ^ pointer
 ^ offset
 ^ length
# INLINE_FUSED unsafeFromForeignPtr #
 | /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.
 ^ pointer
 ^ length
 | /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'.
 | /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'.
 modified through the 'Ptr.
# LANGUAGE CPP #
# LANGUAGE FlexibleInstances #
# LANGUAGE MultiParamTypeClasses #
# LANGUAGE RoleAnnotations #
# LANGUAGE ScopedTypeVariables #
# LANGUAGE TypeFamilies #
  Copyright    : ( c ) Roman Leshchinskiy 2009 - 2010
                      2020 - 2022
                      2020 - 2022
                      2020 - 2022
  Maintainer   : Haskell Libraries Team <  >

module Data.Vector.Storable (
  Vector, MVector(..),


  length, null,

  (!), (!?), head, last,
  unsafeIndex, unsafeHead, unsafeLast,

  indexM, headM, lastM,
  unsafeIndexM, unsafeHeadM, unsafeLastM,

  slice, init, tail, take, drop, splitAt, uncons, unsnoc,
  unsafeSlice, unsafeInit, unsafeTail, unsafeTake, unsafeDrop,


  empty, singleton, replicate, generate, iterateN,

  * *  initialisation
  replicateM, generateM, iterateNM, create, createT,

  unfoldr, unfoldrN, unfoldrExactN,
  unfoldrM, unfoldrNM, unfoldrExactNM,
  constructN, constructrN,

  enumFromN, enumFromStepN, enumFromTo, enumFromThenTo,

  cons, snoc, (++), concat,

  force,


  (//), update_,
  unsafeUpd, unsafeUpdate_,

  accum, accumulate_,
  unsafeAccum, unsafeAccumulate_,

  reverse, backpermute, unsafeBackpermute,

  modify,

  *  operations

  map, imap, concatMap,

  * *  mapping
  mapM, imapM, mapM_, imapM_, forM, forM_,
  iforM, iforM_,

  zipWith, zipWith3, zipWith4, zipWith5, zipWith6,
  izipWith, izipWith3, izipWith4, izipWith5, izipWith6,

  * *  zipping
  zipWithM, izipWithM, zipWithM_, izipWithM_,


  filter, ifilter, filterM, uniq,
  mapMaybe, imapMaybe,
  mapMaybeM, imapMaybeM,
  takeWhile, dropWhile,

  partition, unstablePartition, partitionWith, span, break, groupBy, group,

  elem, notElem, find, findIndex, findIndices, elemIndex, elemIndices,

  foldl, foldl1, foldl', foldl1', foldr, foldr1, foldr', foldr1',
  ifoldl, ifoldl', ifoldr, ifoldr',
  foldMap, foldMap',

  all, any, and, or,
  sum, product,
  maximum, maximumBy, maximumOn,
  minimum, minimumBy, minimumOn,
  minIndex, minIndexBy, maxIndex, maxIndexBy,

  * *  folds
  foldM, ifoldM, foldM', ifoldM',
  fold1M, fold1M', foldM_, ifoldM_,
  foldM'_, ifoldM'_, fold1M_, fold1M'_,

  prescanl, prescanl',
  postscanl, postscanl',
  scanl, scanl', scanl1, scanl1',
  iscanl, iscanl',
  prescanr, prescanr',
  postscanr, postscanr',
  scanr, scanr', scanr1, scanr1',
  iscanr, iscanr',

  eqBy, cmpBy,

  isSameVector,


  toList, fromList, fromListN,

  G.convert, unsafeCast,
  unsafeCoerceVector,

  freeze, thaw, copy, unsafeFreeze, unsafeThaw, unsafeCopy,

  unsafeFromForeignPtr, unsafeFromForeignPtr0,
  unsafeToForeignPtr,   unsafeToForeignPtr0,
  unsafeWith,

  Storable
) where

import qualified Data.Vector.Generic          as G
import           Data.Vector.Storable.Mutable ( MVector(..) )
import Data.Vector.Storable.Internal
import qualified Data.Vector.Fusion.Bundle as Bundle

import Foreign.Storable
import Foreign.ForeignPtr
import Foreign.Ptr
import Foreign.Marshal.Array ( advancePtr, copyArray )

import Control.DeepSeq ( NFData(rnf)
#if MIN_VERSION_deepseq(1,4,3)
                       , NFData1(liftRnf)
#endif
                       )

import Control.Monad.ST ( ST )
import Control.Monad.Primitive

import Prelude hiding ( length, null,
                        replicate, (++), concat,
                        head, last,
                        init, tail, take, drop, splitAt, reverse,
                        map, concatMap,
                        zipWith, zipWith3, zip, zip3, unzip, unzip3,
                        filter, takeWhile, dropWhile, span, break,
                        elem, notElem,
                        foldl, foldl1, foldr, foldr1, foldMap,
                        all, any, and, or, sum, product, minimum, maximum,
                        scanl, scanl1, scanr, scanr1,
                        enumFromTo, enumFromThenTo,
                        mapM, mapM_ )

import Data.Typeable  ( Typeable )
import Data.Data      ( Data(..) )
import Text.Read      ( Read(..), readListPrecDefault )
import Data.Semigroup ( Semigroup(..) )
import Data.Coerce
import qualified GHC.Exts as Exts
import Unsafe.Coerce

#define NOT_VECTOR_MODULE
#include "vector.h"

type role Vector nominal

  | /O(1)/ Unsafely coerce a mutable vector from one element type to another ,
  since it can not guarantee that the two types have memory - compatible
unsafeCoerceVector :: Coercible a b => Vector a -> Vector b
unsafeCoerceVector = unsafeCoerce

        deriving ( Typeable )

instance NFData (Vector a) where
  rnf (Vector _ _) = ()

#if MIN_VERSION_deepseq(1,4,3)
instance NFData1 Vector where
  liftRnf _ (Vector _ _) = ()
#endif

instance (Show a, Storable a) => Show (Vector a) where
  showsPrec = G.showsPrec

instance (Read a, Storable a) => Read (Vector a) where
  readPrec = G.readPrec
  readListPrec = readListPrecDefault

instance (Data a, Storable a) => Data (Vector a) where
  gfoldl       = G.gfoldl
  toConstr _   = G.mkVecConstr "Data.Vector.Storable.Vector"
  gunfold      = G.gunfold
  dataTypeOf _ = G.mkVecType "Data.Vector.Storable.Vector"
  dataCast1    = G.dataCast


type instance G.Mutable Vector = MVector

instance Storable a => G.Vector Vector a where
# INLINE basicUnsafeFreeze #
  basicUnsafeFreeze (MVector n fp) = return $ Vector n fp

# INLINE basicUnsafeThaw #
  basicUnsafeThaw (Vector n fp) = return $ MVector n fp

# INLINE basicLength #
  basicLength (Vector n _) = n

# INLINE basicUnsafeSlice #
  basicUnsafeSlice i n (Vector _ fp) = Vector n (updPtr (`advancePtr` i) fp)

# INLINE basicUnsafeIndexM #
  basicUnsafeIndexM (Vector _ fp) i = return
                                    . unsafeInlineIO
                                    $ unsafeWithForeignPtr fp $ \p ->
                                      peekElemOff p i

# INLINE basicUnsafeCopy #
  basicUnsafeCopy (MVector n fp) (Vector _ fq)
    = unsafePrimToPrim
    $ unsafeWithForeignPtr fp $ \p ->
      unsafeWithForeignPtr fq $ \q ->
      copyArray p q n

# INLINE elemseq #
  elemseq _ = seq

instance (Storable a, Eq a) => Eq (Vector a) where
# INLINE (= =) #
  xs == ys = Bundle.eq (G.stream xs) (G.stream ys)

instance (Storable a, Ord a) => Ord (Vector a) where
# INLINE compare #
  compare xs ys = Bundle.cmp (G.stream xs) (G.stream ys)

  xs < ys = Bundle.cmp (G.stream xs) (G.stream ys) == LT

  xs <= ys = Bundle.cmp (G.stream xs) (G.stream ys) /= GT

  xs > ys = Bundle.cmp (G.stream xs) (G.stream ys) == GT

  xs >= ys = Bundle.cmp (G.stream xs) (G.stream ys) /= LT

instance Storable a => Semigroup (Vector a) where
  (<>) = (++)

# INLINE sconcat #
  sconcat = G.concatNE

instance Storable a => Monoid (Vector a) where
# INLINE mempty #
  mempty = empty

# INLINE mappend #
  mappend = (<>)

# INLINE mconcat #
  mconcat = concat

instance Storable a => Exts.IsList (Vector a) where
  type Item (Vector a) = a
  fromList = fromList
  fromListN = fromListN
  toList = toList


length :: Storable a => Vector a -> Int
# INLINE length #
length = G.length

null :: Storable a => Vector a -> Bool
# INLINE null #
null = G.null


(!) :: Storable a => Vector a -> Int -> a
(!) = (G.!)

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

  | /O(1)/ First element .
head :: Storable a => Vector a -> a
# INLINE head #
head = G.head

last :: Storable a => Vector a -> a
# INLINE last #
last = G.last

unsafeIndex :: Storable a => Vector a -> Int -> a
# INLINE unsafeIndex #
unsafeIndex = G.unsafeIndex

  | /O(1)/ First element , without checking if the vector is empty .
unsafeHead :: Storable a => Vector a -> a
# INLINE unsafeHead #
unsafeHead = G.unsafeHead

unsafeLast :: Storable a => Vector a -> a
# INLINE unsafeLast #
unsafeLast = G.unsafeLast

  Monadic indexing

  would unnecessarily retain a reference to @v@ in each element written .
  Here , no references to @v@ are retained because indexing ( but /not/ the
indexM :: (Storable a, Monad m) => Vector a -> Int -> m a
indexM = G.indexM

  | /O(1)/ First element of a vector in a monad . See ' indexM ' for an
headM :: (Storable a, Monad m) => Vector a -> m a
# INLINE headM #
headM = G.headM

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

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

  | /O(1)/ First element in a monad , without checking for empty vectors .
unsafeHeadM :: (Storable a, Monad m) => Vector a -> m a
# INLINE unsafeHeadM #
unsafeHeadM = G.unsafeHeadM

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


slice :: Storable a
  ^ @i@ starting index
      -> Vector a
      -> Vector a
# INLINE slice #
slice = G.slice

init :: Storable a => Vector a -> Vector a
# INLINE init #
init = G.init

  | /O(1)/ Yield all but the first element without copying . The vector may not
tail :: Storable a => Vector a -> Vector a
# INLINE tail #
tail = G.tail

  | /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 .
take :: Storable a => Int -> Vector a -> Vector a
take = G.take

  | /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 .
drop :: Storable a => Int -> Vector a -> Vector a
drop = G.drop

  | /O(1)/ Yield the first @n@ elements paired with the remainder , without copying .
  @since 0.7.1
splitAt :: Storable a => Int -> Vector a -> (Vector a, Vector a)
# INLINE splitAt #
splitAt = G.splitAt

uncons :: Storable a => Vector a -> Maybe (a, Vector a)
# INLINE uncons #
uncons = G.uncons

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

  ^ @i@ starting index
                       -> Vector a
                       -> Vector a
# INLINE unsafeSlice #
unsafeSlice = G.unsafeSlice

unsafeInit :: Storable a => Vector a -> Vector a
unsafeInit = G.unsafeInit

  | /O(1)/ Yield all but the first element without copying . The vector may not
unsafeTail :: Storable a => Vector a -> Vector a
# INLINE unsafeTail #
unsafeTail = G.unsafeTail

  | /O(1)/ Yield the first @n@ elements without copying . The vector must
unsafeTake :: Storable a => Int -> Vector a -> Vector a
# INLINE unsafeTake #
unsafeTake = G.unsafeTake

  | /O(1)/ Yield all but the first @n@ elements without copying . The vector
unsafeDrop :: Storable a => Int -> Vector a -> Vector a
# INLINE unsafeDrop #
unsafeDrop = G.unsafeDrop


empty :: Storable a => Vector a
empty = G.empty

  | /O(1)/ A vector with exactly one element .
singleton :: Storable a => a -> Vector a
# INLINE singleton #
singleton = G.singleton

replicate :: Storable a => Int -> a -> Vector a
# INLINE replicate #
replicate = G.replicate

  | /O(n)/ Construct a vector of the given length by applying the function to
generate :: Storable a => Int -> (Int -> a) -> Vector a
# INLINE generate #
generate = G.generate

  | /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 .
  > > > import qualified Data . Vector . Storable as VS
  @since 0.7.1
iterateN :: Storable a => Int -> (a -> a) -> a -> Vector a
# INLINE iterateN #
iterateN = G.iterateN


  | /O(n)/ Construct a vector by repeatedly applying the generator function
  > unfoldr ( \n - > if n = = 0 then Nothing else Just ( n , n-1 ) ) 10
unfoldr :: Storable a => (b -> Maybe (a, b)) -> b -> Vector a
# INLINE unfoldr #
unfoldr = G.unfoldr

  | /O(n)/ Construct a vector with at most @n@ elements by repeatedly applying
  > unfoldrN 3 ( \n - > Just ( n , n-1 ) ) 10 = < 10,9,8 >
unfoldrN :: Storable a => Int -> (b -> Maybe (a, b)) -> b -> Vector a
# INLINE unfoldrN #
unfoldrN = G.unfoldrN

  | /O(n)/ Construct a vector with exactly @n@ elements by repeatedly applying
  > unfoldrExactN 3 ( \n - > ( n , n-1 ) ) 10 = < 10,9,8 >
unfoldrExactN :: (Storable a) => Int -> (b -> (a, b)) -> b -> Vector a
# INLINE unfoldrExactN #
unfoldrExactN = G.unfoldrExactN

  | /O(n)/ Construct a vector by repeatedly applying the monadic
unfoldrM :: (Monad m, Storable a) => (b -> m (Maybe (a, b))) -> b -> m (Vector a)
# INLINE unfoldrM #
unfoldrM = G.unfoldrM

  | /O(n)/ Construct a vector by repeatedly applying the monadic
unfoldrNM :: (Monad m, Storable a) => Int -> (b -> m (Maybe (a, b))) -> b -> m (Vector a)
# INLINE unfoldrNM #
unfoldrNM = G.unfoldrNM

  | /O(n)/ Construct a vector with exactly @n@ elements by repeatedly
unfoldrExactNM :: (Monad m, Storable a) => Int -> (b -> m (a, b)) -> b -> m (Vector a)
# INLINE unfoldrExactNM #
unfoldrExactNM = G.unfoldrExactNM

  | /O(n)/ Construct a vector with @n@ elements by repeatedly applying the
  > constructN 3 f = let a = f < > ; b = f < a > ; c = f < a , b > in < a , b , c >
constructN :: Storable a => Int -> (Vector a -> a) -> Vector a
# INLINE constructN #
constructN = G.constructN

  | /O(n)/ Construct a vector with @n@ elements from right to left by
constructrN :: Storable a => Int -> (Vector a -> a) -> Vector a
# INLINE constructrN #
constructrN = G.constructrN


  > enumFromN 5 3 = < 5,6,7 >
enumFromN :: (Storable a, Num a) => a -> Int -> Vector a
# INLINE enumFromN #
enumFromN = G.enumFromN

  @x+y+y@ etc . This operations is usually more efficient than ' enumFromThenTo ' .
  > enumFromStepN 1 2 5 = < 1,3,5,7,9 >
enumFromStepN :: (Storable a, Num a) => a -> a -> Int -> Vector a
# INLINE enumFromStepN #
enumFromStepN = G.enumFromStepN

  | /O(n)/ Enumerate values from @x@ to @y@.
  /WARNING:/ This operation can be very inefficient . If possible , use
enumFromTo :: (Storable a, Enum a) => a -> a -> Vector a
# INLINE enumFromTo #
enumFromTo = G.enumFromTo

  | /O(n)/ Enumerate values from @x@ to @y@ with a specific step 
  /WARNING:/ This operation can be very inefficient . If possible , use
  ' enumFromStepN ' instead .
enumFromThenTo :: (Storable a, Enum a) => a -> a -> a -> Vector a
enumFromThenTo = G.enumFromThenTo


cons :: Storable a => a -> Vector a -> Vector a
# INLINE cons #
cons = G.cons

snoc :: Storable a => Vector a -> a -> Vector a
# INLINE snoc #
snoc = G.snoc

infixr 5 ++
  | /O(m+n)/ Concatenate two vectors .
(++) :: Storable a => Vector a -> Vector a -> Vector a
# INLINE ( + + ) #
(++) = (G.++)

  | /O(n)/  all vectors in the list .
concat :: Storable a => [Vector a] -> Vector a
# INLINE concat #
concat = G.concat

  Monadic initialisation

replicateM :: (Monad m, Storable a) => Int -> m a -> m (Vector a)
# INLINE replicateM #
replicateM = G.replicateM

  | /O(n)/ Construct a vector of the given length by applying the monadic
generateM :: (Monad m, Storable a) => Int -> (Int -> m a) -> m (Vector a)
# INLINE generateM #
generateM = G.generateM

  | /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 .
iterateNM :: (Monad m, Storable a) => Int -> (a -> m a) -> a -> m (Vector a)
# INLINE iterateNM #
iterateNM = G.iterateNM

  create ( do { v \<- new 2 ; write v 0 \'a\ ' ; write v 1 \'b\ ' ; return v } ) = \<'a','b'\ >
create :: Storable a => (forall s. ST s (MVector s a)) -> Vector a
# INLINE create #
create p = G.create p

createT :: (Traversable f, Storable a) => (forall s. ST s (f (MVector s a))) -> f (Vector a)
# INLINE createT #
createT p = G.createT p


  > force ( slice 0 2 < huge vector > )
force :: Storable a => Vector a -> Vector a
# INLINE force #
force = G.force


  replace the vector element at position @i@ by 
  > < 5,9,2,7 > // [ ( 2,1),(0,3),(2,8 ) ] = < 3,9,8,7 >
                -> Vector a
(//) = (G.//)

  | /O(m+min(n1,n2))/ For each index @i@ from the index vector and the
  initial vector at position @i@ by 
  > update _ < 5,9,2,7 >   < 2,0,2 > < 1,3,8 > = < 3,9,8,7 >
update_ :: Storable a
        -> Vector a
update_ = G.update_

unsafeUpd :: Storable a => Vector a -> [(Int, a)] -> Vector a
# INLINE unsafeUpd #
unsafeUpd = G.unsafeUpd

unsafeUpdate_ :: Storable a => Vector a -> Vector Int -> Vector a -> Vector a
unsafeUpdate_ = G.unsafeUpdate_


  @a@ at position @i@ by @f a b@.
  > > > 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 ]
accum :: Storable a
  ^ accumulating function @f@
      -> Vector a
# INLINE accum #
accum = G.accum

  | /O(m+min(n1,n2))/ For each index @i@ from the index vector and the
  corresponding value @b@ from the the value vector ,
  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 >
accumulate_ :: (Storable a, Storable b)
  ^ accumulating function @f@
            -> Vector a
accumulate_ = G.accumulate_

unsafeAccum :: Storable a => (a -> b -> a) -> Vector a -> [(Int,b)] -> Vector a
# INLINE unsafeAccum #
unsafeAccum = G.unsafeAccum

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


reverse :: Storable a => Vector a -> Vector a
# INLINE reverse #
reverse = G.reverse

  | /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
  > backpermute < a , b , c , d > < 0,3,2,3,1,0 > = < a , d , c , d , b , a >
backpermute :: Storable a => Vector a -> Vector Int -> Vector a
# INLINE backpermute #
backpermute = G.backpermute

unsafeBackpermute :: Storable a => Vector a -> Vector Int -> Vector a
unsafeBackpermute = G.unsafeBackpermute


  modify ( \\v - > write v 0 \'x\ ' ) ( ' replicate ' 3 \'a\ ' ) = \<\'x\',\'a\',\'a\'\ >
modify :: Storable a => (forall s. MVector s a -> ST s ()) -> Vector a -> Vector a
# INLINE modify #
modify p = G.modify p


map :: (Storable a, Storable b) => (a -> b) -> Vector a -> Vector b
# INLINE map #
map = G.map

imap :: (Storable a, Storable b) => (Int -> a -> b) -> Vector a -> Vector b
# INLINE imap #
imap = G.imap

concatMap :: (Storable a, Storable b) => (a -> Vector b) -> Vector a -> Vector b
# INLINE concatMap #
concatMap = G.concatMap

  Monadic mapping

mapM :: (Monad m, Storable a, Storable b) => (a -> m b) -> Vector a -> m (Vector b)
# INLINE mapM #
mapM = G.mapM

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

mapM_ :: (Monad m, Storable a) => (a -> m b) -> Vector a -> m ()
mapM_ = G.mapM_

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

  vector of results . Equivalent to  ' mapM'@.
forM :: (Monad m, Storable a, Storable b) => Vector a -> (a -> m b) -> m (Vector b)
# INLINE forM #
forM = G.forM

  results . Equivalent to  ' mapM_'@.
forM_ :: (Monad m, Storable a) => Vector a -> (a -> m b) -> m ()
forM_ = G.forM_

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

iforM_ :: (Monad m, Storable a) => Vector a -> (Int -> a -> m b) -> m ()
iforM_ = G.iforM_


  | /O(min(m , n))/ Zip two vectors with the given function .
zipWith :: (Storable a, Storable b, Storable c)
        => (a -> b -> c) -> Vector a -> Vector b -> Vector c
# INLINE zipWith #
zipWith = G.zipWith

  | Zip three 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
# INLINE zipWith3 #
zipWith3 = G.zipWith3

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
# INLINE zipWith4 #
zipWith4 = G.zipWith4

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
# INLINE zipWith5 #
zipWith5 = G.zipWith5

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
# INLINE zipWith6 #
zipWith6 = G.zipWith6

  | /O(min(m , n))/ Zip two vectors with a function that also takes the
izipWith :: (Storable a, Storable b, Storable c)
         => (Int -> a -> b -> c) -> Vector a -> Vector b -> Vector c
izipWith = G.izipWith

  | Zip three vectors and their indices with the given function .
izipWith3 :: (Storable a, Storable b, Storable c, Storable d)
          => (Int -> a -> b -> c -> d)
          -> Vector a -> Vector b -> Vector c -> Vector d
# INLINE izipWith3 #
izipWith3 = G.izipWith3

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
# INLINE izipWith4 #
izipWith4 = G.izipWith4

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
# INLINE izipWith5 #
izipWith5 = G.izipWith5

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
# INLINE izipWith6 #
izipWith6 = G.izipWith6

  | Checks whether two values are the same vector : they have same length
  > > > let xs = fromList [ 0/0::Double ] in isSameVector xs xs
isSameVector :: (Storable a) => Vector a -> Vector a -> Bool
# INLINE isSameVector #
isSameVector (Vector n1 ptr1) (Vector n2 ptr2) = n1 == n2 && ptr1 == ptr2


  Monadic zipping

  | /O(min(m , n))/ Zip the two vectors with the monadic action and yield a
zipWithM :: (Monad m, Storable a, Storable b, Storable c)
         => (a -> b -> m c) -> Vector a -> Vector b -> m (Vector c)
# INLINE zipWithM #
zipWithM = G.zipWithM

  | /O(min(m , n))/ Zip the two vectors with a monadic action that also takes
izipWithM :: (Monad m, Storable a, Storable b, Storable c)
          => (Int -> a -> b -> m c) -> Vector a -> Vector b -> m (Vector c)
# INLINE izipWithM #
izipWithM = G.izipWithM

  | /O(min(m , n))/ Zip the two vectors with the monadic action and ignore the
zipWithM_ :: (Monad m, Storable a, Storable b)
          => (a -> b -> m c) -> Vector a -> Vector b -> m ()
# INLINE zipWithM _ #
zipWithM_ = G.zipWithM_

  | /O(min(m , n))/ Zip the two vectors with a monadic action that also takes
izipWithM_ :: (Monad m, Storable a, Storable b)
           => (Int -> a -> b -> m c) -> Vector a -> Vector b -> m ()
# INLINE izipWithM _ #
izipWithM_ = G.izipWithM_


filter :: Storable a => (a -> Bool) -> Vector a -> Vector a
# INLINE filter #
filter = G.filter

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

  | /O(n)/ Drop repeated adjacent elements . The first element in each group is returned .
  > > > import qualified Data . Vector . Storable as VS
  > > > VS.uniq $ VS.fromList [ 1,3,3,200,3 : : Int ]
  [ 1,3,200,3 ]
uniq :: (Storable a, Eq a) => Vector a -> Vector a
# INLINE uniq #
uniq = G.uniq

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

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

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

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

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

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

dropWhile :: Storable a => (a -> Bool) -> Vector a -> Vector a
# INLINE dropWhile #
dropWhile = G.dropWhile


  | /O(n)/ Split the vector in two parts , the first one containing those
  elements that satisfy the predicate and the second one those that do n't . The
partition :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
# INLINE partition #
partition = G.partition

  | /O(n)/ Split the vector into two parts , the first one containing the
  @`Left`@ elements and the second containing the @`Right`@ elements .
partitionWith :: (Storable a, Storable b, Storable c) => (a -> Either b c) -> Vector a -> (Vector b, Vector c)
# INLINE partitionWith #
partitionWith = G.partitionWith

  | /O(n)/ Split the vector in two parts , the first one containing those
  elements that satisfy the predicate and the second one those that do n't .
unstablePartition :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
# INLINE unstablePartition #
unstablePartition = G.unstablePartition

span :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
# INLINE span #
span = G.span

break :: Storable a => (a -> Bool) -> Vector a -> (Vector a, Vector a)
# INLINE break #
break = G.break

  > > > import qualified Data . Vector . Storable as VS
  > > > import            Data .  ( isUpper )
  > > > VS.groupBy ( \a b - > isUpper a = = isUpper b ) ( VS.fromList " Mississippi River " )
  [ " M","ississippi " , " R","iver " ]
  See also ' Data . List.groupBy ' , ' group ' .
  @since 0.13.0.1
groupBy :: Storable a => (a -> a -> Bool) -> Vector a -> [Vector a]
groupBy = G.groupBy

  > > > import qualified Data . Vector . Storable as VS
  > > > VS.group ( VS.fromList " Mississippi " )
  @since 0.13.0.1
group :: (Storable a, Eq a) => Vector a -> [Vector a]
group = G.groupBy (==)


infix 4 `elem`
elem :: (Storable a, Eq a) => a -> Vector a -> Bool
# INLINE elem #
elem = G.elem

infix 4 `notElem`
notElem :: (Storable a, Eq a) => a -> Vector a -> Bool
# INLINE notElem #
notElem = G.notElem

  | /O(n)/ Yield ' Just ' the first element matching the predicate or ' Nothing '
find :: Storable a => (a -> Bool) -> Vector a -> Maybe a
find = G.find

  | /O(n)/ Yield ' Just ' the index of the first element matching the predicate
findIndex :: Storable a => (a -> Bool) -> Vector a -> Maybe Int
# INLINE findIndex #
findIndex = G.findIndex

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

  | /O(n)/ Yield ' Just ' the index of the first occurrence of the given element or
elemIndex :: (Storable a, Eq a) => a -> Vector a -> Maybe Int
elemIndex = G.elemIndex

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


foldl :: Storable b => (a -> b -> a) -> a -> Vector b -> a
foldl = G.foldl

foldl1 :: Storable a => (a -> a -> a) -> Vector a -> a
# INLINE foldl1 #
foldl1 = G.foldl1

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

foldl1' :: Storable a => (a -> a -> a) -> Vector a -> a
foldl1' = G.foldl1'

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

foldr1 :: Storable a => (a -> a -> a) -> Vector a -> a
# INLINE foldr1 #
foldr1 = G.foldr1

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

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

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

ifoldl' :: Storable b => (a -> Int -> b -> a) -> a -> Vector b -> a
ifoldl' = G.ifoldl'

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

ifoldr' :: Storable a => (Int -> a -> b -> b) -> b -> Vector a -> b
# INLINE ifoldr ' #
ifoldr' = G.ifoldr'

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

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

  Specialised folds

  > > > import qualified Data . Vector . Storable as VS
  > > > VS.all even $ VS.fromList [ 2 , 4 , 12 : : Int ]
  > > > VS.all even $ VS.fromList [ 2 , 4 , 13 : : Int ]
  > > > VS.all even ( VS.empty : : VS.Vector Int )
all :: Storable a => (a -> Bool) -> Vector a -> Bool
# INLINE all #
all = G.all

  > > > import qualified Data . Vector . Storable as VS
  > > > VS.any even $ VS.fromList [ 1 , 3 , 7 : : Int ]
  > > > VS.any even $ VS.fromList [ 3 , 2 , 13 : : Int ]
any :: Storable a => (a -> Bool) -> Vector a -> Bool
# INLINE any #
any = G.any

  > > > import qualified Data . Vector . Storable as VS
  > > > VS.and $ VS.fromList [ True , False ]
and :: Vector Bool -> Bool
# INLINE and #
and = G.and

  > > > import qualified Data . Vector . Storable as VS
or :: Vector Bool -> Bool
# INLINE or #
or = G.or

  > > > import qualified Data . Vector . Storable as VS
  > > > VS.sum $ VS.fromList [ 300,20,1 : : Int ]
  321
  > > > VS.sum ( VS.empty : : VS.Vector Int )
  0
sum :: (Storable a, Num a) => Vector a -> a
# INLINE sum #
sum = G.sum

  > > > 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
product :: (Storable a, Num a) => Vector a -> a
# INLINE product #
product = G.product

  empty . In case of a tie , the first occurrence wins .
  > > > import qualified Data . Vector . Storable as VS
  > > > VS.maximum $ VS.fromList [ 2 , 1 : : Int ]
  2
maximum :: (Storable a, Ord a) => Vector a -> a
# INLINE maximum #
maximum = G.maximum

  a tie , the first occurrence wins . This behavior is different from
maximumBy :: Storable a => (a -> a -> Ordering) -> Vector a -> a
maximumBy = G.maximumBy

  of a key function on each element . In case of a tie , the first occurrence
maximumOn :: (Ord b, Storable a) => (a -> b) -> Vector a -> a
# INLINE maximumOn #
maximumOn = G.maximumOn

  empty . In case of a tie , the first occurrence wins .
  > > > import qualified Data . Vector . Storable as VS
  > > > VS.minimum $ VS.fromList [ 2 , 1 : : Int ]
  1
minimum :: (Storable a, Ord a) => Vector a -> a
# INLINE minimum #
minimum = G.minimum

  a tie , the first occurrence wins .
minimumBy :: Storable a => (a -> a -> Ordering) -> Vector a -> a
# INLINE minimumBy #
minimumBy = G.minimumBy

  of a key function on each element . In case of a tie , the first occurrence
minimumOn :: (Ord b, Storable a) => (a -> b) -> Vector a -> a
# INLINE minimumOn #
minimumOn = G.minimumOn

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

  empty . In case of a tie , the first occurrence wins .
maxIndexBy :: Storable a => (a -> a -> Ordering) -> Vector a -> Int
# INLINE maxIndexBy #
maxIndexBy = G.maxIndexBy

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

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

  Monadic folds

  | /O(n)/  fold .
foldM :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m a
# INLINE foldM #
foldM = G.foldM

  | /O(n)/ Monadic fold using a function applied to each element and its index .
ifoldM :: (Monad m, Storable b) => (a -> Int -> b -> m a) -> a -> Vector b -> m a
# INLINE ifoldM #
ifoldM = G.ifoldM

  | /O(n)/ Monadic fold over non - empty vectors .
fold1M :: (Monad m, Storable a) => (a -> a -> m a) -> Vector a -> m a
# INLINE fold1 M #
fold1M = G.fold1M

  | /O(n)/  fold with strict accumulator .
foldM' :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m a
# INLINE foldM ' #
foldM' = G.foldM'

  | /O(n)/  fold with strict accumulator using a function applied to each
ifoldM' :: (Monad m, Storable b) => (a -> Int -> b -> m a) -> a -> Vector b -> m a
# INLINE ifoldM ' #
ifoldM' = G.ifoldM'

  | /O(n)/ Monadic fold over non - empty vectors with strict accumulator .
fold1M' :: (Monad m, Storable a) => (a -> a -> m a) -> Vector a -> m a
# INLINE fold1 M ' #
fold1M' = G.fold1M'

  | /O(n)/  fold that discards the result .
foldM_ :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m ()
# INLINE foldM _ #
foldM_ = G.foldM_

  | /O(n)/  fold that discards the result using a function applied to
ifoldM_ :: (Monad m, Storable b) => (a -> Int -> b -> m a) -> a -> Vector b -> m ()
# INLINE ifoldM _ #
ifoldM_ = G.ifoldM_

  | /O(n)/ Monadic fold over non - empty vectors that discards the result .
fold1M_ :: (Monad m, Storable a) => (a -> a -> m a) -> Vector a -> m ()
# INLINE fold1 M _ #
fold1M_ = G.fold1M_

  | /O(n)/  fold with strict accumulator that discards the result .
foldM'_ :: (Monad m, Storable b) => (a -> b -> m a) -> a -> Vector b -> m ()
foldM'_ = G.foldM'_

  | /O(n)/  fold with strict accumulator that discards the result
ifoldM'_ :: (Monad m, Storable b)
         => (a -> Int -> b -> m a) -> a -> Vector b -> m ()
# INLINE ifoldM ' _ #
ifoldM'_ = G.ifoldM'_

  | /O(n)/ Monadic fold over non - empty vectors with strict accumulator
fold1M'_ :: (Monad m, Storable a) => (a -> a -> m a) -> Vector a -> m ()
# INLINE fold1 M ' _ #
fold1M'_ = G.fold1M'_


  prescanl f z = ' init ' . '  ' f z
  > > > import qualified Data . Vector . Storable as VS
prescanl :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a
# INLINE prescanl #
prescanl = G.prescanl

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

  | /O(n)/ Left - to - right postscan .
  postscanl f z = ' tail ' . '  ' f z
  > > > import qualified Data . Vector . Storable as VS
  [ 1,3,6,10 ]
postscanl :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a
# INLINE postscanl #
postscanl = G.postscanl

  | /O(n)/ Left - to - right postscan with strict accumulator .
postscanl' :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a
# INLINE postscanl ' #
postscanl' = G.postscanl'

  >  f z < x1, ... ,xn > = < y1, ... ,y(n+1 ) >
  > > > import qualified Data . Vector . Storable as VS
  > > >  ( + ) 0 ( VS.fromList [ 1,2,3,4 : : Int ] )
scanl :: (Storable a, Storable b) => (a -> b -> a) -> a -> Vector b -> Vector a
# INLINE scanl #
scanl = G.scanl

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

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

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

  >  f < x1, ... ,xn > = < y1, ... ,yn >
  Note : Since 0.13 , application of this to an empty vector no longer
  > > > 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 ]
  > > > VS.scanl1 min ( VS.empty : : VS.Vector Int )
scanl1 :: Storable a => (a -> a -> a) -> Vector a -> Vector a
# INLINE scanl1 #
scanl1 = G.scanl1

  Note : Since 0.13 , application of this to an empty vector no longer
  > > > 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 ]
  > > > VS.scanl1 ' min ( VS.empty : : VS.Vector Int )
scanl1' :: Storable a => (a -> a -> a) -> Vector a -> Vector a
# INLINE scanl1 ' #
scanl1' = G.scanl1'

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

prescanr' :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b
prescanr' = G.prescanr'

  | /O(n)/ Right - to - left postscan .
postscanr :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b
# INLINE postscanr #
postscanr = G.postscanr

  | /O(n)/ Right - to - left postscan with strict accumulator .
postscanr' :: (Storable a, Storable b) => (a -> b -> b) -> b -> Vector a -> Vector b
postscanr' = G.postscanr'

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

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

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

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

  Note : Since 0.13 , application of this to an empty vector no longer
  > > > import qualified Data . Vector . Storable as VS
  > > > VS.scanr1 min $ VS.fromListN 5 [ 3,1,4,2,4 : : Int ]
  > > > 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
# INLINE scanr1 #
scanr1 = G.scanr1

  Note : Since 0.13 , application of this to an empty vector no longer
  > > > import qualified Data . Vector . Storable as VS
  > > > VS.scanr1 ' min $ VS.fromListN 5 [ 3,1,4,2,4 : : Int ]
  > > > 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
# INLINE scanr1 ' #
scanr1' = G.scanr1'


  | /O(n)/ Check if two vectors are equal using the supplied equality
eqBy :: (Storable a, Storable b) => (a -> b -> Bool) -> Vector a -> Vector b -> Bool
# INLINE eqBy #
eqBy = G.eqBy

  | /O(n)/ Compare two vectors using supplied the comparison function for
cmpBy :: (Storable a, Storable b) => (a -> b -> Ordering) -> Vector a -> Vector b -> Ordering
cmpBy = G.cmpBy


toList :: Storable a => Vector a -> [a]
# INLINE toList #
toList = G.toList

fromList :: Storable a => [a] -> Vector a
# INLINE fromList #
fromList = G.fromList

  | /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
  > > > import qualified Data . Vector . Storable as VS
  > > > VS.fromListN 3 [ 1,2,3,4,5 : : Int ]
  > > > VS.fromListN 3 [ 1 : : Int ]
  [ 1 ]
fromListN :: Storable a => Int -> [a] -> Vector a
# INLINE fromListN #
fromListN = G.fromListN


  | /O(1)/ Unsafely cast a vector from one element type to another .
unsafeCast :: forall a b. (Storable a, Storable b) => Vector a -> Vector b
# INLINE unsafeCast #
unsafeCast (Vector n fp)
  = Vector ((n * sizeOf (undefined :: a)) `div` sizeOf (undefined :: b))
           (castForeignPtr fp)


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

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

  | /O(1)/ Unsafely convert an immutable vector to a mutable one
  Problems with mutation happen because GHC has a lot of freedom to
  >    let  = V.generate 10 i d
  >       V.unsafeThaw vec
  Here GHC could lift @vec@ outside of foo which means that all calls to
  question , optimization levels , and GHC flags .
  All in all , attempts to modify a vector produced by @unsafeThaw@ fall out of
  know how to prevent GHC from aliasing buffers accidentally . We do n't . "
unsafeThaw
        :: (Storable a, PrimMonad m) => Vector a -> m (MVector (PrimState m) a)
# INLINE unsafeThaw #
unsafeThaw = G.unsafeThaw

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

  | /O(n)/ Copy an immutable vector into a mutable one . The two vectors must
unsafeCopy
  :: (Storable a, PrimMonad m) => MVector (PrimState m) a -> Vector a -> m ()
# INLINE unsafeCopy #
unsafeCopy = G.unsafeCopy

  | /O(n)/ Copy an immutable vector into a mutable one . The two vectors must
copy :: (Storable a, PrimMonad m) => MVector (PrimState m) a -> Vector a -> m ()
# INLINE copy #
copy = G.copy

  Conversions - Raw pointers

  If your offset is 0 it is more efficient to use ' unsafeFromForeignPtr0 ' .
unsafeFromForeignPtr :: Storable a
                     -> Vector a
unsafeFromForeignPtr fp i n = unsafeFromForeignPtr0 fp' n
    where
      fp' = updPtr (`advancePtr` i) fp

# RULES 
 " unsafeFromForeignPtr fp 0 n - > unsafeFromForeignPtr0 fp n " forall fp n. 
   unsafeFromForeignPtr fp 0 n = unsafeFromForeignPtr0 fp n    #
"unsafeFromForeignPtr fp 0 n -> unsafeFromForeignPtr0 fp n " forall fp n.
  unsafeFromForeignPtr fp 0 n = unsafeFromForeignPtr0 fp n   #-}


                      -> Vector a
# INLINE unsafeFromForeignPtr0 #
unsafeFromForeignPtr0 fp n = Vector n fp

unsafeToForeignPtr :: Vector a -> (ForeignPtr a, Int, Int)
# INLINE unsafeToForeignPtr #
unsafeToForeignPtr (Vector n fp) = (fp, 0, n)

unsafeToForeignPtr0 :: Vector a -> (ForeignPtr a, Int)
# INLINE unsafeToForeignPtr0 #
unsafeToForeignPtr0 (Vector n fp) = (fp, n)

  | Pass a pointer to the vector 's data to the IO action . The data may not be
unsafeWith :: Storable a => Vector a -> (Ptr a -> IO b) -> IO b
# INLINE unsafeWith #
unsafeWith (Vector _ fp) = withForeignPtr fp
