Futhark.Transform.Rename

This module provides facilities for transforming Futhark programs such that names are unique, via the renameProg function. Additionally, the module also supports adding integral "tags" to names (incarnated as the ID type), in order to support more efficient comparisons and renamings. This is done by tagProg. The intent is that you call tagProg once at some early stage, then use renameProg from then on. Functions are also provided for removing the tags again from expressions, patterns and typs.

Renaming programs

renameProg :: (Renameable lore, MonadFreshNames m) => Prog lore -> m (Prog lore)

Rename variables such that each is unique. The semantics of the program are unaffected, under the assumption that the program was correct to begin with. In particular, the renaming may make an invalid program valid.

Renaming parts of a program.

renameExp :: (Renameable lore, MonadFreshNames m) => Exp lore -> m (Exp lore)

Rename bound variables such that each is unique. The semantics of the expression is unaffected, under the assumption that the expression was correct to begin with. Any free variables are left untouched.

renameStm :: (Renameable lore, MonadFreshNames m) => Stm lore -> m (Stm lore)

Rename bound variables such that each is unique. The semantics of the binding is unaffected, under the assumption that the binding was correct to begin with. Any free variables are left untouched, as are the names in the pattern of the binding.

renameBody :: (Renameable lore, MonadFreshNames m) => Body lore -> m (Body lore)

Rename bound variables such that each is unique. The semantics of the body is unaffected, under the assumption that the body was correct to begin with. Any free variables are left untouched.

renameLambda :: (Renameable lore, MonadFreshNames m) => Lambda lore -> m (Lambda lore)

Rename bound variables such that each is unique. The semantics of the lambda is unaffected, under the assumption that the body was correct to begin with. Any free variables are left untouched. Note in particular that the parameters of the lambda are renamed.

renameFun :: (Renameable lore, MonadFreshNames m) => FunDef lore -> m (FunDef lore)

Rename bound variables such that each is unique. The semantics of the function is unaffected, under the assumption that the body was correct to begin with. Any free variables are left untouched. Note in particular that the parameters of the lambda are renamed.

renamePattern :: (Rename attr, MonadFreshNames m) => PatternT attr -> m (PatternT attr)

Produce an equivalent pattern but with each pattern element given a new name.

Renaming annotations

type RenameM = StateT VNameSource (Reader RenameEnv)

The monad in which renaming is performed.

substituteRename :: Substitute a => a -> RenameM a

Perform a renaming using the Substitute instance. This only works if the argument does not itself perform any name binding, but it can save on boilerplate for simple types.

bindingForRename :: [VName] -> RenameM a -> RenameM a

Create a bunch of new names and bind them for substitution.

renamingStms :: Renameable lore => Stms lore -> (Stms lore -> RenameM a) -> RenameM a

Rename some statements, then execute an action with the name substitutions induced by the statements active.

class Rename a where

Members of class Rename can be uniquely renamed.

Methods

rename :: a -> RenameM a

Rename the given value such that it does not contain shadowing, and has incorporated any substitutions present in the RenameM environment.

Instances

Rename Bool

Defined in Futhark.Transform.Rename

Methods

rename :: Bool -> RenameM Bool

Rename ()

Defined in Futhark.Transform.Rename

Methods

rename :: () -> RenameM ()

Rename VName

Defined in Futhark.Transform.Rename

Methods

rename :: VName -> RenameM VName

Rename Names

Defined in Futhark.Transform.Rename

Methods

rename :: Names -> RenameM Names

Rename SubExp

Defined in Futhark.Transform.Rename

Methods

rename :: SubExp -> RenameM SubExp

Rename Certificates

Defined in Futhark.Transform.Rename

Methods

rename :: Certificates -> RenameM Certificates

Rename Ident

Defined in Futhark.Transform.Rename

Methods

rename :: Ident -> RenameM Ident

Rename Rank

Defined in Futhark.Transform.Rename

Methods

rename :: Rank -> RenameM Rank

Rename ExtSize

Defined in Futhark.Transform.Rename

Methods

rename :: ExtSize -> RenameM ExtSize

Rename ScalExp

Defined in Futhark.Analysis.ScalExp

Methods

rename :: ScalExp -> RenameM ScalExp

Rename KnownBound

Defined in Futhark.Representation.AST.Attributes.Ranges

Methods

rename :: KnownBound -> RenameM KnownBound

Rename Names'

Defined in Futhark.Representation.Aliases

Methods

rename :: Names' -> RenameM Names'

Rename ExpWisdom

Defined in Futhark.Optimise.Simplify.Lore

Methods

rename :: ExpWisdom -> RenameM ExpWisdom

Rename VarWisdom

Defined in Futhark.Optimise.Simplify.Lore

Methods

rename :: VarWisdom -> RenameM VarWisdom

Rename CombineSpace

Defined in Futhark.Representation.Kernels.KernelExp

Methods

rename :: CombineSpace -> RenameM CombineSpace

Rename SplitOrdering

Defined in Futhark.Representation.Kernels.KernelExp

Methods

rename :: SplitOrdering -> RenameM SplitOrdering

Rename WhichThreads

