Futhark.Binder

This module defines a convenience monad/typeclass for creating normalised programs. The fundamental building block is BinderT and its execution functions, but it is usually easier to use Binder.

See Futhark.Construct for a high-level description.

A concrete MonadBinder monad.

data BinderT lore m a

A monad transformer that tracks statements and provides a MonadBinder instance, assuming that the underlying monad provides a name source. In almost all cases, this is what you will use for constructing statements (possibly as part of a larger monad stack). If you find yourself needing to implement MonadBinder from scratch, then it is likely that you are making a mistake.

Instances

MonadWriter w m => MonadWriter w (BinderT lore m)

Defined in Futhark.Binder

Methods

writer :: (a, w) -> BinderT lore m a

tell :: w -> BinderT lore m ()

listen :: BinderT lore m a -> BinderT lore m (a, w)

pass :: BinderT lore m (a, w -> w) -> BinderT lore m a

MonadState s m => MonadState s (BinderT lore m)

Defined in Futhark.Binder

Methods

get :: BinderT lore m s

put :: s -> BinderT lore m ()

state :: (s -> (a, s)) -> BinderT lore m a

MonadReader r m => MonadReader r (BinderT lore m)

Defined in Futhark.Binder

Methods

ask :: BinderT lore m r

local :: (r -> r) -> BinderT lore m a -> BinderT lore m a

reader :: (r -> a) -> BinderT lore m a

MonadError e m => MonadError e (BinderT lore m)

Defined in Futhark.Binder

Methods

throwError :: e -> BinderT lore m a

catchError :: BinderT lore m a -> (e -> BinderT lore m a) -> BinderT lore m a

(ASTLore lore, Monad m) => LocalScope lore (BinderT lore m)

Defined in Futhark.Binder

Methods

localScope :: Scope lore -> BinderT lore m a -> BinderT lore m a

(ASTLore lore, Monad m) => HasScope lore (BinderT lore m)

Defined in Futhark.Binder

Methods

lookupType :: VName -> BinderT lore m Type

lookupInfo :: VName -> BinderT lore m (NameInfo lore)

askScope :: BinderT lore m (Scope lore)

asksScope :: (Scope lore -> a) -> BinderT lore m a

MonadTrans (BinderT lore)

Defined in Futhark.Binder

Methods

lift :: Monad m => m a -> BinderT lore m a

Monad m => Monad (BinderT lore m)

Defined in Futhark.Binder

Methods

(>>=) :: BinderT lore m a -> (a -> BinderT lore m b) -> BinderT lore m b

(>>) :: BinderT lore m a -> BinderT lore m b -> BinderT lore m b

return :: a -> BinderT lore m a

Functor m => Functor (BinderT lore m)

Defined in Futhark.Binder

Methods

fmap :: (a -> b) -> BinderT lore m a -> BinderT lore m b

(<$) :: a -> BinderT lore m b -> BinderT lore m a

Monad m => Applicative (BinderT lore m)

Defined in Futhark.Binder

Methods

pure :: a -> BinderT lore m a

(<*>) :: BinderT lore m (a -> b) -> BinderT lore m a -> BinderT lore m b

liftA2 :: (a -> b -> c) -> BinderT lore m a -> BinderT lore m b -> BinderT lore m c

(*>) :: BinderT lore m a -> BinderT lore m b -> BinderT lore m b

(<*) :: BinderT lore m a -> BinderT lore m b -> BinderT lore m a

MonadFreshNames m => MonadFreshNames (BinderT lore m)

Defined in Futhark.Binder

Methods

getNameSource :: BinderT lore m VNameSource

putNameSource :: VNameSource -> BinderT lore m ()

(ASTLore lore, MonadFreshNames m, BinderOps lore) => MonadBinder (BinderT lore m)

Defined in Futhark.Binder

Associated Types

type Lore (BinderT lore m)

Methods

mkExpDecM :: Pattern (Lore (BinderT lore m)) -> Exp (Lore (BinderT lore m)) -> BinderT lore m (ExpDec (Lore (BinderT lore m)))

