Numeric.DataFrame.Internal.PrimArray

Documentation

class PrimBytes t => PrimArray t a | a -> t where

Minimal complete definition

broadcast, ix#, gen#, upd#, arrayContent#, fromElems

Methods

broadcast :: t -> a

Broadcast element into array

ix# :: Int# -> a -> t

Index an array given an offset

gen#

Arguments

:: CumulDims

Dimensionality of the result array; Be careful! ns depends on a, but this is not reflected in types and is not checked at runtime.

-> (s -> (#s, t#))

-> s

-> (#s, a#)

Generate an array using an accumulator funtion

upd#

Arguments

:: CumulDims

Dimensionality of the result array; Be careful! ns depends on a, but this is not reflected in types and is not checked at runtime.

-> Int#

-> t

-> a

-> a

update a single element in an array given an offset

arrayContent# :: a -> (#t | (#CumulDims, Int#, ByteArray##)#)

If the array represented as a single broadcasted value, return this value. Otherwise, return full array content: CumulDims, array offset (elements), byte array with the content.

offsetElems :: a -> Int#

Offset of an array as a number of elements

uniqueOrCumulDims :: a -> Either t CumulDims

Normally, this returns a cumulative totalDims. However, if a particular implementation does not have the dimensionality information, it cannot return CumulDims; In this case, it is a sign that all elements of an array are same. Thus, it is possible to return the single element value instead.

Note, this function returns the only unique element only if it is a such by construction (there is no equality checks involved).

fromElems :: CumulDims -> Int# -> ByteArray# -> a

Get array by its offset and cumulative dims in a ByteArray. Both offset and dims are given in element number (not in bytes).

It is better to use this function instead of fromBytes to avoid recalculating CumulDims for implementations that require it.

Instances

PrimArray Double (Quater Double)

Defined in Numeric.Quaternion.Internal.QDouble

Methods

broadcast :: Double -> Quater Double

ix# :: Int# -> Quater Double -> Double

gen# :: CumulDims -> (s -> (#s, Double#)) -> s -> (#s, Quater Double#)

upd# :: CumulDims -> Int# -> Double -> Quater Double -> Quater Double

arrayContent# :: Quater Double -> (#|#) Double (#CumulDims, Int#, ByteArray##)

offsetElems :: Quater Double -> Int#

uniqueOrCumulDims :: Quater Double -> Either Double CumulDims

fromElems :: CumulDims -> Int# -> ByteArray# -> Quater Double

PrimArray Float (Quater Float)

Defined in Numeric.Quaternion.Internal.QFloat

Methods

broadcast :: Float -> Quater Float

ix# :: Int# -> Quater Float -> Float

gen# :: CumulDims -> (s -> (#s, Float#)) -> s -> (#s, Quater Float#)

upd# :: CumulDims -> Int# -> Float -> Quater Float -> Quater Float

arrayContent# :: Quater Float -> (#|#) Float (#CumulDims, Int#, ByteArray##)

offsetElems :: Quater Float -> Int#

uniqueOrCumulDims :: Quater Float -> Either Float CumulDims

fromElems :: CumulDims -> Int# -> ByteArray# -> Quater Float

(PrimArray t (DFBackend t ds), PrimBytes t) => PrimArray t (DataFrame t ds)

Defined in Numeric.DataFrame.Type

Methods

broadcast :: t -> DataFrame t ds

ix# :: Int# -> DataFrame t ds -> t

gen# :: CumulDims -> (s -> (#s, t#)) -> s -> (#s, DataFrame t ds#)

upd# :: CumulDims -> Int# -> t -> DataFrame t ds -> DataFrame t ds

arrayContent# :: DataFrame t ds -> (#|#) t (#CumulDims, Int#, ByteArray##)

offsetElems :: DataFrame t ds -> Int#

uniqueOrCumulDims :: DataFrame t ds -> Either t CumulDims

fromElems :: CumulDims -> Int# -> ByteArray# -> DataFrame t ds

newtype CumulDims

Given Dims ns, CumulativeDims is a list of length Length ns + 1; which cumulative totalDim accumulated on the right. In particular, its first element is totalDim ds, its last element is always is always 1.

Constructors

CumulDims

Fields

• unCumulDims :: [Word]

Instances

Semigroup CumulDims

Defined in Numeric.DataFrame.Internal.PrimArray

Methods

(<>) :: CumulDims -> CumulDims -> CumulDims

sconcat :: NonEmpty CumulDims -> CumulDims

stimes :: Integral b => b -> CumulDims -> CumulDims

Monoid CumulDims

Defined in Numeric.DataFrame.Internal.PrimArray

Methods

mempty :: CumulDims

mappend :: CumulDims -> CumulDims -> CumulDims

mconcat :: [CumulDims] -> CumulDims

cumulDims :: Dims (ns :: [k]) -> CumulDims

Calculate cumulative dims

cdTotalDim :: CumulDims -> Word

Get the total number of elements

cdTotalDim# :: CumulDims -> Int#

cdIx :: CumulDims -> Idxs ns -> Int

Calculate offset of an Idxs

Note, you can take offset of subspace with CumulDims of larger space - very convenient!

ixOff :: PrimArray t a => Int -> a -> t

Index array by an integer offset (starting from 0).

unsafeFromFlatList :: PrimArray t a => Dims ns -> t -> [t] -> a

Construct an array from a flat list and Dims; Be careful! ns depends on a, but this is not reflected in types and is not checked at runtime.

getSteps :: PrimArray t a => Dims (ns :: [k]) -> a -> CumulDims

Try to get CumulDims from an array, and create it using Dims if failed.

fromSteps :: CumulDims -> SomeDims

Get Dims by "de-accumulating" CumulDims.