Defined in Futhark.Representation.Kernels.Kernel

Methods

rename :: WhichThreads -> RenameM WhichThreads

Rename KernelResult

Defined in Futhark.Representation.Kernels.Kernel

Methods

rename :: KernelResult -> RenameM KernelResult

Rename MemReturn

Defined in Futhark.Representation.ExplicitMemory

Methods

rename :: MemReturn -> RenameM MemReturn

Rename MemBind

Defined in Futhark.Representation.ExplicitMemory

Methods

rename :: MemBind -> RenameM MemBind

Rename a => Rename [a]

Defined in Futhark.Transform.Rename

Methods

rename :: [a] -> RenameM [a]

Rename a => Rename (Maybe a)

Defined in Futhark.Transform.Rename

Methods

rename :: Maybe a -> RenameM (Maybe a)

Rename attr => Rename (PatElemT attr)

Defined in Futhark.Transform.Rename

Methods

rename :: PatElemT attr -> RenameM (PatElemT attr)

Rename d => Rename (DimIndex d)

Defined in Futhark.Transform.Rename

Methods

rename :: DimIndex d -> RenameM (DimIndex d)

Rename attr => Rename (ParamT attr)

Defined in Futhark.Transform.Rename

Methods

rename :: ParamT attr -> RenameM (ParamT attr)

Rename d => Rename (ShapeBase d)

Defined in Futhark.Transform.Rename

Methods

rename :: ShapeBase d -> RenameM (ShapeBase d)

Renameable lore => Rename (FunDef lore)

Defined in Futhark.Transform.Rename

Methods

rename :: FunDef lore -> RenameM (FunDef lore)

Renameable lore => Rename (Lambda lore)

Defined in Futhark.Transform.Rename

Methods

rename :: Lambda lore -> RenameM (Lambda lore)

Renameable lore => Rename (Exp lore)

Defined in Futhark.Transform.Rename

Methods

rename :: Exp lore -> RenameM (Exp lore)

Renameable lore => Rename (Body lore)

Defined in Futhark.Transform.Rename

Methods

rename :: Body lore -> RenameM (Body lore)

Renameable lore => Rename (Stm lore)

Defined in Futhark.Transform.Rename

Methods

rename :: Stm lore -> RenameM (Stm lore)

Rename attr => Rename (StmAux attr)

Defined in Futhark.Transform.Rename

Methods

rename :: StmAux attr -> RenameM (StmAux attr)

Rename attr => Rename (PatternT attr)

Defined in Futhark.Transform.Rename

Methods

rename :: PatternT attr -> RenameM (PatternT attr)

Substitute num => Rename (IxFun num)

Defined in Futhark.Representation.ExplicitMemory.IndexFunction

Methods

rename :: IxFun num -> RenameM (IxFun num)

Attributes lore => Rename (SOAC lore)

Defined in Futhark.Representation.SOACS.SOAC

Methods

rename :: SOAC lore -> RenameM (SOAC lore)

Renameable lore => Rename (GroupStreamLambda lore)

Defined in Futhark.Representation.Kernels.KernelExp

Methods

rename :: GroupStreamLambda lore -> RenameM (GroupStreamLambda lore)

Renameable lore => Rename (KernelExp lore)

Defined in Futhark.Representation.Kernels.KernelExp

Methods

rename :: KernelExp lore -> RenameM (KernelExp lore)

Attributes lore => Rename (KernelBody lore)

Defined in Futhark.Representation.Kernels.Kernel

Methods

rename :: KernelBody lore -> RenameM (KernelBody lore)

Attributes lore => Rename (Kernel lore)

Defined in Futhark.Representation.Kernels.Kernel

Methods

rename :: Kernel lore -> RenameM (Kernel lore)

Rename inner => Rename (MemOp inner)

Defined in Futhark.Representation.ExplicitMemory

Methods

rename :: MemOp inner -> RenameM (MemOp inner)

(Rename a, Rename b) => Rename (a, b)

Defined in Futhark.Transform.Rename

Methods

rename :: (a, b) -> RenameM (a, b)

Rename shape => Rename (TypeBase shape u)

Defined in Futhark.Transform.Rename

Methods

rename :: TypeBase shape u -> RenameM (TypeBase shape u)

Rename inner => Rename (HostOp lore inner)

Defined in Futhark.Representation.Kernels.Kernel

Methods

rename :: HostOp lore inner -> RenameM (HostOp lore inner)

(Rename a, Rename b, Rename c) => Rename (a, b, c)

Defined in Futhark.Transform.Rename

Methods

rename :: (a, b, c) -> RenameM (a, b, c)

(Substitute d, Substitute ret) => Rename (MemInfo d u ret)

Defined in Futhark.Representation.ExplicitMemory

Methods

rename :: MemInfo d u ret -> RenameM (MemInfo d u ret)

type Renameable lore = (Rename (LetAttr lore), Rename (ExpAttr lore), Rename (BodyAttr lore), Rename (FParamAttr lore), Rename (LParamAttr lore), Rename (RetType lore), Rename (BranchType lore), Rename (Op lore))

Lores in which all annotations are renameable.