Futhark.Representation.Primitive

Definitions of primitive types, the values that inhabit these types, and operations on these values. A primitive value can also be called a scalar.

Essentially, this module describes the subset of the (internal) Futhark language that operates on primitive types.

Types

data IntType

An integer type, ordered by size. Note that signedness is not a property of the type, but a property of the operations performed on values of these types.

Constructors

Int8

Int16

Int32

Int64

Instances

Bounded IntType

Defined in Futhark.Representation.Primitive

Methods

minBound :: IntType

maxBound :: IntType

Enum IntType

Defined in Futhark.Representation.Primitive

Methods

succ :: IntType -> IntType

pred :: IntType -> IntType

toEnum :: Int -> IntType

fromEnum :: IntType -> Int

enumFrom :: IntType -> [IntType]

enumFromThen :: IntType -> IntType -> [IntType]

enumFromTo :: IntType -> IntType -> [IntType]

enumFromThenTo :: IntType -> IntType -> IntType -> [IntType]

Eq IntType

Defined in Futhark.Representation.Primitive

Methods

(==) :: IntType -> IntType -> Bool

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

Ord IntType

Defined in Futhark.Representation.Primitive

Methods

compare :: IntType -> IntType -> Ordering

(<) :: IntType -> IntType -> Bool

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

(>) :: IntType -> IntType -> Bool

(>=) :: IntType -> IntType -> Bool

max :: IntType -> IntType -> IntType

min :: IntType -> IntType -> IntType

Show IntType

Defined in Futhark.Representation.Primitive

Methods

showsPrec :: Int -> IntType -> ShowS

show :: IntType -> String

showList :: [IntType] -> ShowS

Pretty IntType

Defined in Futhark.Representation.Primitive

Methods

ppr :: IntType -> Doc

pprPrec :: Int -> IntType -> Doc

pprList :: [IntType] -> Doc

allIntTypes :: [IntType]

A list of all integer types.

data FloatType

A floating point type.

Constructors

Float32

Float64

Instances

Bounded FloatType

Defined in Futhark.Representation.Primitive

Methods

minBound :: FloatType

maxBound :: FloatType

Enum FloatType

Defined in Futhark.Representation.Primitive

Methods

succ :: FloatType -> FloatType

pred :: FloatType -> FloatType

toEnum :: Int -> FloatType

fromEnum :: FloatType -> Int

enumFrom :: FloatType -> [FloatType]

enumFromThen :: FloatType -> FloatType -> [FloatType]

enumFromTo :: FloatType -> FloatType -> [FloatType]

enumFromThenTo :: FloatType -> FloatType -> FloatType -> [FloatType]

Eq FloatType

Defined in Futhark.Representation.Primitive

Methods

(==) :: FloatType -> FloatType -> Bool

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

Ord FloatType

Defined in Futhark.Representation.Primitive

Methods

compare :: FloatType -> FloatType -> Ordering

(<) :: FloatType -> FloatType -> Bool

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

(>) :: FloatType -> FloatType -> Bool

(>=) :: FloatType -> FloatType -> Bool

max :: FloatType -> FloatType -> FloatType

min :: FloatType -> FloatType -> FloatType

Show FloatType

Defined in Futhark.Representation.Primitive

Methods

showsPrec :: Int -> FloatType -> ShowS

show :: FloatType -> String

showList :: [FloatType] -> ShowS

Pretty FloatType

Defined in Futhark.Representation.Primitive

Methods

ppr :: FloatType -> Doc

pprPrec :: Int -> FloatType -> Doc

pprList :: [FloatType] -> Doc

allFloatTypes :: [FloatType]

A list of all floating-point types.

data PrimType

Low-level primitive types.

Constructors

IntType IntType

FloatType FloatType

Bool

Cert

Instances

Bounded PrimType

Defined in Futhark.Representation.Primitive

Methods

minBound :: PrimType

maxBound :: PrimType

Enum PrimType

Defined in Futhark.Representation.Primitive

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.Representation.Primitive

Methods

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

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

Ord PrimType

Defined in Futhark.Representation.Primitive

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.Representation.Primitive

Methods

showsPrec :: Int -> PrimType -> ShowS

show :: PrimType -> String

showList :: [PrimType] -> ShowS

Pretty PrimType

Defined in Futhark.Representation.Primitive

Methods

ppr :: PrimType -> Doc

pprPrec :: Int -> PrimType -> Doc

