aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorTom Smeding <tom@tomsmeding.com>2025-12-12 23:19:11 +0100
committerMikolaj Konarski <mikolaj.konarski@funktory.com>2026-01-31 10:41:29 +0100
commit2313ce8ff1ae791b1652f7942dc83c178240226a (patch)
treed9d4287b8dae1c84368e72d30749053797ca1272 /src
parentf80a2cd3a5718065950341a320689ea7810935ab (diff)
Improve haddocks of mvecsUnsafeFreeze
Diffstat (limited to 'src')
-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 8104931..cf62417 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