diff options
| author | Mikolaj Konarski <mikolaj.konarski@funktory.com> | 2026-01-06 11:30:56 +0100 |
|---|---|---|
| committer | Mikolaj Konarski <mikolaj.konarski@funktory.com> | 2026-02-12 10:00:13 +0100 |
| commit | 53cb4202d6749ab54fc7650292c9823008587722 (patch) | |
| tree | f8a7434d1b370cc8566dcd466af3bc87e198ad03 /src | |
| parent | d4352fdcecacd204b52e1c1a3646633e963e5490 (diff) | |
Document that mshapeTree is partialHEADmild-tweaks-repackagedmaster
Diffstat (limited to 'src')
| -rw-r--r-- | src/Data/Array/Nested/Mixed.hs | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/src/Data/Array/Nested/Mixed.hs b/src/Data/Array/Nested/Mixed.hs index eb05eaa..99aef8d 100644 --- a/src/Data/Array/Nested/Mixed.hs +++ b/src/Data/Array/Nested/Mixed.hs @@ -355,6 +355,9 @@ class Elt a where -- | Tree giving the shape of every array component. type ShapeTree a + -- | Produces an internal representation of a tree of shapes of (potentially) + -- nested arrays. If the argument is an array, it requires that the array + -- is not empty (otherwise, its' guaranteed to crash early, if non-trivial). mshapeTree :: a -> ShapeTree a mshapeTreeEq :: Proxy a -> ShapeTree a -> ShapeTree a -> Bool @@ -676,6 +679,7 @@ instance Elt a => Elt (Mixed sh' a) where type ShapeTree (Mixed sh' a) = (IShX sh', ShapeTree a) + -- This requires that @arr@ is not empty. mshapeTree :: Mixed sh' a -> ShapeTree (Mixed sh' a) mshapeTree arr = (mshape arr, mshapeTree (mindex arr (ixxZero (ssxFromShX (mshape arr))))) |