mkBodyM :: Stms (Lore (BinderT lore m)) -> Result -> BinderT lore m (Body (Lore (BinderT lore m)))

mkLetNamesM :: [VName] -> Exp (Lore (BinderT lore m)) -> BinderT lore m (Stm (Lore (BinderT lore m)))

addStm :: Stm (Lore (BinderT lore m)) -> BinderT lore m ()

addStms :: Stms (Lore (BinderT lore m)) -> BinderT lore m ()

collectStms :: BinderT lore m a -> BinderT lore m (a, Stms (Lore (BinderT lore m)))

certifying :: Certificates -> BinderT lore m a -> BinderT lore m a

type Lore (BinderT lore m)

Defined in Futhark.Binder

type Lore (BinderT lore m) = lore

runBinderT :: MonadFreshNames m => BinderT lore m a -> Scope lore -> m (a, Stms lore)

Run a binder action given an initial scope, returning a value and the statements added (addStm) during the action.

runBinderT_ :: MonadFreshNames m => BinderT lore m () -> Scope lore -> m (Stms lore)

Like runBinderT, but return only the statements.

runBinderT' :: (MonadFreshNames m, HasScope somelore m, SameScope somelore lore) => BinderT lore m a -> m (a, Stms lore)

Like runBinderT, but get the initial scope from the current monad.

runBinderT'_ :: (MonadFreshNames m, HasScope somelore m, SameScope somelore lore) => BinderT lore m a -> m (Stms lore)

Like runBinderT_, but get the initial scope from the current monad.

class ASTLore lore => BinderOps lore where

A BinderT (and by extension, a Binder) is only an instance of MonadBinder for lores that implement this type class, which contains methods for constructing statements.

Minimal complete definition

Nothing

Methods

mkExpDecB :: (MonadBinder m, Lore m ~ lore) => Pattern lore -> Exp lore -> m (ExpDec lore)

default mkExpDecB :: (MonadBinder m, Bindable lore) => Pattern lore -> Exp lore -> m (ExpDec lore)

mkBodyB :: (MonadBinder m, Lore m ~ lore) => Stms lore -> Result -> m (Body lore)

default mkBodyB :: (MonadBinder m, Bindable lore) => Stms lore -> Result -> m (Body lore)

mkLetNamesB :: (MonadBinder m, Lore m ~ lore) => [VName] -> Exp lore -> m (Stm lore)

default mkLetNamesB :: (MonadBinder m, Lore m ~ lore, Bindable lore) => [VName] -> Exp lore -> m (Stm lore)

Instances

BinderOps Seq

Defined in Futhark.IR.Seq

Methods

mkExpDecB :: (MonadBinder m, Lore m ~ Seq) => Pattern Seq -> Exp Seq -> m (ExpDec Seq)

mkBodyB :: (MonadBinder m, Lore m ~ Seq) => Stms Seq -> Result -> m (Body Seq)

mkLetNamesB :: (MonadBinder m, Lore m ~ Seq) => [VName] -> Exp Seq -> m (Stm Seq)

BinderOps SOACS

Defined in Futhark.IR.SOACS

Methods

mkExpDecB :: (MonadBinder m, Lore m ~ SOACS) => Pattern SOACS -> Exp SOACS -> m (ExpDec SOACS)

mkBodyB :: (MonadBinder m, Lore m ~ SOACS) => Stms SOACS -> Result -> m (Body SOACS)

mkLetNamesB :: (MonadBinder m, Lore m ~ SOACS) => [VName] -> Exp SOACS -> m (Stm SOACS)

BinderOps MCMem

Defined in Futhark.IR.MCMem

Methods

mkExpDecB :: (MonadBinder m, Lore m ~ MCMem) => Pattern MCMem -> Exp MCMem -> m (ExpDec MCMem)

mkBodyB :: (MonadBinder m, Lore m ~ MCMem) => Stms MCMem -> Result -> m (Body MCMem)

mkLetNamesB :: (MonadBinder m, Lore m ~ MCMem) => [VName] -> Exp MCMem -> m (Stm MCMem)

