Futhark.Binder.Class

This module defines a convenience typeclass for creating normalised programs.

See Futhark.Construct for a high-level description.

Documentation

class (ASTLore lore, FParamInfo lore ~ DeclType, LParamInfo lore ~ Type, RetType lore ~ DeclExtType, BranchType lore ~ ExtType, SetType (LetDec lore)) => Bindable lore where

The class of lores 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 MonadBinder instance, it is acceptable for them to create new bindings, however.

Methods

mkExpPat :: [Ident] -> [Ident] -> Exp lore -> Pattern lore

mkExpDec :: Pattern lore -> Exp lore -> ExpDec lore

mkBody :: Stms lore -> Result -> Body lore

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

Instances

Bindable Seq

Defined in Futhark.IR.Seq

Methods

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

mkExpDec :: Pattern Seq -> Exp Seq -> ExpDec Seq

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

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

Bindable SOACS

Defined in Futhark.IR.SOACS

Methods

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

mkExpDec :: Pattern SOACS -> Exp SOACS -> ExpDec SOACS

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

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

Bindable MC

Defined in Futhark.IR.MC

Methods

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

mkExpDec :: Pattern MC -> Exp MC -> ExpDec MC

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

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

Bindable Kernels

Defined in Futhark.IR.Kernels

Methods

mkExpPat :: [Ident] -> [Ident] -> Exp Kernels -> Pattern Kernels

mkExpDec :: Pattern Kernels -> Exp Kernels -> ExpDec Kernels

mkBody :: Stms Kernels -> Result -> Body Kernels

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

(Bindable lore, CanBeAliased (Op lore)) => Bindable (Aliases lore)

Defined in Futhark.IR.Aliases

Methods

mkExpPat :: [Ident] -> [Ident] -> Exp (Aliases lore) -> Pattern (Aliases lore)

mkExpDec :: Pattern (Aliases lore) -> Exp (Aliases lore) -> ExpDec (Aliases lore)

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

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

(Bindable lore, CanBeWise (Op lore)) => Bindable (Wise lore)

Defined in Futhark.Optimise.Simplify.Lore

Methods

mkExpPat :: [Ident] -> [Ident] -> Exp (Wise lore) -> Pattern (Wise lore)

mkExpDec :: Pattern (Wise lore) -> Exp (Wise lore) -> ExpDec (Wise lore)

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

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

mkLet :: Bindable lore => [Ident] -> [Ident] -> Exp lore -> Stm lore

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

mkLet' :: Bindable lore => [Ident] -> [Ident] -> StmAux a -> Exp lore -> Stm lore

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

class (ASTLore (Lore m), MonadFreshNames m, Applicative m, Monad m, LocalScope (Lore m) m) => MonadBinder m where

A monad that supports the creation of bindings from expressions and bodies from bindings, with a specific lore. 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 Lore m :: Type

Methods

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

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

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

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

Add a statement to the Stms under construction.

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

Add multiple statements to the Stms under construction.

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

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

certifying :: Certificates -> m a -> m a

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

Instances

MonadBinder InternaliseM

Defined in Futhark.Internalise.Monad

Associated Types

type Lore InternaliseM

Methods

mkExpDecM :: Pattern (Lore InternaliseM) -> Exp (Lore InternaliseM) -> InternaliseM (ExpDec (Lore InternaliseM))

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

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

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

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

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

certifying :: Certificates -> InternaliseM a -> InternaliseM a

(ASTLore lore, BinderOps lore) => MonadBinder (RuleM lore)

Defined in Futhark.Optimise.Simplify.Rule

Associated Types

type Lore (RuleM lore)

Methods

mkExpDecM :: Pattern (Lore (RuleM lore)) -> Exp (Lore (RuleM lore)) -> RuleM lore (ExpDec (Lore (RuleM lore)))

mkBodyM :: Stms (Lore (RuleM lore)) -> Result -> RuleM lore (Body (Lore (RuleM lore)))

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

addStm :: Stm (Lore (RuleM lore)) -> RuleM lore ()

addStms :: Stms (Lore (RuleM lore)) -> RuleM lore ()

collectStms :: RuleM lore a -> RuleM lore (a, Stms (Lore (RuleM lore)))

certifying :: Certificates -> RuleM lore a -> RuleM lore a

(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

(Allocable fromlore tolore, Allocator tolore (AllocM fromlore tolore)) => MonadBinder (AllocM fromlore tolore)

Defined in Futhark.Pass.ExplicitAllocations

Associated Types

type Lore (AllocM fromlore tolore)

Methods

mkExpDecM :: Pattern (Lore (AllocM fromlore tolore)) -> Exp (Lore (AllocM fromlore tolore)) -> AllocM fromlore tolore (ExpDec (Lore (AllocM fromlore tolore)))

mkBodyM :: Stms (Lore (AllocM fromlore tolore)) -> Result -> AllocM fromlore tolore (Body (Lore (AllocM fromlore tolore)))

mkLetNamesM :: [VName] -> Exp (Lore (AllocM fromlore tolore)) -> AllocM fromlore tolore (Stm (Lore (AllocM fromlore tolore)))

addStm :: Stm (Lore (AllocM fromlore tolore)) -> AllocM fromlore tolore ()

addStms :: Stms (Lore (AllocM fromlore tolore)) -> AllocM fromlore tolore ()

collectStms :: AllocM fromlore tolore a -> AllocM fromlore tolore (a, Stms (Lore (AllocM fromlore tolore)))

certifying :: Certificates -> AllocM fromlore tolore a -> AllocM fromlore tolore a

insertStms :: Bindable lore => Stms lore -> Body lore -> Body lore

Add several bindings at the outermost level of a Body.

insertStm :: Bindable lore => Stm lore -> Body lore -> Body lore

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

letBind :: MonadBinder m => Pattern (Lore m) -> Exp (Lore m) -> m ()

Add a statement with the given pattern and expression.

letBindNames :: MonadBinder m => [VName] -> Exp (Lore m) -> m ()

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

collectStms_ :: MonadBinder m => m a -> m (Stms (Lore m))

As collectStms, but throw away the ordinary result.

bodyBind :: MonadBinder m => Body (Lore m) -> m [SubExp]

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

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

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

auxing :: MonadBinder m => StmAux anylore -> m a -> m a

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

module Futhark.MonadFreshNames