Futhark.Builder

This module defines a convenience monad/typeclass for building ASTs. The fundamental building block is BuilderT and its execution functions, but it is usually easier to use Builder.

See Futhark.Construct for a high-level description.

A concrete MonadBuilder monad.

data BuilderT rep m a

A monad transformer that tracks statements and provides a MonadBuilder 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 MonadBuilder from scratch, then it is likely that you are making a mistake.

Instances

MonadWriter w m => MonadWriter w (BuilderT rep m)

Defined in Futhark.Builder

Methods

writer :: (a, w) -> BuilderT rep m a

tell :: w -> BuilderT rep m ()

listen :: BuilderT rep m a -> BuilderT rep m (a, w)

pass :: BuilderT rep m (a, w -> w) -> BuilderT rep m a

MonadState s m => MonadState s (BuilderT rep m)

Defined in Futhark.Builder

Methods

get :: BuilderT rep m s

put :: s -> BuilderT rep m ()

state :: (s -> (a, s)) -> BuilderT rep m a

MonadReader r m => MonadReader r (BuilderT rep m)

Defined in Futhark.Builder

Methods

ask :: BuilderT rep m r

local :: (r -> r) -> BuilderT rep m a -> BuilderT rep m a

reader :: (r -> a) -> BuilderT rep m a

MonadError e m => MonadError e (BuilderT rep m)

Defined in Futhark.Builder

Methods

throwError :: e -> BuilderT rep m a

catchError :: BuilderT rep m a -> (e -> BuilderT rep m a) -> BuilderT rep m a

(ASTRep rep, Monad m) => LocalScope rep (BuilderT rep m)

Defined in Futhark.Builder

Methods

localScope :: Scope rep -> BuilderT rep m a -> BuilderT rep m a

(ASTRep rep, Monad m) => HasScope rep (BuilderT rep m)

Defined in Futhark.Builder

Methods

lookupType :: VName -> BuilderT rep m Type

lookupInfo :: VName -> BuilderT rep m (NameInfo rep)

askScope :: BuilderT rep m (Scope rep)

asksScope :: (Scope rep -> a) -> BuilderT rep m a

MonadTrans (BuilderT rep)

Defined in Futhark.Builder

Methods

lift :: Monad m => m a -> BuilderT rep m a

Monad m => Monad (BuilderT rep m)

Defined in Futhark.Builder

Methods

(>>=) :: BuilderT rep m a -> (a -> BuilderT rep m b) -> BuilderT rep m b

(>>) :: BuilderT rep m a -> BuilderT rep m b -> BuilderT rep m b

return :: a -> BuilderT rep m a

Functor m => Functor (BuilderT rep m)

Defined in Futhark.Builder

Methods

fmap :: (a -> b) -> BuilderT rep m a -> BuilderT rep m b

(<$) :: a -> BuilderT rep m b -> BuilderT rep m a

Monad m => Applicative (BuilderT rep m)

Defined in Futhark.Builder

Methods

pure :: a -> BuilderT rep m a

(<*>) :: BuilderT rep m (a -> b) -> BuilderT rep m a -> BuilderT rep m b

liftA2 :: (a -> b -> c) -> BuilderT rep m a -> BuilderT rep m b -> BuilderT rep m c

(*>) :: BuilderT rep m a -> BuilderT rep m b -> BuilderT rep m b

(<*) :: BuilderT rep m a -> BuilderT rep m b -> BuilderT rep m a

MonadFreshNames m => MonadFreshNames (BuilderT rep m)

Defined in Futhark.Builder

Methods

getNameSource :: BuilderT rep m VNameSource

putNameSource :: VNameSource -> BuilderT rep m ()

(ASTRep rep, MonadFreshNames m, BuilderOps rep) => MonadBuilder (BuilderT rep m)

Defined in Futhark.Builder

Associated Types

type Rep (BuilderT rep m)

Methods

mkExpDecM :: Pat (LetDec (Rep (BuilderT rep m))) -> Exp (Rep (BuilderT rep m)) -> BuilderT rep m (ExpDec (Rep (BuilderT rep m)))

mkBodyM :: Stms (Rep (BuilderT rep m)) -> Result -> BuilderT rep m (Body (Rep (BuilderT rep m)))

mkLetNamesM :: [VName] -> Exp (Rep (BuilderT rep m)) -> BuilderT rep m (Stm (Rep (BuilderT rep m)))

addStm :: Stm (Rep (BuilderT rep m)) -> BuilderT rep m ()

addStms :: Stms (Rep (BuilderT rep m)) -> BuilderT rep m ()

collectStms :: BuilderT rep m a -> BuilderT rep m (a, Stms (Rep (BuilderT rep m)))

certifying :: Certs -> BuilderT rep m a -> BuilderT rep m a

type Rep (BuilderT rep m)

Defined in Futhark.Builder

