Futhark.IR.Prop.Names

Facilities for determining which names are used in some syntactic construct. The most important interface is the FreeIn class and its instances, but for reasons related to the Haskell type system, some constructs have specialised functions.

Free names

data Names

A set of names. Note that the Ord instance is a dummy that treats everything as EQ if ==, and otherwise LT.

Instances

Monoid Names

Defined in Futhark.IR.Prop.Names

Methods

mempty :: Names

mappend :: Names -> Names -> Names

mconcat :: [Names] -> Names

Semigroup Names

Defined in Futhark.IR.Prop.Names

Methods

(<>) :: Names -> Names -> Names

sconcat :: NonEmpty Names -> Names

stimes :: Integral b => b -> Names -> Names

Show Names

Defined in Futhark.IR.Prop.Names

Methods

showsPrec :: Int -> Names -> ShowS

show :: Names -> String

showList :: [Names] -> ShowS

AliasesOf Names

Defined in Futhark.IR.Prop.Aliases

Methods

aliasesOf :: Names -> Names

FreeDec Names

Defined in Futhark.IR.Prop.Names

Methods

precomputed :: Names -> FV -> FV

FreeIn Names

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Names -> FV

Rename Names

Defined in Futhark.Transform.Rename

Methods

rename :: Names -> RenameM Names

Substitute Names

Defined in Futhark.Transform.Substitute

Methods

substituteNames :: Map VName VName -> Names -> Names

Eq Names

Defined in Futhark.IR.Prop.Names

Methods

(==) :: Names -> Names -> Bool

(/=) :: Names -> Names -> Bool

Ord Names

Defined in Futhark.IR.Prop.Names

Methods

compare :: Names -> Names -> Ordering

(<) :: Names -> Names -> Bool

(<=) :: Names -> Names -> Bool

(>) :: Names -> Names -> Bool

(>=) :: Names -> Names -> Bool

max :: Names -> Names -> Names

min :: Names -> Names -> Names

Pretty Names

Defined in Futhark.IR.Prop.Names

Methods

pretty :: Names -> Doc ann

prettyList :: [Names] -> Doc ann

namesIntMap :: Names -> IntMap VName

Retrieve the data structure underlying the names representation.

namesIntSet :: Names -> IntSet

Retrieve the set of tags in the names set.

nameIn :: VName -> Names -> Bool

Does the set of names contain this name?

notNameIn :: VName -> Names -> Bool

Does the set of names not contain this name?

oneName :: VName -> Names

Construct a name set from a single name.

namesFromList :: [VName] -> Names

Construct a name set from a list. Slow.

namesToList :: Names -> [VName]

Turn a name set into a list of names. Slow.

namesIntersection :: Names -> Names -> Names

The intersection of two name sets.

namesIntersect :: Names -> Names -> Bool

Do the two name sets intersect?

namesSubtract :: Names -> Names -> Names

Subtract the latter name set from the former.

mapNames :: (VName -> VName) -> Names -> Names

Map over the names in a set.

Class

class FreeIn a where

A class indicating that we can obtain free variable information from values of this type.

Minimal complete definition

Nothing

Methods

freeIn' :: a -> FV

Instances

FreeIn Indexed

Defined in Futhark.Analysis.SymbolTable

Methods

freeIn' :: Indexed -> FV

FreeIn Arg

Defined in Futhark.CodeGen.ImpCode

Methods

freeIn' :: Arg -> FV

FreeIn EntryPoint

Defined in Futhark.CodeGen.ImpCode

Methods

freeIn' :: EntryPoint -> FV

FreeIn ExternalValue

Defined in Futhark.CodeGen.ImpCode

Methods

freeIn' :: ExternalValue -> FV

FreeIn ValueDesc

Defined in Futhark.CodeGen.ImpCode

Methods

freeIn' :: ValueDesc -> FV

FreeIn AtomicOp

Defined in Futhark.CodeGen.ImpCode.GPU

Methods

freeIn' :: AtomicOp -> FV

FreeIn HostOp

Defined in Futhark.CodeGen.ImpCode.GPU

Methods

freeIn' :: HostOp -> FV

FreeIn Kernel

Defined in Futhark.CodeGen.ImpCode.GPU

Methods

freeIn' :: Kernel -> FV

FreeIn KernelConst

Defined in Futhark.CodeGen.ImpCode.GPU

