Futhark.Builder.Class

This module defines a convenience typeclass for creating normalised programs.

See Futhark.Construct for a high-level description.

Documentation

class (ASTRep rep, FParamInfo rep ~ DeclType, LParamInfo rep ~ Type, RetType rep ~ DeclExtType, BranchType rep ~ ExtType, SetType (LetDec rep)) => Buildable rep where

The class of representations that can be constructed solely from an expression, within some monad. Very important: the methods should not have any significant side effects! They may be called more often than you think, and the results thrown away. If used exclusively within a MonadBuilder instance, it is acceptable for them to create new bindings, however.

Methods

mkExpPat :: [Ident] -> Exp rep -> Pat rep

mkExpDec :: Pat rep -> Exp rep -> ExpDec rep

mkBody :: Stms rep -> Result -> Body rep

mkLetNames :: (MonadFreshNames m, HasScope rep m) => [VName] -> Exp rep -> m (Stm rep)

Instances

Buildable Seq

Defined in Futhark.IR.Seq

Methods

mkExpPat :: [Ident] -> Exp Seq -> Pat Seq

mkExpDec :: Pat Seq -> Exp Seq -> ExpDec Seq

mkBody :: Stms Seq -> Result -> Body Seq

mkLetNames :: (MonadFreshNames m, HasScope Seq m) => [VName] -> Exp Seq -> m (Stm Seq)

Buildable SOACS

Defined in Futhark.IR.SOACS

Methods

mkExpPat :: [Ident] -> Exp SOACS -> Pat SOACS

mkExpDec :: Pat SOACS -> Exp SOACS -> ExpDec SOACS

mkBody :: Stms SOACS -> Result -> Body SOACS

mkLetNames :: (MonadFreshNames m, HasScope SOACS m) => [VName] -> Exp SOACS -> m (Stm SOACS)

Buildable MC

Defined in Futhark.IR.MC

Methods

mkExpPat :: [Ident] -> Exp MC -> Pat MC

mkExpDec :: Pat MC -> Exp MC -> ExpDec MC

mkBody :: Stms MC -> Result -> Body MC

mkLetNames :: (MonadFreshNames m, HasScope MC m) => [VName] -> Exp MC -> m (Stm MC)

Buildable GPU

Defined in Futhark.IR.GPU

Methods

mkExpPat :: [Ident] -> Exp GPU -> Pat GPU

mkExpDec :: Pat GPU -> Exp GPU -> ExpDec GPU

mkBody :: Stms GPU -> Result -> Body GPU

mkLetNames :: (MonadFreshNames m, HasScope GPU m) => [VName] -> Exp GPU -> m (Stm GPU)

(Buildable rep, CanBeAliased (Op rep)) => Buildable (Aliases rep)

Defined in Futhark.IR.Aliases

Methods

mkExpPat :: [Ident] -> Exp (Aliases rep) -> Pat (Aliases rep)

mkExpDec :: Pat (Aliases rep) -> Exp (Aliases rep) -> ExpDec (Aliases rep)

mkBody :: Stms (Aliases rep) -> Result -> Body (Aliases rep)

mkLetNames :: (MonadFreshNames m, HasScope (Aliases rep) m) => [VName] -> Exp (Aliases rep) -> m (Stm (Aliases rep))

(Buildable rep, CanBeWise (Op rep)) => Buildable (Wise rep)

Defined in Futhark.Optimise.Simplify.Rep

Methods

mkExpPat :: [Ident] -> Exp (Wise rep) -> Pat (Wise rep)

mkExpDec :: Pat (Wise rep) -> Exp (Wise rep) -> ExpDec (Wise rep)

mkBody :: Stms (Wise rep) -> Result -> Body (Wise rep)

mkLetNames :: (MonadFreshNames m, HasScope (Wise rep) m) => [VName] -> Exp (Wise rep) -> m (Stm (Wise rep))

mkLet :: Buildable rep => [Ident] -> Exp rep -> Stm rep

Construct a Stm from identifiers for the context- and value part of the pattern, as well as the expression.

mkLet' :: Buildable rep => [Ident] -> StmAux a -> Exp rep -> Stm rep

Like mkLet, but also take attributes and certificates from the given StmAux.

class (ASTRep (Rep m), MonadFreshNames m, Applicative m, Monad m, LocalScope (Rep m) m) => MonadBuilder m where

A monad that supports the creation of bindings from expressions and bodies from bindings, with a specific rep. This is the main typeclass that a monad must implement in order for it to be useful for generating or modifying Futhark code. Most importantly maintains a current state of Stms (as well as a Scope) that have been added with addStm.

Very important: the methods should not have any significant side effects! They may be called more often than you think, and the results thrown away. It is acceptable for them to create new bindings, however.