pprList :: [PrimType] -> Doc

allPrimTypes :: [PrimType]

A list of all primitive types.

Values

data IntValue

An integer value.

Constructors

Int8Value !Int8

Int16Value !Int16

Int32Value !Int32

Int64Value !Int64

Instances

Eq IntValue

Defined in Futhark.Representation.Primitive

Methods

(==) :: IntValue -> IntValue -> Bool

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

Ord IntValue

Defined in Futhark.Representation.Primitive

Methods

compare :: IntValue -> IntValue -> Ordering

(<) :: IntValue -> IntValue -> Bool

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

(>) :: IntValue -> IntValue -> Bool

(>=) :: IntValue -> IntValue -> Bool

max :: IntValue -> IntValue -> IntValue

min :: IntValue -> IntValue -> IntValue

Show IntValue

Defined in Futhark.Representation.Primitive

Methods

showsPrec :: Int -> IntValue -> ShowS

show :: IntValue -> String

showList :: [IntValue] -> ShowS

ToExp IntValue

Defined in Futhark.CodeGen.Backends.GenericC

Methods

toExp :: IntValue -> SrcLoc -> Exp

Pretty IntValue

Defined in Futhark.Representation.Primitive

Methods

ppr :: IntValue -> Doc

pprPrec :: Int -> IntValue -> Doc

pprList :: [IntValue] -> Doc

IsValue IntValue

Defined in Futhark.Representation.AST.Attributes.Constants

Methods

value :: IntValue -> PrimValue

intValue :: Integral int => IntType -> int -> IntValue

Create an IntValue from a type and an Integer.

intValueType :: IntValue -> IntType

valueIntegral :: Integral int => IntValue -> int

Convert an IntValue to any Integral type.

data FloatValue

A floating-point value.

Constructors

Float32Value !Float

Float64Value !Double

Instances

Eq FloatValue

Defined in Futhark.Representation.Primitive

Methods

(==) :: FloatValue -> FloatValue -> Bool

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

Ord FloatValue

Defined in Futhark.Representation.Primitive

Methods

compare :: FloatValue -> FloatValue -> Ordering

(<) :: FloatValue -> FloatValue -> Bool

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

(>) :: FloatValue -> FloatValue -> Bool

(>=) :: FloatValue -> FloatValue -> Bool

max :: FloatValue -> FloatValue -> FloatValue

min :: FloatValue -> FloatValue -> FloatValue

Show FloatValue

Defined in Futhark.Representation.Primitive

Methods

showsPrec :: Int -> FloatValue -> ShowS

show :: FloatValue -> String

showList :: [FloatValue] -> ShowS

ToExp FloatValue

Defined in Futhark.CodeGen.Backends.GenericC

Methods

toExp :: FloatValue -> SrcLoc -> Exp

Pretty FloatValue

Defined in Futhark.Representation.Primitive

Methods

ppr :: FloatValue -> Doc

pprPrec :: Int -> FloatValue -> Doc

pprList :: [FloatValue] -> Doc

IsValue FloatValue

Defined in Futhark.Representation.AST.Attributes.Constants

Methods

value :: FloatValue -> PrimValue

floatValue :: Real num => FloatType -> num -> FloatValue

Create a FloatValue from a type and a Rational.

floatValueType :: FloatValue -> FloatType

data PrimValue

Non-array values.

Constructors

IntValue !IntValue

FloatValue !FloatValue

BoolValue !Bool

Checked

The only value of type cert.

Instances

Eq PrimValue

Defined in Futhark.Representation.Primitive

Methods

(==) :: PrimValue -> PrimValue -> Bool

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

Ord PrimValue

Defined in Futhark.Representation.Primitive

Methods

compare :: PrimValue -> PrimValue -> Ordering

(<) :: PrimValue -> PrimValue -> Bool

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

(>) :: PrimValue -> PrimValue -> Bool

(>=) :: PrimValue -> PrimValue -> Bool

max :: PrimValue -> PrimValue -> PrimValue

min :: PrimValue -> PrimValue -> PrimValue

Show PrimValue

Defined in Futhark.Representation.Primitive

Methods

showsPrec :: Int -> PrimValue -> ShowS

show :: PrimValue -> String

showList :: [PrimValue] -> ShowS

ToExp PrimValue

Defined in Futhark.CodeGen.Backends.GenericC

Methods

toExp :: PrimValue -> SrcLoc -> Exp

Pretty PrimValue

