Futhark.Binder.Class

This module defines a convenience typeclass for creating normalised programs.

Documentation

class (Attributes lore, FParamAttr lore ~ DeclType, LParamAttr lore ~ Type, RetType lore ~ DeclExtType, BranchType lore ~ ExtType, SetType (LetAttr 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

mkExpAttr :: Pattern lore -> Exp lore -> ExpAttr lore

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

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

Instances

Bindable SOACS

Defined in Futhark.Representation.SOACS

Methods

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

mkExpAttr :: Pattern SOACS -> Exp SOACS -> ExpAttr SOACS

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

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

Bindable InKernel

Defined in Futhark.Representation.Kernels

Methods

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

mkExpAttr :: Pattern InKernel -> Exp InKernel -> ExpAttr InKernel

mkBody :: Stms InKernel -> Result -> Body InKernel

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

Bindable Kernels

Defined in Futhark.Representation.Kernels

Methods

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

mkExpAttr :: Pattern Kernels -> Exp Kernels -> ExpAttr 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.Representation.Aliases

Methods

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

mkExpAttr :: Pattern (Aliases lore) -> Exp (Aliases lore) -> ExpAttr (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)

mkExpAttr :: Pattern (Wise lore) -> Exp (Wise lore) -> ExpAttr (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

class (Attributes (Lore m), MonadFreshNames m, Applicative m, Monad m, LocalScope (Lore m) m, MonadFail 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.

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

mkExpAttrM, mkBodyM, mkLetNamesM, addStms, collectStms, certifying

Associated Types

type Lore m :: *

Methods

mkExpAttrM :: Pattern (Lore m) -> Exp (Lore m) -> m (ExpAttr (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 ()

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

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

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

Instances

MonadBinder InternaliseM

Defined in Futhark.Internalise.Monad

Associated Types

type Lore InternaliseM :: Type

Methods

mkExpAttrM :: Pattern (Lore InternaliseM) -> Exp (Lore InternaliseM) -> InternaliseM (ExpAttr (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

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

Defined in Futhark.Optimise.Simplify.Rule

Associated Types

type Lore (RuleM lore) :: Type

Methods

mkExpAttrM :: Pattern (Lore (RuleM lore)) -> Exp (Lore (RuleM lore)) -> RuleM lore (ExpAttr (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

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

Defined in Futhark.Binder

Associated Types

type Lore (BinderT lore m) :: Type

Methods

mkExpAttrM :: Pattern (Lore (BinderT lore m)) -> Exp (Lore (BinderT lore m)) -> BinderT lore m (ExpAttr (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

mkLetM :: MonadBinder m => Pattern (Lore m) -> Exp (Lore m) -> m (Stm (Lore m))

bodyStms :: BodyT lore -> Stms lore

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

Add several bindings at the outermost level of a BodyT.

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

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

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

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

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

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

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

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

module Futhark.MonadFreshNames