Methods

freeIn' :: KernelConst -> FV

FreeIn KernelOp

Defined in Futhark.CodeGen.ImpCode.GPU

Methods

freeIn' :: KernelOp -> FV

FreeIn AtomicOp

Defined in Futhark.CodeGen.ImpCode.Multicore

Methods

freeIn' :: AtomicOp -> FV

FreeIn Multicore

Defined in Futhark.CodeGen.ImpCode.Multicore

Methods

freeIn' :: Multicore -> FV

FreeIn ParallelTask

Defined in Futhark.CodeGen.ImpCode.Multicore

Methods

freeIn' :: ParallelTask -> FV

FreeIn SchedulerInfo

Defined in Futhark.CodeGen.ImpCode.Multicore

Methods

freeIn' :: SchedulerInfo -> FV

FreeIn Sequential

Defined in Futhark.CodeGen.ImpCode.Sequential

Methods

freeIn' :: Sequential -> FV

FreeIn AliasDec

Defined in Futhark.IR.Aliases

Methods

freeIn' :: AliasDec -> FV

FreeIn KernelGrid

Defined in Futhark.IR.GPU.Op

Methods

freeIn' :: KernelGrid -> FV

FreeIn SegLevel

Defined in Futhark.IR.GPU.Op

Methods

freeIn' :: SegLevel -> FV

FreeIn SizeOp

Defined in Futhark.IR.GPU.Op

Methods

freeIn' :: SizeOp -> FV

FreeIn MemBind

Defined in Futhark.IR.Mem

Methods

freeIn' :: MemBind -> FV

FreeIn MemReturn

Defined in Futhark.IR.Mem

Methods

freeIn' :: MemReturn -> FV

FreeIn Interval

Defined in Futhark.IR.Mem.Interval

Methods

freeIn' :: Interval -> FV

FreeIn FV

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: FV -> FV

FreeIn Names

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Names -> FV

FreeIn KernelResult

Defined in Futhark.IR.SegOp

Methods

freeIn' :: KernelResult -> FV

FreeIn SubExpRes

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: SubExpRes -> FV

FreeIn Attrs

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Attrs -> FV

FreeIn Certs

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Certs -> FV

FreeIn Ident

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Ident -> FV

FreeIn Space

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Space -> FV

FreeIn SubExp

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: SubExp -> FV

FreeIn AccessSummary

Defined in Futhark.Optimise.ArrayShortCircuiting.DataStructs

Methods

freeIn' :: AccessSummary -> FV

FreeIn ExpWisdom

Defined in Futhark.Optimise.Simplify.Rep

Methods

freeIn' :: ExpWisdom -> FV

FreeIn VarWisdom

Defined in Futhark.Optimise.Simplify.Rep

Methods

freeIn' :: VarWisdom -> FV

FreeIn LoopNesting

Defined in Futhark.Pass.ExtractKernels.Distribution

Methods

freeIn' :: LoopNesting -> FV

FreeIn VName

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: VName -> FV

FreeIn PrimType

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: PrimType -> FV

FreeIn ()

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: () -> FV

FreeIn Bool

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Bool -> FV

FreeIn Int

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Int -> FV

FreeIn a => FreeIn (Set a)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Set a -> FV

FreeIn v => FreeIn (PrimExp v)

Defined in Futhark.Analysis.PrimExp

Methods

freeIn' :: PrimExp v -> FV

FreeIn a => FreeIn (Code a)

Defined in Futhark.CodeGen.ImpCode

Methods

freeIn' :: Code a -> FV

FreeIn a => FreeIn (Functions a)

Defined in Futhark.CodeGen.ImpCode

Methods

freeIn' :: Functions a -> FV

FreeIn num => FreeIn (IxFun num)

Defined in Futhark.IR.Mem.IxFun

Methods

freeIn' :: IxFun num -> FV

FreeIn num => FreeIn (LMAD num)

Defined in Futhark.IR.Mem.IxFun

Methods

freeIn' :: LMAD num -> FV

FreeIn num => FreeIn (LMADDim num)

Defined in Futhark.IR.Mem.IxFun

Methods

freeIn' :: LMADDim num -> FV

ASTRep rep => FreeIn (HistOp rep)

Defined in Futhark.IR.SOACS.SOAC

Methods

freeIn' :: HistOp rep -> FV

