Futhark.Data

This module defines an efficient value representation of the Futhark data format.

Documentation

data Value

An efficiently represented Futhark value, represented as a shape vector and a value vector, which contains elements in row-major order. The size of the value vector must be equal to the product of the shape vector. This is not enforced by the representation, but consuming functions may give unexpected results if this invariant is broken. Scalars are represented with an empty shape vector.

Use valueText to get a human-readable representation, and put to obtain binary a representation.

The Eq instance is the naive one, meaning that no values containing NaNs will be considered equal. Use the functions from Futhark.Data.Compare if this is not what you want.

Constructors

I8Value (Vector Int) (Vector Int8)

I16Value (Vector Int) (Vector Int16)

I32Value (Vector Int) (Vector Int32)

I64Value (Vector Int) (Vector Int64)

U8Value (Vector Int) (Vector Word8)

U16Value (Vector Int) (Vector Word16)

U32Value (Vector Int) (Vector Word32)

U64Value (Vector Int) (Vector Word64)

F16Value (Vector Int) (Vector Half)

F32Value (Vector Int) (Vector Float)

F64Value (Vector Int) (Vector Double)

BoolValue (Vector Int) (Vector Bool)

Instances

Eq Value

Defined in Futhark.Data

Methods

(==) :: Value -> Value -> Bool

(/=) :: Value -> Value -> Bool

Show Value

Defined in Futhark.Data

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

Binary Value

Defined in Futhark.Data

Methods

put :: Value -> Put

get :: Get Value

putList :: [Value] -> Put

PutValue [Value]

Defined in Futhark.Data

Methods

putValue :: [Value] -> Maybe Value

type Vector = Vector

The value vector type.

valueText :: Value -> Text

Construct a textual representation of the value as a strict text.

Types of values

data PrimType

The scalar types supported by the value format.

Constructors

I8

I16

I32

I64

U8

U16

U32

U64

F16

F32

F64

Bool

Instances

Bounded PrimType

Defined in Futhark.Data

Methods

minBound :: PrimType

maxBound :: PrimType

Enum PrimType

Defined in Futhark.Data

Methods

succ :: PrimType -> PrimType

pred :: PrimType -> PrimType

toEnum :: Int -> PrimType

fromEnum :: PrimType -> Int

enumFrom :: PrimType -> [PrimType]

enumFromThen :: PrimType -> PrimType -> [PrimType]

enumFromTo :: PrimType -> PrimType -> [PrimType]

enumFromThenTo :: PrimType -> PrimType -> PrimType -> [PrimType]

Eq PrimType

Defined in Futhark.Data

Methods

(==) :: PrimType -> PrimType -> Bool

(/=) :: PrimType -> PrimType -> Bool

Ord PrimType

Defined in Futhark.Data

Methods

compare :: PrimType -> PrimType -> Ordering

(<) :: PrimType -> PrimType -> Bool

(<=) :: PrimType -> PrimType -> Bool

(>) :: PrimType -> PrimType -> Bool

(>=) :: PrimType -> PrimType -> Bool

max :: PrimType -> PrimType -> PrimType

min :: PrimType -> PrimType -> PrimType

Show PrimType

Defined in Futhark.Data

Methods

showsPrec :: Int -> PrimType -> ShowS

show :: PrimType -> String

showList :: [PrimType] -> ShowS

primTypeText :: PrimType -> Text

Textual primitive type as a strict text.

primTypeBytes :: PrimType -> Int

The number of bytes taken up by a single element of this type.

data ValueType

The type of a simple Futhark value, comprising a shape and an element type.

Constructors

ValueType [Int] PrimType

Instances

Eq ValueType

Defined in Futhark.Data

Methods

(==) :: ValueType -> ValueType -> Bool

(/=) :: ValueType -> ValueType -> Bool

Ord ValueType

Defined in Futhark.Data

Methods

compare :: ValueType -> ValueType -> Ordering