BinderOps MC

Defined in Futhark.IR.MC

Methods

mkExpDecB :: (MonadBinder m, Lore m ~ MC) => Pattern MC -> Exp MC -> m (ExpDec MC)

mkBodyB :: (MonadBinder m, Lore m ~ MC) => Stms MC -> Result -> m (Body MC)

mkLetNamesB :: (MonadBinder m, Lore m ~ MC) => [VName] -> Exp MC -> m (Stm MC)

BinderOps SeqMem

Defined in Futhark.IR.SeqMem

Methods

mkExpDecB :: (MonadBinder m, Lore m ~ SeqMem) => Pattern SeqMem -> Exp SeqMem -> m (ExpDec SeqMem)

mkBodyB :: (MonadBinder m, Lore m ~ SeqMem) => Stms SeqMem -> Result -> m (Body SeqMem)

mkLetNamesB :: (MonadBinder m, Lore m ~ SeqMem) => [VName] -> Exp SeqMem -> m (Stm SeqMem)

BinderOps Kernels

Defined in Futhark.IR.Kernels

Methods

mkExpDecB :: (MonadBinder m, Lore m ~ Kernels) => Pattern Kernels -> Exp Kernels -> m (ExpDec Kernels)

mkBodyB :: (MonadBinder m, Lore m ~ Kernels) => Stms Kernels -> Result -> m (Body Kernels)

mkLetNamesB :: (MonadBinder m, Lore m ~ Kernels) => [VName] -> Exp Kernels -> m (Stm Kernels)

BinderOps KernelsMem

Defined in Futhark.IR.KernelsMem

Methods

mkExpDecB :: (MonadBinder m, Lore m ~ KernelsMem) => Pattern KernelsMem -> Exp KernelsMem -> m (ExpDec KernelsMem)

mkBodyB :: (MonadBinder m, Lore m ~ KernelsMem) => Stms KernelsMem -> Result -> m (Body KernelsMem)

mkLetNamesB :: (MonadBinder m, Lore m ~ KernelsMem) => [VName] -> Exp KernelsMem -> m (Stm KernelsMem)

(ASTLore (Aliases lore), Bindable (Aliases lore)) => BinderOps (Aliases lore)

Defined in Futhark.IR.Aliases

Methods

mkExpDecB :: (MonadBinder m, Lore m ~ Aliases lore) => Pattern (Aliases lore) -> Exp (Aliases lore) -> m (ExpDec (Aliases lore))

mkBodyB :: (MonadBinder m, Lore m ~ Aliases lore) => Stms (Aliases lore) -> Result -> m (Body (Aliases lore))

mkLetNamesB :: (MonadBinder m, Lore m ~ Aliases lore) => [VName] -> Exp (Aliases lore) -> m (Stm (Aliases lore))

BinderOps (Wise Seq)

Defined in Futhark.IR.Seq

Methods

mkExpDecB :: (MonadBinder m, Lore m ~ Wise Seq) => Pattern (Wise Seq) -> Exp (Wise Seq) -> m (ExpDec (Wise Seq))

mkBodyB :: (MonadBinder m, Lore m ~ Wise Seq) => Stms (Wise Seq) -> Result -> m (Body (Wise Seq))

mkLetNamesB :: (MonadBinder m, Lore m ~ Wise Seq) => [VName] -> Exp (Wise Seq) -> m (Stm (Wise Seq))

BinderOps (Wise SOACS)

Defined in Futhark.IR.SOACS.Simplify

Methods

mkExpDecB :: (MonadBinder m, Lore m ~ Wise SOACS) => Pattern (Wise SOACS) -> Exp (Wise SOACS) -> m (ExpDec (Wise SOACS))

mkBodyB :: (MonadBinder m, Lore m ~ Wise SOACS) => Stms (Wise SOACS) -> Result -> m (Body (Wise SOACS))

mkLetNamesB :: (MonadBinder m, Lore m ~ Wise SOACS) => [VName] -> Exp (Wise SOACS) -> m (Stm (Wise SOACS))

