| Safe Haskell | None |
|---|---|
| Language | GHC2021 |
Language.Futhark.Primitive
Description
Definitions of primitive types, the values that inhabit these types, and operations on these values. A primitive value can also be called a scalar.
This module diverges from the actual Futhark language in that it does not distinguish signed and unsigned types. Further, we allow a "unit" type that is only indirectly present in source Futhark in the form of empty tuples.
Synopsis
- data IntType
- allIntTypes :: [IntType]
- data FloatType
- allFloatTypes :: [FloatType]
- data PrimType
- allPrimTypes :: [PrimType]
- data Int16
- data Int32
- data Int64
- data Int8
- data Word16
- data Word32
- data Word64
- data Word8
- data Half
- data IntValue
- = Int8Value !Int8
- | Int16Value !Int16
- | Int32Value !Int32
- | Int64Value !Int64
- intValue :: Integral int => IntType -> int -> IntValue
- intValueType :: IntValue -> IntType
- valueIntegral :: Integral int => IntValue -> int
- data FloatValue
- floatValue :: Real num => FloatType -> num -> FloatValue
- floatValueType :: FloatValue -> FloatType
- data PrimValue
- primValueType :: PrimValue -> PrimType
- blankPrimValue :: PrimType -> PrimValue
- onePrimValue :: PrimType -> PrimValue
- data Overflow
- data Safety
- data UnOp
- allUnOps :: [UnOp]
- data BinOp
- = Add IntType Overflow
- | FAdd FloatType
- | Sub IntType Overflow
- | FSub FloatType
- | Mul IntType Overflow
- | FMul FloatType
- | UDiv IntType Safety
- | UDivUp IntType Safety
- | SDiv IntType Safety
- | SDivUp IntType Safety
- | FDiv FloatType
- | FMod FloatType
- | UMod IntType Safety
- | SMod IntType Safety
- | SQuot IntType Safety
- | SRem IntType Safety
- | SMin IntType
- | UMin IntType
- | FMin FloatType
- | SMax IntType
- | UMax IntType
- | FMax FloatType
- | Shl IntType
- | LShr IntType
- | AShr IntType
- | And IntType
- | Or IntType
- | Xor IntType
- | Pow IntType
- | FPow FloatType
- | LogAnd
- | LogOr
- allBinOps :: [BinOp]
- data ConvOp
- allConvOps :: [ConvOp]
- data CmpOp
- allCmpOps :: [CmpOp]
- doUnOp :: UnOp -> PrimValue -> Maybe PrimValue
- doComplement :: IntValue -> IntValue
- doAbs :: IntValue -> IntValue
- doFAbs :: FloatValue -> FloatValue
- doSSignum :: IntValue -> IntValue
- doUSignum :: IntValue -> IntValue
- doBinOp :: BinOp -> PrimValue -> PrimValue -> Maybe PrimValue
- doAdd :: IntValue -> IntValue -> IntValue
- doMul :: IntValue -> IntValue -> IntValue
- doSDiv :: IntValue -> IntValue -> Maybe IntValue
- doSMod :: IntValue -> IntValue -> Maybe IntValue
- doPow :: IntValue -> IntValue -> Maybe IntValue
- doConvOp :: ConvOp -> PrimValue -> Maybe PrimValue
- doZExt :: IntValue -> IntType -> IntValue
- doSExt :: IntValue -> IntType -> IntValue
- doFPConv :: FloatValue -> FloatType -> FloatValue
- doFPToUI :: FloatValue -> IntType -> IntValue
- doFPToSI :: FloatValue -> IntType -> IntValue
- doUIToFP :: IntValue -> FloatType -> FloatValue
- doSIToFP :: IntValue -> FloatType -> FloatValue
- intToInt64 :: IntValue -> Int64
- intToWord64 :: IntValue -> Word64
- flipConvOp :: ConvOp -> ConvOp
- doCmpOp :: CmpOp -> PrimValue -> PrimValue -> Maybe Bool
- doCmpEq :: PrimValue -> PrimValue -> Bool
- doCmpUlt :: IntValue -> IntValue -> Bool
- doCmpUle :: IntValue -> IntValue -> Bool
- doCmpSlt :: IntValue -> IntValue -> Bool
- doCmpSle :: IntValue -> IntValue -> Bool
- doFCmpLt :: FloatValue -> FloatValue -> Bool
- doFCmpLe :: FloatValue -> FloatValue -> Bool
- binOpType :: BinOp -> PrimType
- unOpType :: UnOp -> PrimType
- cmpOpType :: CmpOp -> PrimType
- convOpType :: ConvOp -> (PrimType, PrimType)
- primFuns :: Map Text ([PrimType], PrimType, [PrimValue] -> Maybe PrimValue)
- condFun :: PrimType -> Text
- isCondFun :: Text -> Maybe PrimType
- zeroIsh :: PrimValue -> Bool
- zeroIshInt :: IntValue -> Bool
- oneIsh :: PrimValue -> Bool
- oneIshInt :: IntValue -> Bool
- negativeIsh :: PrimValue -> Bool
- primBitSize :: PrimType -> Int
- primByteSize :: Num a => PrimType -> a
- intByteSize :: Num a => IntType -> a
- floatByteSize :: Num a => FloatType -> a
- commutativeBinOp :: BinOp -> Bool
- associativeBinOp :: BinOp -> Bool
- convOpFun :: ConvOp -> String
- prettySigned :: Bool -> PrimType -> Text
Types
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.
Instances
| Bounded IntType Source # | |
| Enum IntType Source # | |
Defined in Language.Futhark.Primitive Methods succ :: IntType -> IntType Source # pred :: IntType -> IntType Source # toEnum :: Int -> IntType Source # fromEnum :: IntType -> Int Source # enumFrom :: IntType -> [IntType] Source # enumFromThen :: IntType -> IntType -> [IntType] Source # enumFromTo :: IntType -> IntType -> [IntType] Source # enumFromThenTo :: IntType -> IntType -> IntType -> [IntType] Source # | |
| Show IntType Source # | |
| Eq IntType Source # | |
| Ord IntType Source # | |
Defined in Language.Futhark.Primitive | |
| Pretty IntType Source # | |
allIntTypes :: [IntType] Source #
A list of all integer types.
A floating point type.
Instances
| Bounded FloatType Source # | |
| Enum FloatType Source # | |
Defined in Language.Futhark.Primitive Methods succ :: FloatType -> FloatType Source # pred :: FloatType -> FloatType Source # toEnum :: Int -> FloatType Source # fromEnum :: FloatType -> Int Source # enumFrom :: FloatType -> [FloatType] Source # enumFromThen :: FloatType -> FloatType -> [FloatType] Source # enumFromTo :: FloatType -> FloatType -> [FloatType] Source # enumFromThenTo :: FloatType -> FloatType -> FloatType -> [FloatType] Source # | |
| Show FloatType Source # | |
| Eq FloatType Source # | |
| Ord FloatType Source # | |
Defined in Language.Futhark.Primitive | |
| Pretty FloatType Source # | |
allFloatTypes :: [FloatType] Source #
A list of all floating-point types.
Low-level primitive types.
Constructors
| IntType IntType | |
| FloatType FloatType | |
| Bool | |
| Unit | An informationless type - An array of this type takes up no space. |
Instances
| FreeIn PrimType Source # | |
| Simplifiable PrimType Source # | |
Defined in Futhark.Optimise.Simplify.Engine | |
| Rename PrimType Source # | |
| Substitute PrimType Source # | |
Defined in Futhark.Transform.Substitute | |
| Bounded PrimType Source # | |
| Enum PrimType Source # | |
Defined in Language.Futhark.Primitive Methods succ :: PrimType -> PrimType Source # pred :: PrimType -> PrimType Source # toEnum :: Int -> PrimType Source # fromEnum :: PrimType -> Int Source # enumFrom :: PrimType -> [PrimType] Source # enumFromThen :: PrimType -> PrimType -> [PrimType] Source # enumFromTo :: PrimType -> PrimType -> [PrimType] Source # enumFromThenTo :: PrimType -> PrimType -> PrimType -> [PrimType] Source # | |
| Show PrimType Source # | |
| Eq PrimType Source # | |
| Ord PrimType Source # | |
Defined in Language.Futhark.Primitive | |
| Pretty PrimType Source # | |
allPrimTypes :: [PrimType] Source #
A list of all primitive types.
16-bit signed integer type
Instances
32-bit signed integer type
Instances
64-bit signed integer type
Instances
8-bit signed integer type
Instances
16-bit unsigned integer type
Instances
32-bit unsigned integer type
Instances
64-bit unsigned integer type
Instances
8-bit unsigned integer type
Instances
A half-precision floating point value
Instances
Values
An integer value.
Constructors
| Int8Value !Int8 | |
| Int16Value !Int16 | |
| Int32Value !Int32 | |
| Int64Value !Int64 |
Instances
| IsValue IntValue Source # | |
| Show IntValue Source # | |
| Eq IntValue Source # | |
| Ord IntValue Source # | |
Defined in Language.Futhark.Primitive | |
| ToExp IntValue Source # | |
| Pretty IntValue Source # | |
intValueType :: IntValue -> IntType Source #
The type of an integer value.
data FloatValue Source #
A floating-point value.
Constructors
| Float16Value !Half | |
| Float32Value !Float | |
| Float64Value !Double |
Instances
| IsValue FloatValue Source # | |
Defined in Futhark.IR.Prop.Constants Methods value :: FloatValue -> PrimValue Source # | |
| Show FloatValue Source # | |
Defined in Language.Futhark.Primitive | |
| Eq FloatValue Source # | |
Defined in Language.Futhark.Primitive Methods (==) :: FloatValue -> FloatValue -> Bool Source # (/=) :: FloatValue -> FloatValue -> Bool Source # | |
| Ord FloatValue Source # | |
Defined in Language.Futhark.Primitive Methods compare :: FloatValue -> FloatValue -> Ordering Source # (<) :: FloatValue -> FloatValue -> Bool Source # (<=) :: FloatValue -> FloatValue -> Bool Source # (>) :: FloatValue -> FloatValue -> Bool Source # (>=) :: FloatValue -> FloatValue -> Bool Source # max :: FloatValue -> FloatValue -> FloatValue Source # min :: FloatValue -> FloatValue -> FloatValue Source # | |
| ToExp FloatValue Source # | |
Defined in Futhark.CodeGen.Backends.SimpleRep | |
| Pretty FloatValue Source # | |
Defined in Language.Futhark.Primitive | |
floatValue :: Real num => FloatType -> num -> FloatValue Source #
Create a FloatValue from a type and a Rational.
floatValueType :: FloatValue -> FloatType Source #
The type of a floating-point value.
Non-array values.
Constructors
| IntValue !IntValue | |
| FloatValue !FloatValue | |
| BoolValue !Bool | |
| UnitValue | The only value of type |
Instances
| IsValue PrimValue Source # | |
| Show PrimValue Source # | |
| Eq PrimValue Source # | |
| Ord PrimValue Source # | |
Defined in Language.Futhark.Primitive | |
| ToExp PrimValue Source # | |
| Pretty PrimValue Source # | |
primValueType :: PrimValue -> PrimType Source #
The type of a basic value.
blankPrimValue :: PrimType -> PrimValue Source #
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.
onePrimValue :: PrimType -> PrimValue Source #
A one value of the given primitive type - this is one whatever is close to it.
Operations
What to do in case of arithmetic overflow. Futhark's semantics are that overflow does wraparound, but for generated code (like address arithmetic), it can be beneficial for overflow to be undefined behaviour, as it allows better optimisation of things such as GPU kernels.
Note that all values of this type are considered equal for Eq and
Ord.
Constructors
| OverflowWrap | |
| OverflowUndef |
Instances
| Show Overflow Source # | |
| Eq Overflow Source # | |
| Ord Overflow Source # | |
Defined in Language.Futhark.Primitive | |
Whether something is safe or unsafe (mostly function calls, and
in the context of whether operations are dynamically checked).
When we inline an Unsafe function, we remove all safety checks in
its body. The Ord instance picks Unsafe as being less than
Safe.
For operations like integer division, a safe division will not explode the computer in case of division by zero, but instead return some unspecified value. This always involves a run-time check, so generally the unsafe variant is what the compiler will insert, but guarded by an explicit assertion elsewhere. Safe operations are useful when the optimiser wants to move e.g. a division to a location where the divisor may be zero, but where the result will only be used when it is non-zero (so it doesn't matter what result is provided with a zero divisor, as long as the program keeps running).
Instances
| Show Safety Source # | |
| Eq Safety Source # | |
| Ord Safety Source # | |
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
| Neg PrimType | Flip sign. Logical negation for booleans. |
| Complement IntType | E.g., |
| Abs IntType |
|
| FAbs FloatType |
|
| SSignum IntType | Signed sign function: |
| USignum IntType | Unsigned sign function: |
| FSignum FloatType | Floating-point sign function. |
Binary operators. These correspond closely to the binary operators in LLVM. Most are parametrised by their expected input and output types.
Constructors
| Add IntType Overflow | Integer addition. |
| FAdd FloatType | Floating-point addition. |
| Sub IntType Overflow | Integer subtraction. |
| FSub FloatType | Floating-point subtraction. |
| Mul IntType Overflow | Integer multiplication. |
| FMul FloatType | Floating-point multiplication. |
| UDiv IntType Safety | Unsigned integer division. Rounds towards negativity infinity. Note: this is different from LLVM. |
| UDivUp IntType Safety | Unsigned integer division. Rounds towards positive infinity. |
| SDiv IntType Safety | Signed integer division. Rounds towards negativity infinity. Note: this is different from LLVM. |
| SDivUp IntType Safety | Signed integer division. Rounds towards positive infinity. |
| FDiv FloatType | Floating-point division. |
| FMod FloatType | Floating-point modulus. |
| UMod IntType Safety | Unsigned integer modulus; the countepart to |
| SMod IntType Safety | Signed integer modulus; the countepart to |
| SQuot IntType Safety | Signed integer division. Rounds towards zero. This
corresponds to the |
| SRem IntType Safety | Signed integer division. Rounds towards zero. This
corresponds to the |
| 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. |
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. |
| FPToBits FloatType | Convert floating point number to its bitwise representation. |
| BitsToFP FloatType | Convert bitwise representation to a floating point number. |
| 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. |
| FToB FloatType | Convert a float to a boolean value. Zero becomes false; | anything else is true. |
| BToF FloatType | Convert a boolean to a float. True is converted to 1 and False to 0. |
Instances
| Show ConvOp Source # | |
| Eq ConvOp Source # | |
| Ord ConvOp Source # | |
| Pretty ConvOp Source # | |
allConvOps :: [ConvOp] Source #
A list of all conversion operators for all types.
Comparison operators are like BinOps, but they always return a
boolean value. 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. |
Unary Operations
doComplement :: IntValue -> IntValue Source #
E.g., ~(~1) = 1.
doFAbs :: FloatValue -> FloatValue Source #
abs(-2.0) = 2.0.
Binary Operations
doSDiv :: IntValue -> IntValue -> Maybe IntValue Source #
Signed integer division. Rounds towards negativity infinity. Note: this is different from LLVM.
doSMod :: IntValue -> IntValue -> Maybe IntValue Source #
Signed integer modulus; the countepart to SDiv.
Conversion Operations
doZExt :: IntValue -> IntType -> IntValue Source #
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 Source #
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 Source #
Convert the former floating-point type to the latter.
doFPToUI :: FloatValue -> IntType -> IntValue Source #
Convert a floating-point value to the nearest unsigned integer (rounding towards zero).
doFPToSI :: FloatValue -> IntType -> IntValue Source #
Convert a floating-point value to the nearest signed integer (rounding towards zero).
doUIToFP :: IntValue -> FloatType -> FloatValue Source #
Convert an unsigned integer to a floating-point value.
doSIToFP :: IntValue -> FloatType -> FloatValue Source #
Convert a signed integer to a floating-point value.
intToWord64 :: IntValue -> Word64 Source #
flipConvOp :: ConvOp -> ConvOp Source #
Turn the conversion the other way around. Note that most conversions are lossy, so there is no guarantee the value will round-trip.
Comparison Operations
doCmpEq :: PrimValue -> PrimValue -> Bool Source #
Compare any two primtive values for exact equality.
doFCmpLt :: FloatValue -> FloatValue -> Bool Source #
Floating-point less than.
doFCmpLe :: FloatValue -> FloatValue -> Bool Source #
Floating-point less than or equal.
Type Of
convOpType :: ConvOp -> (PrimType, PrimType) Source #
The input and output types of a conversion operator.
Primitive functions
primFuns :: Map Text ([PrimType], PrimType, [PrimValue] -> Maybe PrimValue) Source #
A mapping from names of primitive functions to their parameter types, their result type, and a function for evaluating them.
condFun :: PrimType -> Text Source #
condFun t is the name of the ternary conditional function that
accepts operands of type [Bool, t, t], and returns either the
first or second t based on the truth value of the Bool.
isCondFun :: Text -> Maybe PrimType Source #
Is this the name of a condition function as per condFun, and
for which type?
Utility
zeroIshInt :: IntValue -> Bool Source #
Is the given integer value kind of zero?
negativeIsh :: PrimValue -> Bool Source #
Is the given value kind of negative?
primBitSize :: PrimType -> Int Source #
The size of a value of a given primitive type in bits.
primByteSize :: Num a => PrimType -> a Source #
intByteSize :: Num a => IntType -> a Source #
The size of a value of a given integer type in eight-bit bytes.
floatByteSize :: Num a => FloatType -> a Source #
The size of a value of a given floating-point type in eight-bit bytes.
commutativeBinOp :: BinOp -> Bool Source #
True if the given binary operator is commutative.
associativeBinOp :: BinOp -> Bool Source #
True if the given binary operator is associative.