Data.IDX.Internal

An internal package, the API contained here should not be used and is subject to possibly breaking changes. Use these functions and types at your own risk.

The safe interface is in IDX

Documentation

data IDXContentType where

A type to describe the content, according to IDX spec

Constructors

IDXUnsignedByte :: IDXContentType

IDXSignedByte :: IDXContentType

IDXShort :: IDXContentType

IDXInt :: IDXContentType

IDXFloat :: IDXContentType

IDXDouble :: IDXContentType

Instances

Show IDXContentType

Methods

showsPrec :: Int -> IDXContentType -> ShowS

show :: IDXContentType -> String

showList :: [IDXContentType] -> ShowS

Binary IDXContentType

Methods

put :: IDXContentType -> Put

get :: Get IDXContentType

putList :: [IDXContentType] -> Put

data IDXData

Datatype for storing IDXData. Internally data is always stored either as Int or Double unboxed vectors. However when binary serialization is used, the data is serialized according to the IDXContentType.

Constructors

IDXInts IDXContentType (Vector Int) (Vector Int)

IDXDoubles IDXContentType (Vector Int) (Vector Double)

Instances

Show IDXData

Methods

showsPrec :: Int -> IDXData -> ShowS

show :: IDXData -> String

showList :: [IDXData] -> ShowS

Binary IDXData

Methods

put :: IDXData -> Put

get :: Get IDXData

putList :: [IDXData] -> Put

newtype IDXLabels

A data type that holds Int labels for a set of IDXData

Constructors

IDXLabels (Vector Int)

Instances

Binary IDXLabels

Methods

put :: IDXLabels -> Put

get :: Get IDXLabels

putList :: [IDXLabels] -> Put

idxType :: IDXData -> IDXContentType

Return the what type the data is stored in

idxDimensions :: IDXData -> Vector Int

Return an unboxed Vector of Int dimensions

isIDXIntegral :: IDXData -> Bool

Return wether the data in this IDXData value is stored as integral values

isIDXReal :: IDXData -> Bool

Return wether the data in this IDXData value is stored as double values

idxIntContent :: IDXData -> Vector Int

Return contained ints, if no ints are contained, convert content to ints by using round. Data is stored like in a C-array, i.e. the last index changes first.

idxDoubleContent :: IDXData -> Vector Double

Return contained doubles, if no doubles are contained convert the content to double by using fromIntegral. Data is stored like in a C-array, i.e. the last index changes first.

readContent

Arguments

:: Unbox a

=> (Int -> Get (Vector a))

To Get a chunk of size n

-> Int

Chunk size

-> Int

Expected input

-> Get (Vector a)

Helper function to read a (possibly big) vector of binary values as chunks. Strictly evaluates each chunk and then concatenates the chunks, does not leak space.

getInt8 :: Get Int8

getInt16 :: Get Int16

getInt32 :: Get Int32

getFloat :: Get Float

getDouble :: Get Double

buildIntResult

Arguments

:: Integral a

=> Int

Expected number of entries

-> IDXContentType

Description of content

-> Vector Int

Dimension sizes

-> Get a

Monadic action to get content element

-> Get IDXData

Helper function for parsing integer data from the IDX content. Returns a full IDX result.

buildDoubleResult

Arguments

:: Real a

=> Int

Expected number of entries

-> IDXContentType

Description of content

-> Vector Int

Dimension sizes

-> Get a

Monadic action to get content element

-> Get IDXData

Helper function for parsing real number data from the IDX content.

putIntegral :: IDXContentType -> Int -> Put

Put values that are saved as Int

putReal :: IDXContentType -> Double -> Put

Put real values that are saved as Double