Defined in Futhark.Representation.Primitive

Methods

ppr :: PrimValue -> Doc

pprPrec :: Int -> PrimValue -> Doc

pprList :: [PrimValue] -> Doc

IsValue PrimValue

Defined in Futhark.Representation.AST.Attributes.Constants

Methods

value :: PrimValue -> PrimValue

primValueType :: PrimValue -> PrimType

The type of a basic value.

blankPrimValue :: PrimType -> PrimValue

A "blank" value of the given primitive type - this is zero, or whatever is close to it. Don't depend on this value, but use it for e.g. creating arrays to be populated by do-loops.

Operations

data UnOp

Various unary operators. It is a bit ad-hoc what is a unary operator and what is a built-in function. Perhaps these should all go away eventually.

Constructors

Not

E.g., ! True == False.

Complement IntType

E.g., ~(~1) = 1.

Abs IntType

abs(-2) = 2.

FAbs FloatType

fabs(-2.0) = 2.0.

SSignum IntType

Signed sign function: ssignum(-2) = -1.

USignum IntType

Unsigned sign function: usignum(2) = 1.

Instances

Eq UnOp

Defined in Futhark.Representation.Primitive

Methods

(==) :: UnOp -> UnOp -> Bool

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

Ord UnOp

Defined in Futhark.Representation.Primitive

Methods

compare :: UnOp -> UnOp -> Ordering

(<) :: UnOp -> UnOp -> Bool

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

(>) :: UnOp -> UnOp -> Bool

(>=) :: UnOp -> UnOp -> Bool

max :: UnOp -> UnOp -> UnOp

min :: UnOp -> UnOp -> UnOp

Show UnOp

Defined in Futhark.Representation.Primitive

Methods

showsPrec :: Int -> UnOp -> ShowS

show :: UnOp -> String

showList :: [UnOp] -> ShowS

Pretty UnOp

Defined in Futhark.Representation.Primitive

Methods

ppr :: UnOp -> Doc

pprPrec :: Int -> UnOp -> Doc

pprList :: [UnOp] -> Doc

allUnOps :: [UnOp]

A list of all unary operators for all types.

data BinOp

Binary operators. These correspond closely to the binary operators in LLVM. Most are parametrised by their expected input and output types.

Constructors

Add IntType

Integer addition.

FAdd FloatType

Floating-point addition.

Sub IntType

Integer subtraction.

FSub FloatType

Floating-point subtraction.

Mul IntType

Integer multiplication.

FMul FloatType

Floating-point multiplication.

UDiv IntType

Unsigned integer division. Rounds towards negativity infinity. Note: this is different from LLVM.

SDiv IntType

Signed integer division. Rounds towards negativity infinity. Note: this is different from LLVM.

FDiv FloatType

Floating-point division.

UMod IntType

Unsigned integer modulus; the countepart to UDiv.

SMod IntType

Signed integer modulus; the countepart to SDiv.

SQuot IntType

Signed integer division. Rounds towards zero. This corresponds to the sdiv instruction in LLVM.

SRem IntType

Signed integer division. Rounds towards zero. This corresponds to the srem instruction in LLVM.

SMin IntType

Returns the smallest of two signed integers.

UMin IntType

Returns the smallest of two unsigned integers.

FMin FloatType

Returns the smallest of two floating-point numbers.

SMax IntType

Returns the greatest of two signed integers.

UMax IntType

Returns the greatest of two unsigned integers.

FMax FloatType

Returns the greatest of two floating-point numbers.

Shl IntType

Left-shift.

LShr IntType

Logical right-shift, zero-extended.

AShr IntType

Arithmetic right-shift, sign-extended.

And IntType

Bitwise and.

Or IntType

Bitwise or.

Xor IntType

Bitwise exclusive-or.

Pow IntType

Integer exponentiation.

FPow FloatType

Floating-point exponentiation.

LogAnd

Boolean and - not short-circuiting.

LogOr

Boolean or - not short-circuiting.

Instances

Eq BinOp

Defined in Futhark.Representation.Primitive

Methods

(==) :: BinOp -> BinOp -> Bool

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

Ord BinOp

Defined in Futhark.Representation.Primitive

Methods

compare :: BinOp -> BinOp -> Ordering

(<) :: BinOp -> BinOp -> Bool

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

(>) :: BinOp -> BinOp -> Bool

(>=) :: BinOp -> BinOp -> Bool

