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

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

Show Names

Defined in Futhark.IR.Prop.Names

Methods

showsPrec :: Int -> Names -> ShowS

show :: Names -> String

showList :: [Names] -> ShowS

Generic Names

Defined in Futhark.IR.Prop.Names

Associated Types

type Rep Names :: Type -> Type

Methods

from :: Names -> Rep Names x

to :: Rep Names x -> Names

Semigroup Names

Defined in Futhark.IR.Prop.Names

Methods

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

sconcat :: NonEmpty Names -> Names

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

Monoid Names

Defined in Futhark.IR.Prop.Names

Methods

mempty :: Names

mappend :: Names -> Names -> Names

mconcat :: [Names] -> Names

Pretty Names

Defined in Futhark.IR.Prop.Names

Methods

ppr :: Names -> Doc

pprPrec :: Int -> Names -> Doc

pprList :: [Names] -> Doc

SexpIso Names

Defined in Futhark.IR.Prop.Names

Methods

sexpIso :: SexpGrammar 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

Substitute Names

Defined in Futhark.Transform.Substitute

Methods

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

Rename Names

Defined in Futhark.Transform.Rename

Methods

rename :: Names -> RenameM Names

AliasesOf Names

Defined in Futhark.IR.Prop.Aliases

Methods

aliasesOf :: Names -> Names

MonadState Names (TypeM lore)

Defined in Futhark.TypeCheck

Methods

get :: TypeM lore Names

put :: Names -> TypeM lore ()

state :: (Names -> (a, Names)) -> TypeM lore a

type Rep Names

Defined in Futhark.IR.Prop.Names