ASTRep rep => FreeIn (Reduce rep)

Defined in Futhark.IR.SOACS.SOAC

Methods

freeIn' :: Reduce rep -> FV

ASTRep rep => FreeIn (SOAC rep)

Defined in Futhark.IR.SOACS.SOAC

Methods

freeIn' :: SOAC rep -> FV

ASTRep rep => FreeIn (Scan rep)

Defined in Futhark.IR.SOACS.SOAC

Methods

freeIn' :: Scan rep -> FV

ASTRep rep => FreeIn (ScremaForm rep)

Defined in Futhark.IR.SOACS.SOAC

Methods

freeIn' :: ScremaForm rep -> FV

ASTRep rep => FreeIn (KernelBody rep)

Defined in Futhark.IR.SegOp

Methods

freeIn' :: KernelBody rep -> FV

(FreeDec (ExpDec rep), FreeDec (BodyDec rep), FreeIn (FParamInfo rep), FreeIn (LParamInfo rep), FreeIn (LetDec rep), FreeIn (RetType rep), FreeIn (BranchType rep), FreeIn (Op rep)) => FreeIn (Body rep)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Body rep -> FV

FreeIn body => FreeIn (Case body)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Case body -> FV

(FreeDec (ExpDec rep), FreeDec (BodyDec rep), FreeIn (FParamInfo rep), FreeIn (LParamInfo rep), FreeIn (LetDec rep), FreeIn (RetType rep), FreeIn (BranchType rep), FreeIn (Op rep)) => FreeIn (Exp rep)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Exp rep -> FV

(FreeDec (ExpDec rep), FreeDec (BodyDec rep), FreeIn (FParamInfo rep), FreeIn (LParamInfo rep), FreeIn (LetDec rep), FreeIn (RetType rep), FreeIn (BranchType rep), FreeIn (Op rep)) => FreeIn (FunDef rep)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: FunDef rep -> FV

(FreeDec (ExpDec rep), FreeDec (BodyDec rep), FreeIn (FParamInfo rep), FreeIn (LParamInfo rep), FreeIn (LetDec rep), FreeIn (RetType rep), FreeIn (BranchType rep), FreeIn (Op rep)) => FreeIn (Lambda rep)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Lambda rep -> FV

FreeIn (LParamInfo rep) => FreeIn (LoopForm rep)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: LoopForm rep -> FV

FreeIn a => FreeIn (MatchDec a)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: MatchDec a -> FV

FreeIn dec => FreeIn (Pat dec)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Pat dec -> FV

(FreeDec (ExpDec rep), FreeDec (BodyDec rep), FreeIn (FParamInfo rep), FreeIn (LParamInfo rep), FreeIn (LetDec rep), FreeIn (RetType rep), FreeIn (BranchType rep), FreeIn (Op rep)) => FreeIn (Stm rep)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Stm rep -> FV

FreeIn dec => FreeIn (StmAux dec)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: StmAux dec -> FV

FreeIn (Stm rep) => FreeIn (Stms rep)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Stms rep -> FV

FreeIn d => FreeIn (DimIndex d)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: DimIndex d -> FV

FreeIn d => FreeIn (Ext d)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Ext d -> FV

FreeIn d => FreeIn (FlatDimIndex d)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: FlatDimIndex d -> FV

FreeIn d => FreeIn (FlatSlice d)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: FlatSlice d -> FV

FreeIn dec => FreeIn (Param dec)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Param dec -> FV

FreeIn dec => FreeIn (PatElem dec)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: PatElem dec -> FV

FreeIn d => FreeIn (ShapeBase d)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: ShapeBase d -> FV

FreeIn d => FreeIn (Slice d)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Slice d -> FV

FreeIn a => FreeIn (Maybe a)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Maybe a -> FV

FreeIn a => FreeIn [a]

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: [a] -> FV

(FreeIn a, FreeIn b) => FreeIn (Either a b)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Either a b -> FV

(ASTRep rep, FreeIn (op rep)) => FreeIn (HostOp op rep)

Defined in Futhark.IR.GPU.Op

Methods

freeIn' :: HostOp op rep -> FV

(ASTRep rep, FreeIn (op rep)) => FreeIn (MCOp op rep)

Defined in Futhark.IR.MC.Op

Methods

freeIn' :: MCOp op rep -> FV