Minimal complete definition

mkExpDecM, mkBodyM, mkLetNamesM, addStms, collectStms

Associated Types

type Rep m :: Type

Methods

mkExpDecM :: Pat (Rep m) -> Exp (Rep m) -> m (ExpDec (Rep m))

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

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

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

Add a statement to the Stms under construction.

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

Add multiple statements to the Stms under construction.

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

Obtain the statements constructed during a monadic action, instead of adding them to the state.

certifying :: Certs -> m a -> m a

Add the provided certificates to any statements added during execution of the action.

Instances

MonadBuilder InternaliseM

Defined in Futhark.Internalise.Monad

Associated Types

type Rep InternaliseM

Methods

mkExpDecM :: Pat (Rep InternaliseM) -> Exp (Rep InternaliseM) -> InternaliseM (ExpDec (Rep InternaliseM))

mkBodyM :: Stms (Rep InternaliseM) -> Result -> InternaliseM (Body (Rep InternaliseM))

mkLetNamesM :: [VName] -> Exp (Rep InternaliseM) -> InternaliseM (Stm (Rep InternaliseM))

addStm :: Stm (Rep InternaliseM) -> InternaliseM ()

addStms :: Stms (Rep InternaliseM) -> InternaliseM ()

collectStms :: InternaliseM a -> InternaliseM (a, Stms (Rep InternaliseM))

certifying :: Certs -> InternaliseM a -> InternaliseM a

(ASTRep rep, BuilderOps rep) => MonadBuilder (RuleM rep)

Defined in Futhark.Optimise.Simplify.Rule

Associated Types

type Rep (RuleM rep)

Methods

mkExpDecM :: Pat (Rep (RuleM rep)) -> Exp (Rep (RuleM rep)) -> RuleM rep (ExpDec (Rep (RuleM rep)))

mkBodyM :: Stms (Rep (RuleM rep)) -> Result -> RuleM rep (Body (Rep (RuleM rep)))

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

addStm :: Stm (Rep (RuleM rep)) -> RuleM rep ()

addStms :: Stms (Rep (RuleM rep)) -> RuleM rep ()

collectStms :: RuleM rep a -> RuleM rep (a, Stms (Rep (RuleM rep)))

certifying :: Certs -> RuleM rep a -> RuleM rep a

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

Defined in Futhark.Builder

Associated Types

type Rep (BuilderT rep m)

Methods

mkExpDecM :: Pat (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

Allocable fromrep torep inner => MonadBuilder (AllocM fromrep torep)

Defined in Futhark.Pass.ExplicitAllocations

Associated Types

type Rep (AllocM fromrep torep)

Methods

mkExpDecM :: Pat (Rep (AllocM fromrep torep)) -> Exp (Rep (AllocM fromrep torep)) -> AllocM fromrep torep (ExpDec (Rep (AllocM fromrep torep)))

mkBodyM :: Stms (Rep (AllocM fromrep torep)) -> Result -> AllocM fromrep torep (Body (Rep (AllocM fromrep torep)))

mkLetNamesM :: [VName] -> Exp (Rep (AllocM fromrep torep)) -> AllocM fromrep torep (Stm (Rep (AllocM fromrep torep)))

addStm :: Stm (Rep (AllocM fromrep torep)) -> AllocM fromrep torep ()

addStms :: Stms (Rep (AllocM fromrep torep)) -> AllocM fromrep torep ()

collectStms :: AllocM fromrep torep a -> AllocM fromrep torep (a, Stms (Rep (AllocM fromrep torep)))

certifying :: Certs -> AllocM fromrep torep a -> AllocM fromrep torep a

insertStms :: Buildable rep => Stms rep -> Body rep -> Body rep

Add several bindings at the outermost level of a Body.

insertStm :: Buildable rep => Stm rep -> Body rep -> Body rep

Add a single binding at the outermost level of a Body.

letBind :: MonadBuilder m => Pat (Rep m) -> Exp (Rep m) -> m ()

Add a statement with the given pattern and expression.

letBindNames :: MonadBuilder m => [VName] -> Exp (Rep m) -> m ()

Add a statement with the given pattern element names and expression.

collectStms_ :: MonadBuilder m => m a -> m (Stms (Rep m))

As collectStms, but throw away the ordinary result.

bodyBind :: MonadBuilder m => Body (Rep m) -> m Result

Add the statements of the body, then return the body result.

attributing :: MonadBuilder m => Attrs -> m a -> m a

Add the given attributes to any statements added by this action.

auxing :: MonadBuilder m => StmAux anyrep -> m a -> m a

Add the certificates and attributes to any statements added by this action.

module Futhark.MonadFreshNames