@@ -1,11 +1,10 @@
1−{-# OPTIONS_GHC -Wno-missing-export-lists #-}
2−
31{-# LANGUAGE AllowAmbiguousTypes #-}
42{-# LANGUAGE BangPatterns #-}
53{-# LANGUAGE CPP #-}
64{-# LANGUAGE DataKinds #-}
75{-# LANGUAGE GADTs #-}
86{-# LANGUAGE InstanceSigs #-}
7+{-# LANGUAGE KindSignatures #-}
98{-# LANGUAGE MagicHash #-}
109{-# LANGUAGE PolyKinds #-}
1110{-# LANGUAGE Rank2Types #-}
@@ -19,12 +18,7 @@
1918
2019-- {-# OPTIONS_GHC -ddump-simpl -dsuppress-idinfo -dsuppress-coercions -dsuppress-type-applications -dsuppress-uniques -dsuppress-module-prefixes #-}
2120
22−{- |
23−Copyright: (c) 2017-2020 Kowainik
24−SPDX-License-Identifier: MPL-2.0
25−Maintainer: Kowainik <xrom.xkov@gmail.com>
26−
27−Internal API for 'TypeRepMap' and operations on it. The functions here do
21+{- | Internal API for 'TypeRepMap' and operations on it. The functions here do
2822not have any stability guarantees and can change between minor versions.
2923
3024If you need to use this module for purposes other than tests,
@@ -45,9 +39,9 @@ import Data.Kind (Type)
4539import Data.Type.Equality ((:~:) (..), TestEquality (..))
4640import Data.List (intercalate, nubBy)
4741import Data.Maybe (fromMaybe)
48−import Data.Primitive.Array (Array, MutableArray, indexArray, mapArray', sizeofArray,
42+import Data.Primitive.Array (Array, MutableArray, indexArray, mapArray', readArray, sizeofArray,
4943 thawArray, unsafeFreezeArray, writeArray)
50−import Data.Primitive.PrimArray (writePrimArray, newPrimArray, unsafeFreezePrimArray, primArrayToList, MutablePrimArray, primArrayFromListN, PrimArray, indexPrimArray, sizeofPrimArray)
44+import Data.Primitive.PrimArray (PrimArray, indexPrimArray, sizeofPrimArray)
5145import Data.Semigroup (Semigroup (..), All(..))
5246import GHC.Base (Any, Int (..), Int#, (*#), (+#), (<#))
5347import GHC.Exts (IsList (..), inline, sortWith)
@@ -64,6 +58,7 @@ import Type.Reflection (SomeTypeRep (..), TypeRep, Typeable, typeRep, withTypeab
6458import Type.Reflection.Unsafe (typeRepFingerprint)
6559import Unsafe.Coerce (unsafeCoerce)
6660
61+import qualified Data.Map.Strict as Map
6762import qualified GHC.Exts as GHC (fromList, toList)
6863
6964{- |
@@ -169,49 +164,33 @@ prop> member @a (one (x :: f a)) == True
169164
170165-}
171166one :: forall a f . Typeable a => f a -> TypeRepMap f
172−one x = TypeRepMap (primArrayFromListN 1 [fa])
173− (primArrayFromListN 1 [fb])
174− (pure @Array v)
175− (pure @Array k)
176− where
177− (Fingerprint fa fb, v, k) = (calcFp @a, toAny x, unsafeCoerce $ typeRep @a)
167+one x = insert x empty
178168{-# INLINE one #-}
179169
180170{- |
181171
182172Insert a value into a 'TypeRepMap'.
183−TypeRepMap optimizes for fast reads rather than inserts, as a trade-off inserts are @O(n)@.
184173
185174prop> size (insert v tm) >= size tm
186175prop> member @a (insert (x :: f a) tm) == True
187176
188177-}
189178insert :: forall a f . Typeable a => f a -> TypeRepMap f -> TypeRepMap f
190−insert x m
191− | size m == 0 = one x
192− | otherwise = case cachedBinarySearch (typeFp @a) (fingerprintAs m) (fingerprintBs m) of
193− Nothing -> union m $ one x
194− Just i -> m {trAnys = changeAnyArr i (trAnys m)}
179+insert x = fromTriples . addX . toTriples
195180 where
196− changeAnyArr :: Int -> Array Any -> Array Any
197− changeAnyArr i trAs = runST $ do
198− let n = sizeofArray trAs
199− mutArr <- thawArray trAs 0 n
200− writeArray mutArr i $ toAny x
201− unsafeFreezeArray mutArr
181+ tripleX :: (Fingerprint, Any, Any)
182+ tripleX@(fpX, _, _) = (calcFp @a, toAny x, unsafeCoerce $ typeRep @a)
183+
184+ addX :: [(Fingerprint, Any, Any)] -> [(Fingerprint, Any, Any)]
185+ addX l = tripleX : deleteByFst fpX l
202186{-# INLINE insert #-}
203187
204188-- Extract the kind of a type. We use it to work around lack of syntax for
205189-- inferred type variables (which are not subject to type applications).
206190type KindOf (a :: k) = k
207191
208−type ArgKindOf (f :: k -> l) = k
209−
210192{- | Delete a value from a 'TypeRepMap'.
211193
212−TypeRepMap optimizes for fast reads rather than modifications, as a trade-off deletes are
213−@O(n)@, with an @O(log(n))@ optimization for when the element is already missing.
214−
215194prop> size (delete @a tm) <= size tm
216195prop> member @a (delete @a tm) == False
217196
@@ -224,60 +203,30 @@ False
224203True
225204-}
226205delete :: forall a (f :: KindOf a -> Type) . Typeable a => TypeRepMap f -> TypeRepMap f
227−delete m
228− -- Lookups are fast, so check if we even have the element first.
229− | not (member @a m) = m
230− -- We know we have the element, If the map has exactly one element, we can return the empty map
231− | size m == 1 = empty
232− -- Otherwise, filter out the element in linear time.
233− | otherwise = fromSortedTriples . deleteFirst ((== typeFp @a) . fst3) . toSortedTriples $ m
206+delete = fromTriples . deleteByFst (typeFp @a) . toTriples
234207{-# INLINE delete #-}
235208
236−deleteFirst :: (a -> Bool) -> [a] -> [a]
237−deleteFirst _ [] = []
238−deleteFirst p (x : xs) = if p x then xs else x : deleteFirst p xs
239−
240209{- |
241−Update a value at a specific key with the result of the provided function.
242−When the key is not a member of the map, the original map is returned.
210+Update a value at a specific key with the result of the provided function. When
211+the key is not a member of the map, the original map is returned.
243212
244213>>> trmap = fromList @(TypeRepMap Identity) [WrapTypeable $ Identity "a"]
245214>>> lookup @String $ adjust (fmap (++ "ww")) trmap
246215Just (Identity "aww")
247216-}
248217adjust :: forall a f . Typeable a => (f a -> f a) -> TypeRepMap f -> TypeRepMap f
249−adjust fun = alter (fmap fun)
250−{-# INLINE adjust #-}
251−
252−{- |
253−Updates a value at a specific key, whether or not it exists.
254−This can be used to insert, delete, or update a value of a given type in the map.
255−
256−>>> func = (\case Nothing -> Just (Identity "new"); Just (Identity s) -> Just (Identity (reverse s)))
257−>>> lookup @String $ alter func empty
258−Just (Identity "new")
259−>>> trmap = fromList @(TypeRepMap Identity) [WrapTypeable $ Identity "helllo"]
260−>>> lookup @String $ alter func trmap
261−>>> Just (Identity "olleh")
262−-}
263−alter :: forall a f . Typeable a => (Maybe (f a) -> Maybe (f a)) -> TypeRepMap f -> TypeRepMap f
264−alter fun tr = case cachedBinarySearch (typeFp @a) (fingerprintAs tr) (fingerprintBs tr) of
265− Nothing ->
266− case (fun Nothing) of
267− Nothing -> tr
268− Just v -> insert v tr
269− Just i ->
270− case fun (Just . fromAny $ indexArray (trAnys tr) i) of
271− Nothing -> delete @a tr
272− Just v -> tr{trAnys = replaceAnyAt i (toAny v) (trAnys tr)}
218+adjust fun tr = case cachedBinarySearch (typeFp @a) (fingerprintAs tr) (fingerprintBs tr) of
219+ Nothing -> tr
220+ Just i -> tr {trAnys = changeAnyArr i (trAnys tr)}
273221 where
274− replaceAnyAt :: Int -> Any -> Array Any -> Array Any
275− replaceAnyAt i v trAs = runST $ do
222+ changeAnyArr :: Int -> Array Any -> Array Any
223+ changeAnyArr i trAs = runST $ do
276224 let n = sizeofArray trAs
277225 mutArr <- thawArray trAs 0 n
278− writeArray mutArr i v
226+ a <- toAny . fun . fromAny <$> readArray mutArr i
227+ writeArray mutArr i a
279228 unsafeFreezeArray mutArr
280−{-# INLINE alter #-}
229+{-# INLINE adjust #-}
281230
282231{- | Map over the elements of a 'TypeRepMap'.
283232
@@ -311,89 +260,33 @@ hoistWithKey f (TypeRepMap as bs ans ks) = TypeRepMap as bs newAns ks
311260 withTr t = withTypeable t f
312261{-# INLINE hoistWithKey #-}
313262
314−-- | The union of two 'TypeRepMap's using a combining function for conflicting entries. @O(n + m)@
263+-- | The union of two 'TypeRepMap's using a combining function.
315264unionWith :: forall f. (forall x. Typeable x => f x -> f x -> f x) -> TypeRepMap f -> TypeRepMap f -> TypeRepMap f
316−unionWith f ma mb = do
317− fromSortedTriples $ mergeMaps (toSortedTriples ma) (toSortedTriples mb)
265+unionWith f m1 m2 = fromTriples
266+ $ toTripleList
267+ $ Map.unionWith combine
268+ (fromTripleList $ toTriples m1)
269+ (fromTripleList $ toTriples m2)
318270 where
319271 f' :: forall x. TypeRep x -> f x -> f x -> f x
320272 f' tr = withTypeable tr f
321273
322− combine :: (Fingerprint, Any, Any) -> (Fingerprint, Any, Any) -> (Fingerprint, Any, Any)
323− combine (fp, av, ak) (_, bv, _) = (fp, toAny $ f' (fromAny ak) (fromAny av) (fromAny bv), ak)
324−
325− -- Merges two typrepmaps into a sorted, dedup'd list of triples.
326− -- Using 'toSortedTriples' allows us to assume the triples are sorted by fingerprint,
327− -- Given O(n) performance from 'toSortedTriples', and given that we can merge-sort in
328− -- O(n + m) time, then can '.fromSortedTriples' back into cachedBinarySearch order in O(n + m)
329− -- that gives a total of O(n + m).
330− mergeMaps :: [(Fingerprint, Any, Any)] -> [(Fingerprint, Any, Any)] -> [(Fingerprint, Any, Any)]
331− -- We've addressed all elements from both maps
332− mergeMaps as [] = as
333− mergeMaps [] bs = bs
334− -- Merge
335− mergeMaps (a@(af, _, _) : as) (b@(bf, _, _) : bs) =
336− case compare af bf of
337− -- Fingerprints are equal, union the elements using our function
338− -- If the incoming maps were de-duped, there shouldn't be any other equivalent
339− -- fingerprints
340− EQ -> combine a b : mergeMaps as bs
341− -- First fingerprint must not be in the second map or we would have seen it by now
342− -- Add it to the result as-is
343− LT -> a : mergeMaps as (b : bs)
344− -- Second fingerprint must not be in the first map or we would have seen it by now
345− -- Add it to the result as-is
346− GT -> b : mergeMaps (a:as) bs
274+ combine :: (Any, Any) -> (Any, Any) -> (Any, Any)
275+ combine (av, ak) (bv, _) = (toAny $ f' (fromAny ak) (fromAny av) (fromAny bv), ak)
276+
277+ fromTripleList :: Ord a => [(a, b, c)] -> Map.Map a (b, c)
278+ fromTripleList = Map.fromList . map (\(a, b, c) -> (a, (b, c)))
279+
280+ toTripleList :: Map.Map a (b, c) -> [(a, b, c)]
281+ toTripleList = map (\(a, (b, c)) -> (a, b, c)) . Map.toList
347282{-# INLINE unionWith #-}
348283
349−-- | The (left-biased) union of two 'TypeRepMap's in @O(n + m)@. It prefers the first map when
284+-- | The (left-biased) union of two 'TypeRepMap's. It prefers the first map when
350285-- duplicate keys are encountered, i.e. @'union' == 'unionWith' const@.
351286union :: TypeRepMap f -> TypeRepMap f -> TypeRepMap f
352287union = unionWith const
353288{-# INLINE union #-}
354289
355−-- | The 'intersection' of two 'TypeRepMap's using a combining function
356−--
357−-- @O(n + m)@
358−intersectionWith :: forall f. (forall x. Typeable x => f x -> f x -> f x) -> TypeRepMap f -> TypeRepMap f -> TypeRepMap f
359−intersectionWith f ma mb =
360− fromSortedTriples $ mergeMaps (toSortedTriples ma) (toSortedTriples mb)
361− where
362− f' :: forall x. TypeRep x -> f x -> f x -> f x
363− f' tr = withTypeable tr f
364−
365− combine :: (Fingerprint, Any, Any) -> (Fingerprint, Any, Any) -> (Fingerprint, Any, Any)
366− combine (fp, av, ak) (_, bv, _) = (fp, toAny $ f' (fromAny ak) (fromAny av) (fromAny bv), ak)
367−
368− -- Merges two typrepmaps into a sorted, dedup'd list of triples.
369− mergeMaps :: [(Fingerprint, Any, Any)] -> [(Fingerprint, Any, Any)] -> [(Fingerprint, Any, Any)]
370− -- If either list is empty, the intersection must be finished.
371− mergeMaps _ [] = []
372− mergeMaps [] _ = []
373− -- Merge the two maps considering one element at a time.
374− mergeMaps (a@(af, _, _) : as) (b@(bf, _, _) : bs) =
375− case compare af bf of
376− -- Fingerprints are equal, union the elements using our function
377− -- If the incoming maps were de-duped, there shouldn't be any other equivalent
378− -- fingerprints
379− EQ -> combine a b : mergeMaps as bs
380− -- First fingerprint must not be in the second map or we would have seen it by now
381− -- Skip it an move on
382− LT -> mergeMaps as (b : bs)
383− -- Second fingerprint must not be in the first map or we would have seen it by now
384− -- Skip it an move on
385− GT -> mergeMaps (a:as) bs
386−{-# INLINE intersectionWith #-}
387−
388−-- | The intersection of two 'TypeRepMap's.
389−-- It keeps all values from the first map whose keys are present in the second.
390−--
391−-- @O(n + m)@
392−intersection :: TypeRepMap f -> TypeRepMap f -> TypeRepMap f
393−intersection = intersectionWith const
394−{-# INLINE intersection #-}
395−
396−
397290{- | Check if a value of the given type is present in a 'TypeRepMap'.
398291
399292>>> member @Char $ one (Identity 'a')
@@ -429,22 +322,9 @@ size = sizeofPrimArray . fingerprintAs
429322
430323-- | Return the list of 'SomeTypeRep' from the keys.
431324keys :: TypeRepMap f -> [SomeTypeRep]
432−keys = keysWith SomeTypeRep
325+keys TypeRepMap{..} = SomeTypeRep . anyToTypeRep <$> toList trKeys
433326{-# INLINE keys #-}
434327
435−-- | Return the list of keys by wrapping them with a user-provided function.
436−keysWith :: (forall (a :: ArgKindOf f). TypeRep a -> r) -> TypeRepMap f -> [r]
437−keysWith f TypeRepMap{..} = f . anyToTypeRep <$> toList trKeys
438−{-# INLINE keysWith #-}
439−
440−-- | Return the list of key-value pairs by wrapping them with a user-provided function.
441−toListWith :: forall f r. (forall (a :: ArgKindOf f). Typeable a => f a -> r) -> TypeRepMap f -> [r]
442−toListWith f = map toF . toTriples
443− where
444− withTypeRep :: TypeRep a -> f a -> r
445− withTypeRep tr an = withTypeable tr $ f an
446− toF (_, an, k) = withTypeRep (unsafeCoerce k) (fromAny an)
447−
448328-- | Binary searched based on this article
449329-- http://bannalia.blogspot.com/2015/06/cache-friendly-binary-search.html
450330-- with modification for our two-vector search case.
@@ -488,20 +368,8 @@ typeFp = typeRepFingerprint $ typeRep @a
488368toTriples :: TypeRepMap f -> [(Fingerprint, Any, Any)]
489369toTriples tm = zip3 (toFingerprints tm) (GHC.toList $ trAnys tm) (GHC.toList $ trKeys tm)
490370
491−-- | Efficiently get sorted triples from a map in O(n) time
492−--
493−-- We assume the incoming TypeRepMap is already sorted into 'cachedBinarySearch' order using fromSortedList.
494−-- Then we can construct the index mapping from the "cached" ordering into monotonically
495−-- increasing order using 'generateOrderMapping' with the length of the TRM. This takes @O(n).
496−-- We then pull those indexes from the source TRM to get the sorted triples in a total of @O(n).
497−toSortedTriples :: TypeRepMap f -> [(Fingerprint, Any, Any)]
498−toSortedTriples tm = trip <$> ordering
499− where
500− trip i = ( Fingerprint (indexPrimArray (fingerprintAs tm) i) (indexPrimArray (fingerprintBs tm) i)
501− , indexArray (trAnys tm) i
502− , indexArray (trKeys tm) i)
503− ordering :: [ Int ]
504− ordering = generateOrderMapping (size tm)
371+deleteByFst :: Eq a => a -> [(a, b, c)] -> [(a, b, c)]
372+deleteByFst x = filter ((/= x) . fst3)
505373
506374nubByFst :: (Eq a) => [(a, b, c)] -> [(a, b, c)]
507375nubByFst = nubBy ((==) `on` fst3)
@@ -521,6 +389,9 @@ data WrapTypeable f where
521389instance Show (WrapTypeable f) where
522390 show (WrapTypeable (_ :: f a)) = show $ calcFp @a
523391
392+wrapTypeable :: TypeRep a -> f a -> WrapTypeable f
393+wrapTypeable tr = withTypeable tr WrapTypeable
394+
524395{- |
525396
526397prop> fromList . toList == 'id'
@@ -548,19 +419,19 @@ instance IsList (TypeRepMap f) where
548419 k (WrapTypeable (_ :: f a)) = unsafeCoerce $ typeRep @a
549420
550421 toList :: TypeRepMap f -> [WrapTypeable f]
551− toList = toListWith WrapTypeable
422+ toList = map toWrapTypeable . toTriples
423+ where
424+ toWrapTypeable :: (Fingerprint, Any, Any) -> WrapTypeable f
425+ toWrapTypeable (_, an, k) = wrapTypeable (unsafeCoerce k) (fromAny an)
552426
553427calcFp :: forall a . Typeable a => Fingerprint
554428calcFp = typeRepFingerprint $ typeRep @a
555429
556430fromTriples :: [(Fingerprint, Any, Any)] -> TypeRepMap f
557−fromTriples = fromSortedTriples . sortWith fst3 . nubByFst
558−
559−fromSortedTriples :: [(Fingerprint, Any, Any)] -> TypeRepMap f
560−fromSortedTriples kvs = TypeRepMap (GHC.fromList fpAs) (GHC.fromList fpBs) (GHC.fromList ans) (GHC.fromList ks)
431+fromTriples kvs = TypeRepMap (GHC.fromList fpAs) (GHC.fromList fpBs) (GHC.fromList ans) (GHC.fromList ks)
561432 where
562433 (fpAs, fpBs) = unzip $ map (\(Fingerprint a b) -> (a, b)) fps
563− (fps, ans, ks) = unzip3 $ fromSortedList kvs
434+ (fps, ans, ks) = unzip3 $ fromSortedList $ sortWith fst3 $ nubByFst kvs
564435
565436----------------------------------------------------------------------------
566437-- Tree-like conversion
@@ -587,42 +458,18 @@ fromSortedList l = runST $ do
587458 writeArray result i (indexArray origin newFirst)
588459 loop (2 * i + 2) (newFirst + 1)
589460
590−-- Returns a list of indexes which represents the "sorted" order of an array generated by
591−-- fromSortedList of the provided length.
592−-- I.e. fmap (fromSortedList [1, 2, 3, 4, 5, 6] !!) (generateOrderMapping 6) == [1, 2, 3, 4, 5, 6]
593−--
594−-- >>> generateOrderMapping 6
595−-- [3,1,4,0,5,2]
596−--
597−-- >>> generateOrderMapping 8
598−-- [7,3,1,4,0,5,2,6]
599−generateOrderMapping :: Int -> [Int]
600−generateOrderMapping len = runST $ do
601− orderMappingArr <- newPrimArray len
602− _ <- loop orderMappingArr 0 0
603− primArrayToList <$> unsafeFreezePrimArray orderMappingArr
604− where
605− loop :: MutablePrimArray s Int -> Int -> Int -> ST s Int
606− loop result i first =
607− if i >= len
608− then pure first
609− else do
610− newFirst <- loop result (2 * i + 1) first
611− writePrimArray result newFirst i
612− loop result (2 * i + 2) (newFirst + 1)
613−
614461----------------------------------------------------------------------------
615462-- Helper functions.
616463----------------------------------------------------------------------------
617464
618−-- | Check that invariant of the structure holds.
465+-- | Check that invariant of the structure is hold.
619466-- The structure maintains the following invariant.
620467-- For each element @A@ at index @i@:
621468--
622−-- 1. if there is an element @B@ at index @2*i+1@,
469+-- 1. if there is an element @B@ at index @2*i+1@,
623470-- then @B < A@.
624471--
625−-- 2. if there is an element @C@ at index @2*i+2@,
472+-- 2. if there is an element @C@ at index @2*i+2@,
626473-- then @A < C@.
627474--
628475invariantCheck :: TypeRepMap f -> Bool
@@ -668,3 +515,4 @@ invariantCheck TypeRepMap{..} = getAll (check 0)
668515 , All $ fromMaybe True $ (<=) <$> leftMax <*> rightMin
669516 , check (i+1)
670517 ]
518+