type Rep (BuilderT rep m) = rep

runBuilderT :: MonadFreshNames m => BuilderT rep m a -> Scope rep -> m (a, Stms rep)

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

runBuilderT_ :: MonadFreshNames m => BuilderT rep m () -> Scope rep -> m (Stms rep)

Like runBuilderT, but return only the statements.

runBuilderT' :: (MonadFreshNames m, HasScope somerep m, SameScope somerep rep) => BuilderT rep m a -> m (a, Stms rep)

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

runBuilderT'_ :: (MonadFreshNames m, HasScope somerep m, SameScope somerep rep) => BuilderT rep m a -> m (Stms rep)

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

class ASTRep rep => BuilderOps rep where

A BuilderT (and by extension, a Builder) is only an instance of MonadBuilder for representations that implement this type class, which contains methods for constructing statements.

Minimal complete definition

Nothing

Methods

mkExpDecB :: (MonadBuilder m, Rep m ~ rep) => Pat (LetDec rep) -> Exp rep -> m (ExpDec rep)

default mkExpDecB :: (MonadBuilder m, Buildable rep) => Pat (LetDec rep) -> Exp rep -> m (ExpDec rep)

mkBodyB :: (MonadBuilder m, Rep m ~ rep) => Stms rep -> Result -> m (Body rep)

default mkBodyB :: (MonadBuilder m, Buildable rep) => Stms rep -> Result -> m (Body rep)

mkLetNamesB :: (MonadBuilder m, Rep m ~ rep) => [VName] -> Exp rep -> m (Stm rep)

default mkLetNamesB :: (MonadBuilder m, Rep m ~ rep, Buildable rep) => [VName] -> Exp rep -> m (Stm rep)

Instances

BuilderOps Seq

Defined in Futhark.IR.Seq

Methods

mkExpDecB :: (MonadBuilder m, Rep m ~ Seq) => Pat (LetDec Seq) -> Exp Seq -> m (ExpDec Seq)

mkBodyB :: (MonadBuilder m, Rep m ~ Seq) => Stms Seq -> Result -> m (Body Seq)

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

BuilderOps SOACS

Defined in Futhark.IR.SOACS

Methods

mkExpDecB :: (MonadBuilder m, Rep m ~ SOACS) => Pat (LetDec SOACS) -> Exp SOACS -> m (ExpDec SOACS)

mkBodyB :: (MonadBuilder m, Rep m ~ SOACS) => Stms SOACS -> Result -> m (Body SOACS)

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

BuilderOps SeqMem

Defined in Futhark.IR.SeqMem

Methods

mkExpDecB :: (MonadBuilder m, Rep m ~ SeqMem) => Pat (LetDec SeqMem) -> Exp SeqMem -> m (ExpDec SeqMem)

mkBodyB :: (MonadBuilder m, Rep m ~ SeqMem) => Stms SeqMem -> Result -> m (Body SeqMem)

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

BuilderOps MCMem

Defined in Futhark.IR.MCMem

Methods

mkExpDecB :: (MonadBuilder m, Rep m ~ MCMem) => Pat (LetDec MCMem) -> Exp MCMem -> m (ExpDec MCMem)

mkBodyB :: (MonadBuilder m, Rep m ~ MCMem) => Stms MCMem -> Result -> m (Body MCMem)

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

BuilderOps MC

Defined in Futhark.IR.MC

Methods

mkExpDecB :: (MonadBuilder m, Rep m ~ MC) => Pat (LetDec MC) -> Exp MC -> m (ExpDec MC)

mkBodyB :: (MonadBuilder m, Rep m ~ MC) => Stms MC -> Result -> m (Body MC)

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

BuilderOps GPU

Defined in Futhark.IR.GPU

Methods

mkExpDecB :: (MonadBuilder m, Rep m ~ GPU) => Pat (LetDec GPU) -> Exp GPU -> m (ExpDec GPU)

mkBodyB :: (MonadBuilder m, Rep m ~ GPU) => Stms GPU -> Result -> m (Body GPU)

mkLetNamesB :: (MonadBuilder m, Rep m ~ GPU) => [VName] -> Exp GPU -> m (Stm GPU)

BuilderOps GPUMem

Defined in Futhark.IR.GPUMem

Methods

mkExpDecB :: (MonadBuilder m, Rep m ~ GPUMem) => Pat (LetDec GPUMem) -> Exp GPUMem -> m (ExpDec GPUMem)

mkBodyB :: (MonadBuilder m, Rep m ~ GPUMem) => Stms GPUMem -> Result -> m (Body GPUMem)

mkLetNamesB :: (MonadBuilder m, Rep m ~ GPUMem) => [VName] -> Exp GPUMem -> m (Stm GPUMem)

(ASTRep (Aliases rep), Buildable (Aliases rep)) => BuilderOps (Aliases rep)

Defined in Futhark.IR.Aliases

Methods