BinderOps (Wise MCMem)

Defined in Futhark.IR.MCMem

Methods

mkExpDecB :: (MonadBinder m, Lore m ~ Wise MCMem) => Pattern (Wise MCMem) -> Exp (Wise MCMem) -> m (ExpDec (Wise MCMem))

mkBodyB :: (MonadBinder m, Lore m ~ Wise MCMem) => Stms (Wise MCMem) -> Result -> m (Body (Wise MCMem))

mkLetNamesB :: (MonadBinder m, Lore m ~ Wise MCMem) => [VName] -> Exp (Wise MCMem) -> m (Stm (Wise MCMem))

BinderOps (Wise MC)

Defined in Futhark.IR.MC

Methods

mkExpDecB :: (MonadBinder m, Lore m ~ Wise MC) => Pattern (Wise MC) -> Exp (Wise MC) -> m (ExpDec (Wise MC))

mkBodyB :: (MonadBinder m, Lore m ~ Wise MC) => Stms (Wise MC) -> Result -> m (Body (Wise MC))

mkLetNamesB :: (MonadBinder m, Lore m ~ Wise MC) => [VName] -> Exp (Wise MC) -> m (Stm (Wise MC))

BinderOps (Wise SeqMem)

Defined in Futhark.IR.SeqMem

Methods

mkExpDecB :: (MonadBinder m, Lore m ~ Wise SeqMem) => Pattern (Wise SeqMem) -> Exp (Wise SeqMem) -> m (ExpDec (Wise SeqMem))

mkBodyB :: (MonadBinder m, Lore m ~ Wise SeqMem) => Stms (Wise SeqMem) -> Result -> m (Body (Wise SeqMem))

mkLetNamesB :: (MonadBinder m, Lore m ~ Wise SeqMem) => [VName] -> Exp (Wise SeqMem) -> m (Stm (Wise SeqMem))

BinderOps (Wise Kernels)

Defined in Futhark.IR.Kernels.Simplify

Methods

mkExpDecB :: (MonadBinder m, Lore m ~ Wise Kernels) => Pattern (Wise Kernels) -> Exp (Wise Kernels) -> m (ExpDec (Wise Kernels))

mkBodyB :: (MonadBinder m, Lore m ~ Wise Kernels) => Stms (Wise Kernels) -> Result -> m (Body (Wise Kernels))

mkLetNamesB :: (MonadBinder m, Lore m ~ Wise Kernels) => [VName] -> Exp (Wise Kernels) -> m (Stm (Wise Kernels))

BinderOps (Wise KernelsMem)

Defined in Futhark.IR.KernelsMem

Methods

mkExpDecB :: (MonadBinder m, Lore m ~ Wise KernelsMem) => Pattern (Wise KernelsMem) -> Exp (Wise KernelsMem) -> m (ExpDec (Wise KernelsMem))

mkBodyB :: (MonadBinder m, Lore m ~ Wise KernelsMem) => Stms (Wise KernelsMem) -> Result -> m (Body (Wise KernelsMem))

mkLetNamesB :: (MonadBinder m, Lore m ~ Wise KernelsMem) => [VName] -> Exp (Wise KernelsMem) -> m (Stm (Wise KernelsMem))

type Binder lore = BinderT lore (State VNameSource)

The most commonly used binder monad.

runBinder :: (MonadFreshNames m, HasScope somelore m, SameScope somelore lore) => Binder lore a -> m (a, Stms lore)

Run a binder action, returning a value and the statements added (addStm) during the action. Assumes that the current monad provides initial scope and name source.

runBinder_ :: (MonadFreshNames m, HasScope somelore m, SameScope somelore lore) => Binder lore a -> m (Stms lore)

Like runBinder, but throw away the result and just return the added statements.

runBodyBinder :: (Bindable lore, MonadFreshNames m, HasScope somelore m, SameScope somelore lore) => Binder lore (Body lore) -> m (Body lore)

Run a binder that produces a Body, and prefix that Body by the statements produced during execution of the action.

The MonadBinder typeclass

module Futhark.Binder.Class