toki/numidr
1
0
Fork 0
Code Issues Pull requests Activity

Document LArray a bit more

Browse source
This commit is contained in:
Kiana Sheibani 2023-03-08 15:58:54 -05:00
parent 7be3544ce6
commit 3ca15ac2f6
Signed by: toki
GPG key ID: 6CB106C25E86A9F7
1 changed files with 22 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
src/Data/NumIdr/LArray.idr
View file

@ -7,22 +7,43 @@ import Data.NumIdr.Array
%default total
||| An array type that is guaranteed to be unique through linear types.
|||
||| This type can be used to operate on an array value without it being copied
||| on every mutation.
export
data LArray : Vect rk Nat -> Type -> Type where
MkLArray : (ord : Order) -> (sts : Vect rk Nat) ->
(s : Vect rk Nat) -> PrimArray a -> LArray s a
||| A vector that is guaranteed to be unique through linear types.
export
LVector : Nat -> Type -> Type
LVector n = LArray [n]
||| A matrix that is guaranteed to be unique through linear types.
export
LMatrix : (m, n : Nat) -> Type -> Type
LMatrix m n = LArray [m,n]
||| A matrix that is guaranteed to be unique through linear types.
export
LMatrix' : Nat -> Type -> Type
LMatrix' n = LArray [n,n]
thaw : Array s a -> LArray s a
thaw {s} arr with (viewShape arr)
_ | Shape s = MkLArray (getOrder arr) (strides arr) s (getPrim arr)
||| Freeze a linear array into an immutable array.
export
freeze : (1 _ : LArray s a) -> Array s a
freeze (MkLArray ord sts s arr) = unsafeMkArray ord sts s arr
--------------------------------------------------------------------------------
-- Constructor
-- Constructors
--------------------------------------------------------------------------------