mkExpDecB :: (MonadBuilder m, Rep m ~ Aliases rep) => Pat (LetDec (Aliases rep)) -> Exp (Aliases rep) -> m (ExpDec (Aliases rep))

mkBodyB :: (MonadBuilder m, Rep m ~ Aliases rep) => Stms (Aliases rep) -> Result -> m (Body (Aliases rep))

mkLetNamesB :: (MonadBuilder m, Rep m ~ Aliases rep) => [VName] -> Exp (Aliases rep) -> m (Stm (Aliases rep))

BuilderOps (Wise Seq)

Defined in Futhark.IR.Seq

Methods

mkExpDecB :: (MonadBuilder m, Rep m ~ Wise Seq) => Pat (LetDec (Wise Seq)) -> Exp (Wise Seq) -> m (ExpDec (Wise Seq))

mkBodyB :: (MonadBuilder m, Rep m ~ Wise Seq) => Stms (Wise Seq) -> Result -> m (Body (Wise Seq))

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

BuilderOps (Wise SOACS)

Defined in Futhark.IR.SOACS.Simplify

Methods

mkExpDecB :: (MonadBuilder m, Rep m ~ Wise SOACS) => Pat (LetDec (Wise SOACS)) -> Exp (Wise SOACS) -> m (ExpDec (Wise SOACS))

mkBodyB :: (MonadBuilder m, Rep m ~ Wise SOACS) => Stms (Wise SOACS) -> Result -> m (Body (Wise SOACS))

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

BuilderOps (Wise SeqMem)

Defined in Futhark.IR.SeqMem

Methods

mkExpDecB :: (MonadBuilder m, Rep m ~ Wise SeqMem) => Pat (LetDec (Wise SeqMem)) -> Exp (Wise SeqMem) -> m (ExpDec (Wise SeqMem))

mkBodyB :: (MonadBuilder m, Rep m ~ Wise SeqMem) => Stms (Wise SeqMem) -> Result -> m (Body (Wise SeqMem))

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

BuilderOps (Wise MCMem)

Defined in Futhark.IR.MCMem

Methods

mkExpDecB :: (MonadBuilder m, Rep m ~ Wise MCMem) => Pat (LetDec (Wise MCMem)) -> Exp (Wise MCMem) -> m (ExpDec (Wise MCMem))

mkBodyB :: (MonadBuilder m, Rep m ~ Wise MCMem) => Stms (Wise MCMem) -> Result -> m (Body (Wise MCMem))

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

BuilderOps (Wise MC)

Defined in Futhark.IR.MC

Methods

mkExpDecB :: (MonadBuilder m, Rep m ~ Wise MC) => Pat (LetDec (Wise MC)) -> Exp (Wise MC) -> m (ExpDec (Wise MC))

mkBodyB :: (MonadBuilder m, Rep m ~ Wise MC) => Stms (Wise MC) -> Result -> m (Body (Wise MC))

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

BuilderOps (Wise GPU)

Defined in Futhark.IR.GPU.Simplify

Methods

mkExpDecB :: (MonadBuilder m, Rep m ~ Wise GPU) => Pat (LetDec (Wise GPU)) -> Exp (Wise GPU) -> m (ExpDec (Wise GPU))

mkBodyB :: (MonadBuilder m, Rep m ~ Wise GPU) => Stms (Wise GPU) -> Result -> m (Body (Wise GPU))

mkLetNamesB :: (MonadBuilder m, Rep m ~ Wise GPU) => [VName] -> Exp (Wise GPU) -> m (Stm (Wise GPU))

BuilderOps (Wise GPUMem)

Defined in Futhark.IR.GPUMem

Methods

mkExpDecB :: (MonadBuilder m, Rep m ~ Wise GPUMem) => Pat (LetDec (Wise GPUMem)) -> Exp (Wise GPUMem) -> m (ExpDec (Wise GPUMem))

mkBodyB :: (MonadBuilder m, Rep m ~ Wise GPUMem) => Stms (Wise GPUMem) -> Result -> m (Body (Wise GPUMem))

mkLetNamesB :: (MonadBuilder m, Rep m ~ Wise GPUMem) => [VName] -> Exp (Wise GPUMem) -> m (Stm (Wise GPUMem))

type Builder rep = BuilderT rep (State VNameSource)

The most commonly used binder monad.

runBuilder :: (MonadFreshNames m, HasScope somerep m, SameScope somerep rep) => Builder rep a -> m (a, Stms rep)

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.

runBuilder_ :: (MonadFreshNames m, HasScope somerep m, SameScope somerep rep) => Builder rep a -> m (Stms rep)

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

runBodyBuilder :: (Buildable rep, MonadFreshNames m, HasScope somerep m, SameScope somerep rep) => Builder rep (Body rep) -> m (Body rep)

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

The MonadBuilder typeclass

module Futhark.Builder.Class