max :: BinOp -> BinOp -> BinOp

min :: BinOp -> BinOp -> BinOp

Show BinOp

Defined in Futhark.Representation.Primitive

Methods

showsPrec :: Int -> BinOp -> ShowS

show :: BinOp -> String

showList :: [BinOp] -> ShowS

Pretty BinOp

Defined in Futhark.Representation.Primitive

Methods

ppr :: BinOp -> Doc

pprPrec :: Int -> BinOp -> Doc

pprList :: [BinOp] -> Doc

allBinOps :: [BinOp]

A list of all binary operators for all types.

data ConvOp

Conversion operators try to generalise the from t0 x to t1 instructions from LLVM.

Constructors

ZExt IntType IntType

Zero-extend the former integer type to the latter. If the new type is smaller, the result is a truncation.

SExt IntType IntType

Sign-extend the former integer type to the latter. If the new type is smaller, the result is a truncation.

FPConv FloatType FloatType

Convert value of the former floating-point type to the latter. If the new type is smaller, the result is a truncation.

FPToUI FloatType IntType

Convert a floating-point value to the nearest unsigned integer (rounding towards zero).

FPToSI FloatType IntType

Convert a floating-point value to the nearest signed integer (rounding towards zero).

UIToFP IntType FloatType

Convert an unsigned integer to a floating-point value.

SIToFP IntType FloatType

Convert a signed integer to a floating-point value.

IToB IntType

Convert an integer to a boolean value. Zero becomes false; anything else is true.

BToI IntType

Convert a boolean to an integer. True is converted to 1 and False to 0.

Instances

Eq ConvOp

Defined in Futhark.Representation.Primitive

Methods

(==) :: ConvOp -> ConvOp -> Bool

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

Ord ConvOp

Defined in Futhark.Representation.Primitive

Methods

compare :: ConvOp -> ConvOp -> Ordering

(<) :: ConvOp -> ConvOp -> Bool

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

(>) :: ConvOp -> ConvOp -> Bool

(>=) :: ConvOp -> ConvOp -> Bool

max :: ConvOp -> ConvOp -> ConvOp

min :: ConvOp -> ConvOp -> ConvOp

Show ConvOp

Defined in Futhark.Representation.Primitive

Methods

showsPrec :: Int -> ConvOp -> ShowS

show :: ConvOp -> String

showList :: [ConvOp] -> ShowS

Pretty ConvOp

Defined in Futhark.Representation.Primitive

Methods

ppr :: ConvOp -> Doc

pprPrec :: Int -> ConvOp -> Doc

pprList :: [ConvOp] -> Doc

allConvOps :: [ConvOp]

A list of all conversion operators for all types.

data CmpOp

Comparison operators are like BinOps, but they return PrimTypes. The somewhat ugly constructor names are straight out of LLVM.

Constructors

CmpEq PrimType

All types equality.

CmpUlt IntType

Unsigned less than.

CmpUle IntType

Unsigned less than or equal.

CmpSlt IntType

Signed less than.

CmpSle IntType

Signed less than or equal.

FCmpLt FloatType

Floating-point less than.

FCmpLe FloatType

Floating-point less than or equal.

CmpLlt

Boolean less than.

CmpLle

Boolean less than or equal.

Instances

Eq CmpOp

Defined in Futhark.Representation.Primitive

Methods

(==) :: CmpOp -> CmpOp -> Bool

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

Ord CmpOp

Defined in Futhark.Representation.Primitive

Methods

compare :: CmpOp -> CmpOp -> Ordering

(<) :: CmpOp -> CmpOp -> Bool

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

(>) :: CmpOp -> CmpOp -> Bool

(>=) :: CmpOp -> CmpOp -> Bool

max :: CmpOp -> CmpOp -> CmpOp

min :: CmpOp -> CmpOp -> CmpOp

Show CmpOp

Defined in Futhark.Representation.Primitive

Methods

showsPrec :: Int -> CmpOp -> ShowS

show :: CmpOp -> String

showList :: [CmpOp] -> ShowS

Pretty CmpOp

Defined in Futhark.Representation.Primitive

Methods

ppr :: CmpOp -> Doc

pprPrec :: Int -> CmpOp -> Doc

pprList :: [CmpOp] -> Doc

allCmpOps :: [CmpOp]

A list of all comparison operators for all types.

Unary Operations

doUnOp :: UnOp -> PrimValue -> Maybe PrimValue

