Eq and Ord instances
[darcs-mirrors/vector.git] / Data / Vector / IVector.hs
index d3b4c2f..e3e0370 100644 (file)
@@ -23,14 +23,26 @@ module Data.Vector.IVector (
   -- * Construction
   empty, singleton, cons, snoc, replicate, (++),
 
+  -- * Accessing individual elements
+  (!), head, last,
+
   -- * Subvectors
-  slice, takeSlice, take, dropSlice, drop,
+  slice, extract, takeSlice, take, dropSlice, drop,
+
+  -- * Permutations
+  (//),
 
   -- * Mapping and zipping
   map, zipWith,
 
+  -- * Comparisons
+  eq, cmp,
+
   -- * Filtering
-  filter, takeWhile, dropWhile,
+  filter, takeWhileSlice, takeWhile, dropWhileSlice, dropWhile,
+
+  -- * Searching
+  elem, notElem, find, findIndex,
 
   -- * Folding
   foldl, foldl1, foldl', foldl1', foldr, foldr1,
@@ -42,15 +54,21 @@ module Data.Vector.IVector (
   stream, unstream,
 
   -- * MVector-based initialisation
-  create,
+  new,
 
   -- * Unsafe functions
-  unsafeSlice, unsafeIndex
+  unsafeSlice, unsafeIndex,
+
+  -- * Utility functions
+  vlength, vnew
 ) where
 
 import qualified Data.Vector.MVector as MVector
 import           Data.Vector.MVector ( MVector )
 
+import qualified Data.Vector.MVector.Mut as Mut
+import           Data.Vector.MVector.Mut ( Mut )
+
 import qualified Data.Vector.Stream as Stream
 import           Data.Vector.Stream ( Stream )
 import           Data.Vector.Stream.Size
@@ -63,17 +81,17 @@ import Prelude hiding ( length,
                         init, tail, take, drop,
                         map, zipWith,
                         filter, takeWhile, dropWhile,
+                        elem, notElem,
                         foldl, foldl1, foldr, foldr1 )
 
--- | Class of immutable vectors. Just like with 'MVector', the type of the
--- elements can be restricted by using GADTs.
+-- | Class of immutable vectors.
 --
 class IVector v a where
-  -- | Construct a pure vector from a monadic initialiser.
-  create       :: (forall mv m. MVector mv m a => m (mv m a)) -> v a
+  -- | Construct a pure vector from a monadic initialiser (not fusible!)
+  vnew         :: (forall mv m. MVector mv m a => m (mv a)) -> v a
 
-  -- | Length of the vector
-  length       :: v a -> Int
+  -- | Length of the vector (not fusible!)
+  vlength      :: v a -> Int
 
   -- | Yield a part of the vector without copying it. No range checks!
   unsafeSlice  :: v a -> Int -> Int -> v a
@@ -99,6 +117,14 @@ class IVector v a where
   --
   unsafeIndex  :: v a -> Int -> (a -> b) -> b
 
+-- Fusion
+-- ------
+
+-- | Construct a pure vector from a monadic initialiser 
+new :: IVector v a => Mut a -> v a
+{-# INLINE_STREAM new #-}
+new m = vnew (Mut.run m)
+
 -- | Convert a vector to a 'Stream'
 stream :: IVector v a => v a -> Stream a
 {-# INLINE_STREAM stream #-}
@@ -112,16 +138,33 @@ stream v = v `seq` (Stream.unfold get 0 `Stream.sized` Exact n)
 
 -- | Create a vector from a 'Stream'
 unstream :: IVector v a => Stream a -> v a
-{-# INLINE_STREAM unstream #-}
-unstream s = create (MVector.unstream s)
+{-# INLINE unstream #-}
+unstream s = new (Mut.unstream s)
 
 {-# RULES
 
-"stream/unstream [Vector.IVector]" forall s.
-  stream (unstream s) = s
+"stream/unstream [IVector]" forall s.
+  stream (new (Mut.unstream s)) = s
+
+"Mut.unstream/stream/new [IVector]" forall p.
+  Mut.unstream (stream (new p)) = p
 
  #-}
 
+-- Length
+-- ------
+
+length :: IVector v a => v a -> Int
+{-# INLINE_STREAM length #-}
+length v = vlength v
+
+{-# RULES
+
+"length/unstream [IVector]" forall s.
+  length (new (Mut.unstream s)) = Stream.length s
+
+  #-}
+
 -- Construction
 -- ------------
 
@@ -156,6 +199,38 @@ infixr 5 ++
 {-# INLINE (++) #-}
 v ++ w = unstream (stream v Stream.++ stream w)
 
+-- Accessing individual elements
+-- -----------------------------
+
+-- | Indexing
+(!) :: IVector v a => v a -> Int -> a
+{-# INLINE_STREAM (!) #-}
+v ! i = assert (i >= 0 && i < length v)
+      $ unsafeIndex v i id
+
+-- | First element
+head :: IVector v a => v a -> a
+{-# INLINE_STREAM head #-}
+head v = v ! 0
+
+-- | Last element
+last :: IVector v a => v a -> a
+{-# INLINE_STREAM last #-}
+last v = v ! (length v - 1)
+
+{-# RULES
+
+"(!)/unstream [IVector]" forall i s.
+  new (Mut.unstream s) ! i = s Stream.!! i
+
+"head/unstream [IVector]" forall s.
+  head (new (Mut.unstream s)) = Stream.head s
+
+"last/unstream [IVector]" forall s.
+  last (new (Mut.unstream s)) = Stream.last s
+
+ #-}
+
 -- Subarrays
 -- ---------
 
@@ -168,6 +243,13 @@ slice :: IVector v a => v a -> Int   -- ^ starting index
 slice v i n = assert (i >= 0 && n >= 0  && i+n <= length v)
             $ unsafeSlice v i n
 
+-- | Copy @n@ elements starting at the given position to a new vector.
+extract :: IVector v a => v a -> Int  -- ^ starting index
+                              -> Int  -- ^ length
+                              -> v a
+{-# INLINE extract #-}
+extract v i n = unstream (Stream.extract (stream v) i n)
+
 -- | Yield the first @n@ elements without copying.
 takeSlice :: IVector v a => Int -> v a -> v a
 {-# INLINE takeSlice #-}
@@ -188,6 +270,27 @@ drop :: IVector v a => Int -> v a -> v a
 {-# INLINE drop #-}
 drop n = unstream . Stream.drop n . stream
 
+{-# RULES
+
+"slice/extract [IVector]" forall i n s.
+  slice (new (Mut.unstream s)) i n = extract (new (Mut.unstream s)) i n
+
+"takeSlice/unstream [IVector]" forall n s.
+  takeSlice n (new (Mut.unstream s)) = take n (new (Mut.unstream s))
+
+"dropSlice/unstream [IVector]" forall n s.
+  dropSlice n (new (Mut.unstream s)) = drop n (new (Mut.unstream s))
+
+  #-}
+
+-- Permutations
+-- ------------
+
+(//) :: IVector v a => v a -> [(Int, a)] -> v a
+{-# INLINE (//) #-}
+v // us = new (Mut.update (Mut.unstream (stream v))
+                          (Stream.fromList us))
+
 -- Mapping/zipping
 -- ---------------
 
@@ -196,11 +299,29 @@ map :: (IVector v a, IVector v b) => (a -> b) -> v a -> v b
 {-# INLINE map #-}
 map f = unstream . Stream.map f . stream
 
+{-# RULES
+
+"in-place map [IVector]" forall f m.
+  Mut.unstream (Stream.map f (stream (new m))) = Mut.map f m
+
+  #-}
+
 -- | Zip two vectors with the given function.
 zipWith :: (IVector v a, IVector v b, IVector v c) => (a -> b -> c) -> v a -> v b -> v c
 {-# INLINE zipWith #-}
 zipWith f xs ys = unstream (Stream.zipWith f (stream xs) (stream ys))
 
+-- Comparisons
+-- -----------
+
+eq :: (IVector v a, Eq a) => v a -> v a -> Bool
+{-# INLINE eq #-}
+xs `eq` ys = stream xs == stream ys
+
+cmp :: (IVector v a, Ord a) => v a -> v a -> Ordering
+{-# INLINE cmp #-}
+cmp xs ys = compare (stream xs) (stream ys)
+
 -- Filtering
 -- ---------
 
@@ -209,18 +330,71 @@ filter :: IVector v a => (a -> Bool) -> v a -> v a
 {-# INLINE filter #-}
 filter f = unstream . Stream.filter f . stream
 
+-- | Yield the longest prefix of elements satisfying the predicate without
+-- copying.
+takeWhileSlice :: IVector v a => (a -> Bool) -> v a -> v a
+{-# INLINE takeWhileSlice #-}
+takeWhileSlice f v = case findIndex (not . f) v of
+                       Just n  -> takeSlice n v
+                       Nothing -> v
+
 -- | Copy the longest prefix of elements satisfying the predicate to a new
 -- vector
 takeWhile :: IVector v a => (a -> Bool) -> v a -> v a
 {-# INLINE takeWhile #-}
 takeWhile f = unstream . Stream.takeWhile f . stream
 
+-- | Drop the longest prefix of elements that satisfy the predicate without
+-- copying
+dropWhileSlice :: IVector v a => (a -> Bool) -> v a -> v a
+{-# INLINE dropWhileSlice #-}
+dropWhileSlice f v = case findIndex (not . f) v of
+                       Just n  -> dropSlice n v
+                       Nothing -> v
+
 -- | Drop the longest prefix of elements that satisfy the predicate and copy
 -- the rest to a new vector.
 dropWhile :: IVector v a => (a -> Bool) -> v a -> v a
 {-# INLINE dropWhile #-}
 dropWhile f = unstream . Stream.dropWhile f . stream
 
+{-# RULES
+
+"takeWhileSlice/unstream" forall f s.
+  takeWhileSlice f (new (Mut.unstream s)) = takeWhile f (new (Mut.unstream s))
+
+"dropWhileSlice/unstream" forall f s.
+  dropWhileSlice f (new (Mut.unstream s)) = dropWhile f (new (Mut.unstream s))
+
+ #-}
+
+-- Searching
+-- ---------
+
+infix 4 `elem`
+-- | Check whether the vector contains an element
+elem :: (IVector v a, Eq a) => a -> v a -> Bool
+{-# INLINE elem #-}
+elem x = Stream.elem x . stream
+
+infix 4 `notElem`
+-- | Inverse of `elem`
+notElem :: (IVector v a, Eq a) => a -> v a -> Bool
+{-# INLINE notElem #-}
+notElem x = Stream.notElem x . stream
+
+-- | Yield 'Just' the first element matching the predicate or 'Nothing' if no
+-- such element exists.
+find :: IVector v a => (a -> Bool) -> v a -> Maybe a
+{-# INLINE find #-}
+find f = Stream.find f . stream
+
+-- | Yield 'Just' the index of the first element matching the predicate or
+-- 'Nothing' if no such element exists.
+findIndex :: IVector v a => (a -> Bool) -> v a -> Maybe Int
+{-# INLINE findIndex #-}
+findIndex f = Stream.findIndex f . stream
+
 -- Folding
 -- -------