FreeIn (inner rep) => FreeIn (MemOp inner rep)

Defined in Futhark.IR.Mem

Methods

freeIn' :: MemOp inner rep -> FV

FreeIn (NoOp rep)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: NoOp rep -> FV

(ASTRep rep, FreeIn lvl) => FreeIn (SegOp lvl rep)

Defined in Futhark.IR.SegOp

Methods

freeIn' :: SegOp lvl rep -> FV

FreeIn shape => FreeIn (TypeBase shape u)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: TypeBase shape u -> FV

(FreeIn a, FreeIn b) => FreeIn (a, b)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: (a, b) -> FV

FreeIn v => FreeIn (TPrimExp t v)

Defined in Futhark.Analysis.PrimExp

Methods

freeIn' :: TPrimExp t v -> FV

FreeIn e => FreeIn (Count u e)

Defined in Futhark.IR.GPU.Sizes

Methods

freeIn' :: Count u e -> FV

(FreeIn d, FreeIn ret) => FreeIn (MemInfo d u ret)

Defined in Futhark.IR.Mem

Methods

freeIn' :: MemInfo d u ret -> FV

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

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: (a, b, c) -> FV

(FreeIn a, FreeIn b, FreeIn c, FreeIn d) => FreeIn (a, b, c, d)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: (a, b, c, d) -> FV

freeIn :: FreeIn a => a -> Names

The free variables of some syntactic construct.

Specialised Functions

freeInStmsAndRes :: (FreeIn (Op rep), FreeIn (LetDec rep), FreeIn (LParamInfo rep), FreeIn (FParamInfo rep), FreeDec (BodyDec rep), FreeIn (RetType rep), FreeIn (BranchType rep), FreeDec (ExpDec rep)) => Stms rep -> Result -> FV

Return the set of variable names that are free in the given statements and result. Filters away the names that are bound by the statements.

Bound Names

boundInBody :: Body rep -> Names

The names bound by the bindings immediately in a Body.

boundByStm :: Stm rep -> Names

The names bound by a binding.

boundByStms :: Stms rep -> Names

The names bound by the bindings.

boundByLambda :: Lambda rep -> [VName]

The names of the lambda parameters plus the index parameter.

Efficient computation

class FreeIn dec => FreeDec dec where

Either return precomputed free names stored in the attribute, or the freshly computed names. Relies on lazy evaluation to avoid the work.

Minimal complete definition

Nothing

Methods

precomputed :: dec -> FV -> FV

Instances

FreeDec AliasDec

Defined in Futhark.IR.Aliases

Methods

precomputed :: AliasDec -> FV -> FV

FreeDec Names

Defined in Futhark.IR.Prop.Names

Methods

precomputed :: Names -> FV -> FV

FreeDec ExpWisdom

Defined in Futhark.Optimise.Simplify.Rep

Methods

precomputed :: ExpWisdom -> FV -> FV

FreeDec ()

Defined in Futhark.IR.Prop.Names

Methods

precomputed :: () -> FV -> FV

FreeDec a => FreeDec (Maybe a)

Defined in Futhark.IR.Prop.Names

Methods

precomputed :: Maybe a -> FV -> FV

FreeDec a => FreeDec [a]

Defined in Futhark.IR.Prop.Names

Methods

precomputed :: [a] -> FV -> FV

(FreeDec a, FreeIn b) => FreeDec (a, b)

Defined in Futhark.IR.Prop.Names

Methods

precomputed :: (a, b) -> FV -> FV

data FV

A computation to build a free variable set.

Instances

Monoid FV

Defined in Futhark.IR.Prop.Names

Methods

mempty :: FV

mappend :: FV -> FV -> FV

mconcat :: [FV] -> FV

Semigroup FV

Defined in Futhark.IR.Prop.Names

Methods

(<>) :: FV -> FV -> FV

sconcat :: NonEmpty FV -> FV

stimes :: Integral b => b -> FV -> FV

FreeIn FV

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: FV -> FV

Substitute FV

Defined in Futhark.Transform.Substitute

Methods

substituteNames :: Map VName VName -> FV -> FV

fvBind :: Names -> FV -> FV

Consider a variable to be bound in the given FV computation.

fvName :: VName -> FV

Take note of a variable reference.

fvNames :: Names -> FV

Take note of a set of variable references.