aboutsummaryrefslogtreecommitdiff
path: root/src/Data/Array/Nested
diff options
context:
space:
mode:
authorTom Smeding <tom@tomsmeding.com>2025-12-12 23:19:11 +0100
committerTom Smeding <tom@tomsmeding.com>2025-12-12 23:19:11 +0100
commit6de015d8f2a82d5264804f3862892393c0d8d38d (patch)
tree0c47ec59e9f3ba2b7b3ac356ea918a4a471fa2bb /src/Data/Array/Nested
parent1a55b8d50399e9506b07cf9bc6462c32b6a5d38a (diff)
Improve haddocks of mvecsUnsafeFreeze
Diffstat (limited to 'src/Data/Array/Nested')
-rw-r--r--src/Data/Array/Nested/Mixed.hs4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/Data/Array/Nested/Mixed.hs b/src/Data/Array/Nested/Mixed.hs
index 6b96a15..54b2a9f 100644
--- a/src/Data/Array/Nested/Mixed.hs
+++ b/src/Data/Array/Nested/Mixed.hs
@@ -378,7 +378,9 @@ class Elt a where
-- | Given the shape of this array, finalise the vectors into 'XArray's.
mvecsFreeze :: IShX sh -> MixedVecs s sh a -> ST s (Mixed sh a)
- -- | Given the shape of this array, finalise the vectors into 'XArray's.
+ -- | 'mvecsFreeze' but without copying the mutable vectors before freezing
+ -- them. If the mutable vectors are mutated after this function, referential
+ -- transparency is broken.
mvecsUnsafeFreeze :: IShX sh -> MixedVecs s sh a -> ST s (Mixed sh a)
-- | Element types for which we have evidence of the (static part of the) shape