(<) :: ValueType -> ValueType -> Bool

(<=) :: ValueType -> ValueType -> Bool

(>) :: ValueType -> ValueType -> Bool

(>=) :: ValueType -> ValueType -> Bool

max :: ValueType -> ValueType -> ValueType

min :: ValueType -> ValueType -> ValueType

Show ValueType

Defined in Futhark.Data

Methods

showsPrec :: Int -> ValueType -> ShowS

show :: ValueType -> String

showList :: [ValueType] -> ShowS

valueTypeTextNoDims :: ValueType -> Text

Prettyprint a value type with empty dimensions as a strict text. This is needed for Futhark server programs, whose types are un-sized.

valueType :: Value -> ValueType

Get the type of a value.

valueElemType :: Value -> PrimType

Get the element type of a value.

valueShape :: Value -> [Int]

The shape of a value. Empty list in case of a scalar.

valueTypeText :: ValueType -> Text

Prettyprint a value type as a strict text.

Converting values

class GetValue t where

A class for Haskell values that can be retrieved from Value. This is a convenience facility - don't expect it to be fast.

Methods

getValue :: Value -> Maybe t

Instances

GetValue Bool

Defined in Futhark.Data

Methods

getValue :: Value -> Maybe Bool

GetValue Int8

Defined in Futhark.Data

Methods

getValue :: Value -> Maybe Int8

GetValue Int16

Defined in Futhark.Data

Methods

getValue :: Value -> Maybe Int16

GetValue Int32

Defined in Futhark.Data

Methods

getValue :: Value -> Maybe Int32

GetValue Int64

Defined in Futhark.Data

Methods

getValue :: Value -> Maybe Int64

GetValue Word8

Defined in Futhark.Data

Methods

getValue :: Value -> Maybe Word8

GetValue Word16

Defined in Futhark.Data

Methods

getValue :: Value -> Maybe Word16

GetValue Word32

Defined in Futhark.Data

Methods

getValue :: Value -> Maybe Word32

GetValue Word64

Defined in Futhark.Data

Methods

getValue :: Value -> Maybe Word64

GetValue t => GetValue [t]

Defined in Futhark.Data

Methods

getValue :: Value -> Maybe [t]

class PutValue t where

A class for Haskell values that can be converted to Value. This is a convenience facility - don't expect it to be fast.

Methods

putValue :: t -> Maybe Value

This may fail for cases such as irregular arrays.

Instances

PutValue Int8

Defined in Futhark.Data

Methods

putValue :: Int8 -> Maybe Value

PutValue Int16

Defined in Futhark.Data

Methods

putValue :: Int16 -> Maybe Value

PutValue Int32

Defined in Futhark.Data

Methods

putValue :: Int32 -> Maybe Value

PutValue Int64

Defined in Futhark.Data

Methods

putValue :: Int64 -> Maybe Value

PutValue Word8

Defined in Futhark.Data

Methods

putValue :: Word8 -> Maybe Value

PutValue Word16

Defined in Futhark.Data

Methods

putValue :: Word16 -> Maybe Value

PutValue Word32

Defined in Futhark.Data

Methods

putValue :: Word32 -> Maybe Value

PutValue Word64

Defined in Futhark.Data

Methods

putValue :: Word64 -> Maybe Value

PutValue ByteString

Defined in Futhark.Data

Methods

putValue :: ByteString -> Maybe Value

PutValue Text

Defined in Futhark.Data

Methods

putValue :: Text -> Maybe Value

PutValue [Value]

Defined in Futhark.Data

Methods

putValue :: [Value] -> Maybe Value

valueElems :: Value -> [Value]

Produce a list of the immediate elements of the value. That is, a 2D array will produce a list of 1D values. A zero-dimensional value will produce an empty list. While lists are of course inefficient, the actual values are just slices of the original value, which makes them fairly space-efficient (but beware space leaks).