easytensor-2.0.0.0: src/Numeric/DataFrame/Internal/Mutable.hs
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE ExistentialQuantification #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE MagicHash #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE PolyKinds #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE TypeOperators #-}
{-# LANGUAGE UnboxedTuples #-}
{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
-----------------------------------------------------------------------------
-- |
-- Module : Numeric.DataFrame.Internal.Mutable
-- Copyright : (c) Artem Chirkin
-- License : BSD3
--
-- Maintainer : chirkin@arch.ethz.ch
--
-- Interfrace to perform primitive stateful operations on mutable frames.
--
-----------------------------------------------------------------------------
module Numeric.DataFrame.Internal.Mutable
( MDataFrame ()
, newDataFrame#, newPinnedDataFrame#
, copyDataFrame#, copyMDataFrame#
, copyDataFrame'#, copyMDataFrame'#
, freezeDataFrame#, unsafeFreezeDataFrame#
, thawDataFrame#, thawPinDataFrame#, unsafeThawDataFrame#
, writeDataFrame#, writeDataFrameOff#
, readDataFrame#, readDataFrameOff#
, withDataFramePtr#, isDataFramePinned#
) where
import GHC.Base
import Numeric.DataFrame.Internal.PrimArray
import Numeric.DataFrame.Type
import Numeric.Dimensions
import Numeric.PrimBytes
-- | Mutable DataFrame type.
-- Keeps element offset, number of elements, and a mutable byte storage
data MDataFrame s t (ns :: [Nat])
= MDataFrame# Int# CumulDims (MutableByteArray# s)
-- | Create a new mutable DataFrame.
newDataFrame# :: forall t (ns :: [Nat]) s
. ( PrimBytes t, Dimensions ns)
=> State# s -> (# State# s, MDataFrame s t ns #)
newDataFrame# s0
| steps <- cumulDims $ dims @ns
, n <- cdTotalDim# steps
, (# s1, mba #) <- newByteArray# (n *# byteSize @t undefined) s0
= (# s1, MDataFrame# 0# steps mba #)
{-# INLINE newDataFrame# #-}
-- | Create a new mutable DataFrame.
newPinnedDataFrame# :: forall t (ns :: [Nat]) s
. ( PrimBytes t, Dimensions ns)
=> State# s -> (# State# s, MDataFrame s t ns #)
newPinnedDataFrame# s0
| steps <- cumulDims $ dims @ns
, n <- cdTotalDim# steps
, (# s1, mba #) <- newAlignedPinnedByteArray#
(n *# byteSize @t undefined)
(byteAlign @t undefined) s0
= (# s1, MDataFrame# 0# steps mba #)
{-# INLINE newPinnedDataFrame# #-}
-- | Copy one DataFrame into another mutable DataFrame at specified position.
--
-- In contrast to @copyDataFrame'@, this function allows to copy over a range of contiguous
-- indices over a single dimension.
-- For example, you can write a 3x4 matrix into a 7x4 matrix, starting at indices 0..3.
copyDataFrame# :: forall (t :: Type)
(b :: Nat) (bi :: Nat) (bd :: Nat)
(as :: [Nat]) (bs :: [Nat]) (asbs :: [Nat]) s
. ( b ~ (bi + bd - 1)
, PrimBytes t
, PrimBytes (DataFrame t (bd :+ bs))
, ConcatList as (b :+ bs) asbs
)
=> Idxs (as +: bi) -> DataFrame t (bd :+ bs) -> MDataFrame s t asbs
-> State# s -> (# State# s, () #)
copyDataFrame# ei df (MDataFrame# off steps mba) s
| I# i <- cdIx steps ei
= (# writeBytes mba ((off +# i) *# byteSize @t undefined) df s, () #)
{-# INLINE copyDataFrame# #-}
{-# ANN copyMDataFrame# "HLint: ignore Use camelCase" #-}
-- | Copy one mutable DataFrame into another mutable DataFrame at specified position.
--
-- In contrast to @copyMDataFrame'@, this function allows to copy over a range of contiguous
-- indices over a single dimension.
-- For example, you can write a 3x4 matrix into a 7x4 matrix, starting at indices 0..3.
copyMDataFrame# :: forall (t :: Type)
(b :: Nat) (bi :: Nat) (bd :: Nat)
(as :: [Nat]) (bs :: [Nat]) (asbs :: [Nat]) s
. ( b ~ (bi + bd - 1)
, PrimBytes t
, ConcatList as (b :+ bs) asbs
)
=> Idxs (as +: bi) -> MDataFrame s t (bd :+ bs) -> MDataFrame s t asbs
-> State# s -> (# State# s, () #)
-- all information for copying in this case is taken from the inside
-- of the data types at the term level;
-- steps zips with indices just fine independently of their types
-- and length.
-- Thus, it's fine here to just unsafeCoerce# an index.
copyMDataFrame# ei df =
copyMDataFrame'#
(unsafeCoerce# ei :: Idxs as)
(unsafeCoerce# df :: MDataFrame s t (b :+ bs))
{-# INLINE copyMDataFrame# #-}
{-# ANN copyDataFrame'# "HLint: ignore Use camelCase" #-}
-- | Copy one DataFrame into another mutable DataFrame at specified position.
--
-- This is a simpler version of @copyDataFrame@ that allows to copy over one index at a time.
copyDataFrame'# :: forall (t :: Type) (as :: [Nat]) (bs :: [Nat]) (asbs :: [Nat]) s
. ( PrimBytes t
, PrimBytes (DataFrame t bs)
, ConcatList as bs asbs
)
=> Idxs as -> DataFrame t bs -> MDataFrame s t asbs
-> State# s -> (# State# s, () #)
copyDataFrame'# ei df (MDataFrame# off steps mba) s
| I# i <- cdIx steps ei
= (# writeBytes mba ((off +# i) *# byteSize @t undefined) df s, () #)
{-# INLINE copyDataFrame'# #-}
{-# ANN copyMDataFrame'# "HLint: ignore Use camelCase" #-}
-- | Copy one mutable DataFrame into another mutable DataFrame at specified position.
--
-- This is a simpler version of @copyMDataFrame@ that allows to copy over one index at a time.
copyMDataFrame'# :: forall (t :: Type) (as :: [Nat]) (bs :: [Nat]) (asbs :: [Nat]) s
. ( PrimBytes t
, ConcatList as bs asbs
)
=> Idxs as -> MDataFrame s t bs -> MDataFrame s t asbs
-> State# s -> (# State# s, () #)
copyMDataFrame'# ei (MDataFrame# offA stepsA arrA) (MDataFrame# offM stepsM arrM) s
| elS <- byteSize @t undefined
, lenA <- cdTotalDim# stepsA
, I# i <- cdIx stepsM ei
= (# copyMutableByteArray# arrA (offA *# elS)
arrM ((offM +# i) *# elS) (lenA *# elS) s
, () #)
{-# INLINE copyMDataFrame'# #-}
-- | Make a mutable DataFrame immutable, without copying.
unsafeFreezeDataFrame# :: forall (t :: Type) (ns :: [Nat]) s
. PrimArray t (DataFrame t ns)
=> MDataFrame s t ns
-> State# s -> (# State# s, DataFrame t ns #)
unsafeFreezeDataFrame# (MDataFrame# offM steps arrM) s1
| (# s2, arrA #) <- unsafeFreezeByteArray# arrM s1
= (# s2, fromElems steps offM arrA #)
{-# INLINE unsafeFreezeDataFrame# #-}
-- | Copy content of a mutable DataFrame into a new immutable DataFrame.
freezeDataFrame# :: forall (t :: Type) (ns :: [Nat]) s
. PrimArray t (DataFrame t ns)
=> MDataFrame s t ns -> State# s -> (# State# s, DataFrame t ns #)
freezeDataFrame# (MDataFrame# offM steps arrM) s0
| elS <- byteSize @t undefined
, n <- cdTotalDim# steps
, (# s1, mba #) <- newByteArray# (n *# elS) s0
, s2 <- copyMutableByteArray# arrM (offM *# elS) mba 0# (n *# elS) s1
, (# s3, arrA #) <- unsafeFreezeByteArray# mba s2
= (# s3, fromElems steps 0# arrA #)
{-# INLINE freezeDataFrame# #-}
-- | Create a new mutable DataFrame and copy content of immutable one in there.
thawDataFrame# :: forall (t :: Type) (ns :: [Nat]) s
. ( Dimensions ns
, PrimBytes (DataFrame t ns))
=> DataFrame t ns -> State# s -> (# State# s, MDataFrame s t ns #)
thawDataFrame# df s0
| arrA <- getBytes df
, boff <- byteOffset df
, bsize <- byteSize df
, steps <- cumulDims $ dims @ns
, (# s1, arrM #) <- newByteArray# bsize s0
, s2 <- copyByteArray# arrA boff arrM 0# bsize s1
= (# s2, MDataFrame# 0# steps arrM #)
{-# INLINE thawDataFrame# #-}
-- | Create a new mutable DataFrame and copy content of immutable one in there.
-- The result array is pinned and aligned.
thawPinDataFrame# :: forall (t :: Type) (ns :: [Nat]) s
. ( Dimensions ns
, PrimBytes (DataFrame t ns))
=> DataFrame t ns -> State# s -> (# State# s, MDataFrame s t ns #)
thawPinDataFrame# df s0
| arrA <- getBytes df
, boff <- byteOffset df
, bsize <- byteSize df
, steps <- cumulDims $ dims @ns
, (# s1, arrM #) <- newAlignedPinnedByteArray# bsize (byteAlign df) s0
, s2 <- copyByteArray# arrA boff arrM 0# bsize s1
= (# s2, MDataFrame# 0# steps arrM #)
{-# INLINE thawPinDataFrame# #-}
-- | UnsafeCoerces an underlying byte array.
unsafeThawDataFrame# :: forall (t :: Type) (ns :: [Nat]) s
. ( Dimensions ns
, PrimBytes (DataFrame t ns), PrimBytes t)
=> DataFrame t ns
-> State# s -> (# State# s, MDataFrame s t ns #)
unsafeThawDataFrame# df s0
| elS <- byteSize @t undefined
, arrA <- getBytes df
, boff <- byteOffset df
, steps <- cumulDims $ dims @ns
= (# s0
, MDataFrame# (quotInt# boff elS) steps (unsafeCoerce# arrA)
#)
{-# INLINE unsafeThawDataFrame# #-}
-- | Write a single element at the specified element offset
writeDataFrameOff# :: forall (t :: Type) (ns :: [Nat]) s
. PrimBytes t
=> MDataFrame s t ns -> Int# -> t -> State# s -> (# State# s, () #)
writeDataFrameOff# (MDataFrame# off _ mba) i x s
= (# writeArray mba (off +# i) x s, () #)
{-# INLINE writeDataFrameOff# #-}
-- | Write a single element at the specified index
writeDataFrame# :: forall (t :: Type) (ns :: [Nat]) s
. PrimBytes t
=> MDataFrame s t ns -> Idxs ns -> t -> State# s -> (# State# s, () #)
writeDataFrame# mdf@(MDataFrame# _ st _) ei
| I# i <- cdIx st ei = writeDataFrameOff# mdf i
{-# INLINE writeDataFrame# #-}
-- | Read a single element at the specified element offset
readDataFrameOff# :: forall (t :: Type) (ns :: [Nat]) s
. PrimBytes t
=> MDataFrame s t ns -> Int# -> State# s -> (# State# s, t #)
readDataFrameOff# (MDataFrame# off _ mba) i = readArray mba (off +# i)
{-# INLINE readDataFrameOff# #-}
-- | Read a single element at the specified index
readDataFrame# :: forall (t :: Type) (ns :: [Nat]) s
. PrimBytes t
=> MDataFrame s t ns -> Idxs ns -> State# s -> (# State# s, t #)
readDataFrame# mdf@(MDataFrame# _ st _) ei
| I# i <- cdIx st ei = readDataFrameOff# mdf i
{-# INLINE readDataFrame# #-}
-- | Allow arbitrary operations on a pointer to the beginning of the data.
-- Only possible with @RealWord@ state (thus, in @IO@) due to semantics of
-- @touch#@ operation that keeps the data from being garbage collected.
withDataFramePtr# :: forall (t :: Type) (ns :: [Nat]) (r :: Type)
. PrimBytes t
=> MDataFrame RealWorld t ns
-> ( Addr# -> State# RealWorld -> (# State# RealWorld, r #) )
-> State# RealWorld -> (# State# RealWorld, r #)
withDataFramePtr# (MDataFrame# off _ mba) k s0
| (# s1, a #) <- unsafeFreezeByteArray# mba s0
, (# s2, r #) <- k ( byteArrayContents# a
`plusAddr#` (off *# byteSize @t undefined)
) s1
= (# touch# mba s2, r #)
-- | Check if the byte array wrapped by this DataFrame is pinned,
-- which means cannot be relocated by GC.
isDataFramePinned# :: forall (t :: Type) (ns :: [Nat]) s
. MDataFrame s t ns -> Bool
isDataFramePinned# (MDataFrame# _ _ mba)
= isTrue# (isMutableByteArrayPinned# mba)