<div dir="auto"><div>Well, the primary difference between putting it in primitive and putting it in array is that the primitive library is unsafe, and knows it's unsafe, and puts its functions like "unsafeFreezeArray" right out there in the open. Thus, you can write functions like that which traverse over a return value yourself. The primary reason that "runArray" is in the primitive library is that it directly unboxes the pointer to the array, passes it out of the ST monad, and then boxes it up again, so that pattern matches can see it; you don't get that advantage when you are returning a Traversable with Arrays inside it.<div dir="auto"><br></div><div dir="auto">The array library is supposed to be safe, and Data.Array.ST.Safe exports only a limited set of functions for working with STArrays. The "unsafeFreezeSTArray" function isn't even in the public documentation; you can only learn it exists by looking at the un-Haddocked "Data.Array.Base" module, which definitely can't be imported by a Safe module.</div><div dir="auto"><br></div>Meanwhile, the runSTArrayTrav, runSTUArrayTrav, and runSTArrayWith functions are actually safe, because even though you "know" that the "tr" function is being run in the ST monad, there's no way to prove it to the compiler, and thus no way to get your hands on the unsafeFreezeSTArray and unsafeFreezeSTUArray functions and save them for later.</div><div dir="auto"><br></div><div dir="auto">On the other hand, we might want to change the "Applicative" constraint to a "Monad" constraint, so that you can turn (for instance) an STArray of STUArrays into an Array of UArrays:</div><div dir="auto"><br></div><div dir="auto">newtype STArrUArr i e s = STArrUArr (STArray s i (STUArray s i e))</div><div dir="auto"><br></div><div dir="auto">freezeSTArrUArr :: (Ix i, Monad m) => (forall i' e'. STArray s i' e' -> m (Array i' e')) -> (forall i' e'. STUArray s i' e' -> m (UArray i' e')) -> STArrUArr i e s -> m (Array i (UArray i e))</div><div dir="auto">freezeSTArrUArr frzA frzUA (STArrUArr ma) = frzA ma >>= traverse frzUA</div><div dir="auto"><br></div><div dir="auto">runArrUArr :: Ix i => (forall s. ST s (STArray s i (STUArray s i e))) -> Array i (UArray i e)</div><div dir="auto">runArrUArr m = runSTArrayWith freezeSTArrUArr (fmap STArrUArr m)<br><br><div class="gmail_quote" dir="auto"><div dir="ltr" class="gmail_attr">On Wed, Aug 21, 2019, 14:10 David Feuer <<a href="mailto:david.feuer@gmail.com">david.feuer@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="auto">Here's a link to that old PR:<div dir="auto"><br></div><div dir="auto"><a href="https://github.com/haskell/primitive/pull/109" target="_blank" rel="noreferrer">https://github.com/haskell/primitive/pull/109</a><br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Thu, Aug 22, 2019, 1:27 AM David Feuer <<a href="mailto:david.feuer@gmail.com" target="_blank" rel="noreferrer">david.feuer@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="auto"><div>I did some work on this sort of thing for primitive, which didn't want it. But maybe array does. If I don't link to it in the next day, please ping me.<br><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Thu, Aug 22, 2019, 1:25 AM Zemyla <<a href="mailto:zemyla@gmail.com" rel="noreferrer noreferrer" target="_blank">zemyla@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="auto">The "runSTArray" and "runSTUArray" functions allow efficiently working with Arrays in the ST monad before turning them immutable; however, they don't allow any way to return supplemental or alternative information with the array. There are many times when I've wanted to get an (Array i e, w) or a Maybe (UArray i e), but I couldn't, and had to use the far-more-inefficient freezeArray and hope it inlined properly.<div dir="auto"><br></div><div dir="auto">What I want are functions that generalize the return types given:</div><div dir="auto"><br></div><div dir="auto">runSTArrayTrav :: Traversable t => (forall s. ST s (t (STArray s i e))) -> t (Array i e)</div><div dir="auto">runSTArrayTrav m = runST $ m >>= traverse unsafeFreezeSTArray</div><div dir="auto"><br></div><div dir="auto">runSTUArrayTrav :: Traversable t => (forall s. ST s (t (STUArray s i e))) -> t (UArray i e)</div><div dir="auto">runSTUArrayTrav m = runST $ m >>= traverse unsafeFreezeSTUArray</div><div dir="auto"><br></div><div dir="auto">And then an even more generalized version, which takes a sort of Lens-like iterator, and allows returning multiple arrays of different kinds, types, and indices:</div><div dir="auto"><br></div><div dir="auto">runSTArrayWith :: (forall f s. Applicative f => (forall i e. STArray s i e -> f (Array i e)) -> (forall i e. STUArray s i e -> f (UArray i e)) -> u s -> f v) -> (forall s. ST s (u s)) -> v</div><div dir="auto">runSTArrayWith tr m = runST $ m >>= tr unsafeFreezeSTArray unsafeFreezeSTUArray</div><div dir="auto"><br></div><div dir="auto">The advantage of the runSTArrayTrav/runSTUArrayTrav functions, if they're subsets of the runSTArrayWith function, is that it works with standard things like (,) and Either, and doesn't require wrapping it in a newtype so that the s is at the end.</div><div dir="auto"><br></div><div dir="auto">The names of the functions are up for debate, and I know there will be one, because naming things is one of the two hard problems in computer science, along with cache invalidation and off-by-one errors.</div></div>
_______________________________________________<br>
Libraries mailing list<br>
<a href="mailto:Libraries@haskell.org" rel="noreferrer noreferrer noreferrer" target="_blank">Libraries@haskell.org</a><br>
<a href="http://mail.haskell.org/cgi-bin/mailman/listinfo/libraries" rel="noreferrer noreferrer noreferrer noreferrer" target="_blank">http://mail.haskell.org/cgi-bin/mailman/listinfo/libraries</a><br>
</blockquote></div></div></div>
</blockquote></div>
</blockquote></div></div></div>