doComplement :: IntValue -> IntValue

E.g., ~(~1) = 1.

doAbs :: IntValue -> IntValue

abs(-2) = 2.

doFAbs :: FloatValue -> FloatValue

abs(-2.0) = 2.0.

doSSignum :: IntValue -> IntValue

ssignum(-2) = -1.

doUSignum :: IntValue -> IntValue

usignum(-2) = -1.

Binary Operations

doBinOp :: BinOp -> PrimValue -> PrimValue -> Maybe PrimValue

doAdd :: IntValue -> IntValue -> IntValue

Integer addition.

doMul :: IntValue -> IntValue -> IntValue

Integer multiplication.

doSDiv :: IntValue -> IntValue -> Maybe IntValue

Signed integer division. Rounds towards negativity infinity. Note: this is different from LLVM.

doSMod :: IntValue -> IntValue -> Maybe IntValue

Signed integer modulus; the countepart to SDiv.

doPow :: IntValue -> IntValue -> Maybe IntValue

Signed integer exponentatation.

Conversion Operations

doConvOp :: ConvOp -> PrimValue -> Maybe PrimValue

doZExt :: IntValue -> IntType -> IntValue

Zero-extend the given integer value to the size of the given type. If the type is smaller than the given value, the result is a truncation.

doSExt :: IntValue -> IntType -> IntValue

Sign-extend the given integer value to the size of the given type. If the type is smaller than the given value, the result is a truncation.

doFPConv :: FloatValue -> FloatType -> FloatValue

Convert the former floating-point type to the latter.

doFPToUI :: FloatValue -> IntType -> IntValue

Convert a floating-point value to the nearest unsigned integer (rounding towards zero).

doFPToSI :: FloatValue -> IntType -> IntValue

Convert a floating-point value to the nearest signed integer (rounding towards zero).

doUIToFP :: IntValue -> FloatType -> FloatValue

Convert an unsigned integer to a floating-point value.

doSIToFP :: IntValue -> FloatType -> FloatValue

Convert a signed integer to a floating-point value.

intToInt64 :: IntValue -> Int64

Translate an IntValue to IntType. This is guaranteed to fit.

intToWord64 :: IntValue -> Word64

Translate an IntValue to Word64. This is guaranteed to fit.

Comparison Operations

doCmpOp :: CmpOp -> PrimValue -> PrimValue -> Maybe Bool

doCmpEq :: PrimValue -> PrimValue -> Bool

Compare any two primtive values for exact equality.

doCmpUlt :: IntValue -> IntValue -> Bool

Unsigned less than.

doCmpUle :: IntValue -> IntValue -> Bool

Unsigned less than or equal.

doCmpSlt :: IntValue -> IntValue -> Bool

Signed less than.

doCmpSle :: IntValue -> IntValue -> Bool

Signed less than or equal.

doFCmpLt :: FloatValue -> FloatValue -> Bool

Floating-point less than.

doFCmpLe :: FloatValue -> FloatValue -> Bool

Floating-point less than or equal.

Type Of

binOpType :: BinOp -> PrimType

The result type of a binary operator.

unOpType :: UnOp -> PrimType

The operand and result type of a unary operator.

cmpOpType :: CmpOp -> PrimType

The operand types of a comparison operator.

convOpType :: ConvOp -> (PrimType, PrimType)

The input and output types of a conversion operator.

Primitive functions

primFuns :: Map String ([PrimType], PrimType, [PrimValue] -> Maybe PrimValue)

A mapping from names of primitive functions to their parameter types, their result type, and a function for evaluating them.

Utility

zeroIsh :: PrimValue -> Bool

Is the given value kind of zero?

oneIsh :: PrimValue -> Bool

Is the given value kind of one?

negativeIsh :: PrimValue -> Bool

Is the given value kind of negative?

primBitSize :: PrimType -> Int

The size of a value of a given primitive type in bites.

primByteSize :: Num a => PrimType -> a

The size of a value of a given primitive type in eight-bit bytes.

intByteSize :: Num a => IntType -> a

The size of a value of a given integer type in eight-bit bytes.

floatByteSize :: Num a => FloatType -> a

The size of a value of a given floating-point type in eight-bit bytes.

commutativeBinOp :: BinOp -> Bool

True if the given binary operator is commutative.

Prettyprinting

convOpFun :: ConvOp -> String

prettySigned :: Bool -> PrimType -> String

True if signed. Only makes a difference for integer types.