type Rep Names = D1 ('MetaData "Names" "Futhark.IR.Prop.Names" "futhark-0.17.3-inplace" 'True) (C1 ('MetaCons "Names" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (IntMap VName))))

namesIntMap :: Names -> IntMap VName

Retrieve the data structure underlying the names representation.

nameIn :: VName -> Names -> Bool

Does the set of names 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 Bool

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Bool -> FV

FreeIn Int

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Int -> FV

FreeIn ()

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: () -> FV

FreeIn VName

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: VName -> FV

FreeIn SubExp

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: SubExp -> FV

FreeIn Certificates

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Certificates -> 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 Attrs

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Attrs -> 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 AliasDec

Defined in Futhark.IR.Aliases

Methods

freeIn' :: AliasDec -> FV

FreeIn ExpWisdom

Defined in Futhark.Optimise.Simplify.Lore

Methods

freeIn' :: ExpWisdom -> FV

FreeIn VarWisdom

Defined in Futhark.Optimise.Simplify.Lore

Methods

freeIn' :: VarWisdom -> FV

FreeIn Indexed

Defined in Futhark.Analysis.SymbolTable

Methods

freeIn' :: Indexed -> FV

FreeIn MemReturn

Defined in Futhark.IR.Mem

Methods

freeIn' :: MemReturn -> FV

FreeIn MemBind

Defined in Futhark.IR.Mem

Methods

freeIn' :: MemBind -> FV

FreeIn KernelResult

Defined in Futhark.IR.SegOp

Methods

freeIn' :: KernelResult -> FV

FreeIn SplitOrdering

Defined in Futhark.IR.SegOp

Methods

freeIn' :: SplitOrdering -> FV

FreeIn LoopNesting

Defined in Futhark.Pass.ExtractKernels.Distribution

Methods

freeIn' :: LoopNesting -> FV

FreeIn SizeOp

Defined in Futhark.IR.Kernels.Kernel

Methods

freeIn' :: SizeOp -> FV

FreeIn SegLevel

Defined in Futhark.IR.Kernels.Kernel

Methods

freeIn' :: SegLevel -> FV

FreeIn Arg

Defined in Futhark.CodeGen.ImpCode

Methods

freeIn' :: Arg -> FV

FreeIn ExpLeaf

Defined in Futhark.CodeGen.ImpCode

Methods

freeIn' :: ExpLeaf -> FV

FreeIn Sequential

Defined in Futhark.CodeGen.ImpCode.Sequential

Methods

freeIn' :: Sequential -> FV

FreeIn AtomicOp

Defined in Futhark.CodeGen.ImpCode.Kernels

Methods

freeIn' :: AtomicOp -> FV

FreeIn KernelOp

Defined in Futhark.CodeGen.ImpCode.Kernels

Methods

freeIn' :: KernelOp -> FV

FreeIn Kernel

Defined in Futhark.CodeGen.ImpCode.Kernels

Methods

freeIn' :: Kernel -> FV

FreeIn HostOp

Defined in Futhark.CodeGen.ImpCode.Kernels

Methods

freeIn' :: HostOp -> FV

FreeIn a => FreeIn [a]

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: [a] -> FV

FreeIn a => FreeIn (Maybe a)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Maybe a -> FV

FreeIn dec => FreeIn (PatElemT dec)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: PatElemT dec -> FV

FreeIn d => FreeIn (DimIndex d)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: DimIndex d -> FV

FreeIn dec => FreeIn (Param dec)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Param dec -> FV

FreeIn d => FreeIn (Ext d)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Ext d -> FV

FreeIn d => FreeIn (ShapeBase d)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: ShapeBase d -> FV

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

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: FunDef lore -> FV

(FreeDec (ExpDec lore), FreeDec (BodyDec lore), FreeIn (FParamInfo lore), FreeIn (LParamInfo lore), FreeIn (LetDec lore), FreeIn (Op lore)) => FreeIn (Lambda lore)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Lambda lore -> FV

(FreeDec (ExpDec lore), FreeDec (BodyDec lore), FreeIn (FParamInfo lore), FreeIn (LParamInfo lore), FreeIn (LetDec lore), FreeIn (Op lore)) => FreeIn (Exp lore)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Exp lore -> FV

FreeIn a => FreeIn (IfDec a)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: IfDec a -> FV

FreeIn (LParamInfo lore) => FreeIn (LoopForm lore)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: LoopForm lore -> FV

FreeIn d => FreeIn (DimChange d)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: DimChange d -> FV

(FreeDec (ExpDec lore), FreeDec (BodyDec lore), FreeIn (FParamInfo lore), FreeIn (LParamInfo lore), FreeIn (LetDec lore), FreeIn (Op lore)) => FreeIn (Body lore)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Body lore -> FV

FreeIn (Stm lore) => FreeIn (Stms lore)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Stms lore -> FV

(FreeDec (ExpDec lore), FreeDec (BodyDec lore), FreeIn (FParamInfo lore), FreeIn (LParamInfo lore), FreeIn (LetDec lore), FreeIn (Op lore)) => FreeIn (Stm lore)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: Stm lore -> FV

FreeIn dec => FreeIn (StmAux dec)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: StmAux dec -> FV

FreeIn dec => FreeIn (PatternT dec)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: PatternT dec -> FV

FreeIn v => FreeIn (PrimExp v)

Defined in Futhark.Analysis.PrimExp

Methods

freeIn' :: PrimExp v -> FV

FreeIn num => FreeIn (IxFun num)

Defined in Futhark.IR.Mem.IxFun

Methods

freeIn' :: IxFun num -> FV

ASTLore lore => FreeIn (SOAC lore)

Defined in Futhark.IR.SOACS.SOAC

Methods

freeIn' :: SOAC lore -> FV

FreeIn inner => FreeIn (MemOp inner)

Defined in Futhark.IR.Mem

Methods

freeIn' :: MemOp inner -> FV

ASTLore lore => FreeIn (KernelBody lore)

Defined in Futhark.IR.SegOp

Methods

freeIn' :: KernelBody lore -> 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 a, FreeIn b) => FreeIn (a, b)

Defined in Futhark.IR.Prop.Names

Methods

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

FreeIn shape => FreeIn (TypeBase shape u)

Defined in Futhark.IR.Prop.Names

Methods

freeIn' :: TypeBase shape u -> 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.Kernels.Sizes

Methods

freeIn' :: Count u e -> FV

(ASTLore lore, FreeIn (LParamInfo lore), FreeIn lvl) => FreeIn (SegOp lvl lore)

Defined in Futhark.IR.SegOp

Methods

freeIn' :: SegOp lvl lore -> FV

(ASTLore lore, FreeIn op) => FreeIn (HostOp lore op)

Defined in Futhark.IR.Kernels.Kernel

Methods

freeIn' :: HostOp lore op -> FV

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

Defined in Futhark.IR.Prop.Names

Methods

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

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

Defined in Futhark.IR.Mem

Methods

freeIn' :: MemInfo d u ret -> FV

freeIn :: FreeIn a => a -> Names

The free variables of some syntactic construct.

Specialised Functions

freeInStmsAndRes :: (FreeIn (Op lore), FreeIn (LetDec lore), FreeIn (LParamInfo lore), FreeIn (FParamInfo lore), FreeDec (BodyDec lore), FreeDec (ExpDec lore)) => Stms lore -> 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 lore -> Names

The names bound by the bindings immediately in a Body.

boundByStm :: Stm lore -> Names

The names bound by a binding.

boundByStms :: Stms lore -> Names

The names bound by the bindings.

boundByLambda :: Lambda lore -> [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 ()

Defined in Futhark.IR.Prop.Names

Methods

precomputed :: () -> FV -> FV

FreeDec Names

Defined in Futhark.IR.Prop.Names

Methods

precomputed :: Names -> FV -> FV

FreeDec AliasDec

Defined in Futhark.IR.Aliases

Methods

precomputed :: AliasDec -> FV -> FV

FreeDec ExpWisdom

Defined in Futhark.Optimise.Simplify.Lore

Methods

precomputed :: ExpWisdom -> FV -> FV

FreeDec a => FreeDec [a]

Defined in Futhark.IR.Prop.Names

Methods

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

FreeDec a => FreeDec (Maybe a)

Defined in Futhark.IR.Prop.Names

Methods

precomputed :: Maybe 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

Semigroup FV

Defined in Futhark.IR.Prop.Names

Methods

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

sconcat :: NonEmpty FV -> FV

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

Monoid FV

Defined in Futhark.IR.Prop.Names

Methods

mempty :: FV

mappend :: FV -> FV -> FV

mconcat :: [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.