Futhark.Util.IntegralExp

It is occasionally useful to define generic functions that can not only compute their result as an integer, but also as a symbolic expression in the form of an AST.

There are some Haskell hacks for this - it is for example not hard to define an instance of Num that constructs an AST. However, this falls down for some other interesting classes, like Integral, which requires both the problematic method fromInteger, and also that the type is an instance of Enum.

We can always just define hobbled instances that call error for those methods that are impractical, but this is ugly.

Hence, this module defines similes to standard Haskell numeric typeclasses that have been modified to make generic functions slightly easier to write.

Documentation

class Num e => IntegralExp e where

A twist on the Integral type class that is more friendly to symbolic representations.

Minimal complete definition

quot, rem, div, mod, sgn, pow

Methods

quot :: e -> e -> e

rem :: e -> e -> e

div :: e -> e -> e

mod :: e -> e -> e

sgn :: e -> Maybe Int

pow :: e -> e -> e

divUp :: e -> e -> e

Like div, but rounds towards positive infinity.

Instances

Integral a => IntegralExp (Wrapped a)

Defined in Futhark.Util.IntegralExp

Methods

quot :: Wrapped a -> Wrapped a -> Wrapped a

rem :: Wrapped a -> Wrapped a -> Wrapped a

div :: Wrapped a -> Wrapped a -> Wrapped a

mod :: Wrapped a -> Wrapped a -> Wrapped a

sgn :: Wrapped a -> Maybe Int

pow :: Wrapped a -> Wrapped a -> Wrapped a

divUp :: Wrapped a -> Wrapped a -> Wrapped a

(IntExp t, Pretty v) => IntegralExp (TPrimExp t v)

Defined in Futhark.Analysis.PrimExp

Methods

quot :: TPrimExp t v -> TPrimExp t v -> TPrimExp t v

rem :: TPrimExp t v -> TPrimExp t v -> TPrimExp t v

div :: TPrimExp t v -> TPrimExp t v -> TPrimExp t v

mod :: TPrimExp t v -> TPrimExp t v -> TPrimExp t v

sgn :: TPrimExp t v -> Maybe Int

pow :: TPrimExp t v -> TPrimExp t v -> TPrimExp t v

divUp :: TPrimExp t v -> TPrimExp t v -> TPrimExp t v

IntegralExp e => IntegralExp (Count u e)

Defined in Futhark.IR.GPU.Sizes

Methods

quot :: Count u e -> Count u e -> Count u e

rem :: Count u e -> Count u e -> Count u e

div :: Count u e -> Count u e -> Count u e

mod :: Count u e -> Count u e -> Count u e

sgn :: Count u e -> Maybe Int

pow :: Count u e -> Count u e -> Count u e

divUp :: Count u e -> Count u e -> Count u e

newtype Wrapped a

This wrapper allows you to use a type that is an instance of the true class whenever the simile class is required.

Constructors

Wrapped

Fields

• wrappedValue :: a

Instances

Enum a => Enum (Wrapped a)

Defined in Futhark.Util.IntegralExp

Methods

succ :: Wrapped a -> Wrapped a

pred :: Wrapped a -> Wrapped a

toEnum :: Int -> Wrapped a

fromEnum :: Wrapped a -> Int

enumFrom :: Wrapped a -> [Wrapped a]

enumFromThen :: Wrapped a -> Wrapped a -> [Wrapped a]

enumFromTo :: Wrapped a -> Wrapped a -> [Wrapped a]

enumFromThenTo :: Wrapped a -> Wrapped a -> Wrapped a -> [Wrapped a]

Num a => Num (Wrapped a)

Defined in Futhark.Util.IntegralExp

Methods

(+) :: Wrapped a -> Wrapped a -> Wrapped a

(-) :: Wrapped a -> Wrapped a -> Wrapped a

(*) :: Wrapped a -> Wrapped a -> Wrapped a

negate :: Wrapped a -> Wrapped a

abs :: Wrapped a -> Wrapped a

signum :: Wrapped a -> Wrapped a

fromInteger :: Integer -> Wrapped a

Show a => Show (Wrapped a)

Defined in Futhark.Util.IntegralExp

Methods

showsPrec :: Int -> Wrapped a -> ShowS

show :: Wrapped a -> String

showList :: [Wrapped a] -> ShowS

Integral a => IntegralExp (Wrapped a)

Defined in Futhark.Util.IntegralExp

Methods

quot :: Wrapped a -> Wrapped a -> Wrapped a

rem :: Wrapped a -> Wrapped a -> Wrapped a

div :: Wrapped a -> Wrapped a -> Wrapped a

mod :: Wrapped a -> Wrapped a -> Wrapped a

sgn :: Wrapped a -> Maybe Int

pow :: Wrapped a -> Wrapped a -> Wrapped a

divUp :: Wrapped a -> Wrapped a -> Wrapped a

Eq a => Eq (Wrapped a)

Defined in Futhark.Util.IntegralExp

Methods

(==) :: Wrapped a -> Wrapped a -> Bool

(/=) :: Wrapped a -> Wrapped a -> Bool

Ord a => Ord (Wrapped a)

Defined in Futhark.Util.IntegralExp

Methods

compare :: Wrapped a -> Wrapped a -> Ordering

(<) :: Wrapped a -> Wrapped a -> Bool

(<=) :: Wrapped a -> Wrapped a -> Bool

(>) :: Wrapped a -> Wrapped a -> Bool

(>=) :: Wrapped a -> Wrapped a -> Bool

max :: Wrapped a -> Wrapped a -> Wrapped a

min :: Wrapped a -> Wrapped a -> Wrapped a