Futhark.IR.Prop.Scope

The core Futhark AST does not contain type information when we use a variable. Therefore, most transformations expect to be able to access some kind of symbol table that maps names to their types.

This module defines the concept of a type environment as a mapping from variable names to NameInfos. Convenience facilities are also provided to communicate that some monad or applicative functor maintains type information.

Documentation

class (Applicative m, Decorations lore) => HasScope lore m | m -> lore where

The class of applicative functors (or more common in practice: monads) that permit the lookup of variable types. A default method for lookupType exists, which is sufficient (if not always maximally efficient, and using error to fail) when askScope is defined.

Minimal complete definition

askScope

Methods

lookupType :: VName -> m Type

Return the type of the given variable, or fail if it is not in the type environment.

lookupInfo :: VName -> m (NameInfo lore)

Return the info of the given variable, or fail if it is not in the type environment.

askScope :: m (Scope lore)

Return the type environment contained in the applicative functor.

asksScope :: (Scope lore -> a) -> m a

Return the result of applying some function to the type environment.

Instances

HasScope SOACS InternaliseM

Defined in Futhark.Internalise.Monad

Methods

lookupType :: VName -> InternaliseM Type

lookupInfo :: VName -> InternaliseM (NameInfo SOACS)

askScope :: InternaliseM (Scope SOACS)

asksScope :: (Scope SOACS -> a) -> InternaliseM a

ASTLore lore => HasScope lore (RuleM lore)

Defined in Futhark.Optimise.Simplify.Rule

Methods

lookupType :: VName -> RuleM lore Type

lookupInfo :: VName -> RuleM lore (NameInfo lore)

askScope :: RuleM lore (Scope lore)

asksScope :: (Scope lore -> a) -> RuleM lore a

(HasScope lore m, Monad m) => HasScope lore (ExtendedScope lore m)

Defined in Futhark.IR.Prop.Scope

Methods

lookupType :: VName -> ExtendedScope lore m Type

lookupInfo :: VName -> ExtendedScope lore m (NameInfo lore)

askScope :: ExtendedScope lore m (Scope lore)

asksScope :: (Scope lore -> a) -> ExtendedScope lore m a

(Monad m, HasScope lore m) => HasScope lore (ExceptT e m)

Defined in Futhark.IR.Prop.Scope

Methods

lookupType :: VName -> ExceptT e m Type

lookupInfo :: VName -> ExceptT e m (NameInfo lore)

askScope :: ExceptT e m (Scope lore)

asksScope :: (Scope lore -> a) -> ExceptT e m a

(Applicative m, Monad m, Decorations lore) => HasScope lore (ReaderT (Scope lore) m)

Defined in Futhark.IR.Prop.Scope

Methods

lookupType :: VName -> ReaderT (Scope lore) m Type

lookupInfo :: VName -> ReaderT (Scope lore) m (NameInfo lore)

askScope :: ReaderT (Scope lore) m (Scope lore)

asksScope :: (Scope lore -> a) -> ReaderT (Scope lore) m a

(ASTLore lore, Monad m) => HasScope lore (BinderT lore m)

Defined in Futhark.Binder

Methods

lookupType :: VName -> BinderT lore m Type

lookupInfo :: VName -> BinderT lore m (NameInfo lore)

askScope :: BinderT lore m (Scope lore)

asksScope :: (Scope lore -> a) -> BinderT lore m a

ASTLore tolore => HasScope tolore (AllocM fromlore tolore)

Defined in Futhark.Pass.ExplicitAllocations

Methods

lookupType :: VName -> AllocM fromlore tolore Type

lookupInfo :: VName -> AllocM fromlore tolore (NameInfo tolore)

askScope :: AllocM fromlore tolore (Scope tolore)

asksScope :: (Scope tolore -> a) -> AllocM fromlore tolore a

(Monad m, ASTLore lore) => HasScope lore (DistNestT lore m)

Defined in Futhark.Pass.ExtractKernels.DistributeNests

Methods

lookupType :: VName -> DistNestT lore m Type

lookupInfo :: VName -> DistNestT lore m (NameInfo lore)

askScope :: DistNestT lore m (Scope lore)

asksScope :: (Scope lore -> a) -> DistNestT lore m a

HasScope SOACS (ImpM lore r op)

Defined in Futhark.CodeGen.ImpGen

Methods

lookupType :: VName -> ImpM lore r op Type

lookupInfo :: VName -> ImpM lore r op (NameInfo SOACS)

askScope :: ImpM lore r op (Scope SOACS)

asksScope :: (Scope SOACS -> a) -> ImpM lore r op a

(Applicative m, Monad m, Monoid w, Decorations lore) => HasScope lore (RWST (Scope lore) w s m)

Defined in Futhark.IR.Prop.Scope

Methods

lookupType :: VName -> RWST (Scope lore) w s m Type

lookupInfo :: VName -> RWST (Scope lore) w s m (NameInfo lore)

askScope :: RWST (Scope lore) w s m (Scope lore)

asksScope :: (Scope lore -> a) -> RWST (Scope lore) w s m a

(Applicative m, Monad m, Monoid w, Decorations lore) => HasScope lore (RWST (Scope lore) w s m)

Defined in Futhark.IR.Prop.Scope

Methods

lookupType :: VName -> RWST (Scope lore) w s m Type

lookupInfo :: VName -> RWST (Scope lore) w s m (NameInfo lore)

askScope :: RWST (Scope lore) w s m (Scope lore)

asksScope :: (Scope lore -> a) -> RWST (Scope lore) w s m a

Checkable lore => HasScope (Aliases lore) (TypeM lore)

Defined in Futhark.TypeCheck

Methods

lookupType :: VName -> TypeM lore Type

lookupInfo :: VName -> TypeM lore (NameInfo (Aliases lore))

askScope :: TypeM lore (Scope (Aliases lore))

asksScope :: (Scope (Aliases lore) -> a) -> TypeM lore a

SimplifiableLore lore => HasScope (Wise lore) (SimpleM lore)

Defined in Futhark.Optimise.Simplify.Engine

Methods

lookupType :: VName -> SimpleM lore Type

lookupInfo :: VName -> SimpleM lore (NameInfo (Wise lore))

askScope :: SimpleM lore (Scope (Wise lore))

asksScope :: (Scope (Wise lore) -> a) -> SimpleM lore a

data NameInfo lore

How some name in scope was bound.

Constructors

LetName (LetDec lore)

FParamName (FParamInfo lore)

LParamName (LParamInfo lore)

IndexName IntType

Instances

Scoped lore (VName, NameInfo lore)

Defined in Futhark.IR.Prop.Scope

Methods

scopeOf :: (VName, NameInfo lore) -> Scope lore

(Applicative m, Monad m, Decorations lore) => LocalScope lore (ReaderT (Scope lore) m)

Defined in Futhark.IR.Prop.Scope

Methods

localScope :: Scope lore -> ReaderT (Scope lore) m a -> ReaderT (Scope lore) m a

(Applicative m, Monad m, Decorations lore) => HasScope lore (ReaderT (Scope lore) m)

Defined in Futhark.IR.Prop.Scope

Methods

lookupType :: VName -> ReaderT (Scope lore) m Type

lookupInfo :: VName -> ReaderT (Scope lore) m (NameInfo lore)

askScope :: ReaderT (Scope lore) m (Scope lore)

asksScope :: (Scope lore -> a) -> ReaderT (Scope lore) m a

(Applicative m, Monad m, Monoid w, Decorations lore) => LocalScope lore (RWST (Scope lore) w s m)

Defined in Futhark.IR.Prop.Scope

Methods

localScope :: Scope lore -> RWST (Scope lore) w s m a -> RWST (Scope lore) w s m a

(Applicative m, Monad m, Monoid w, Decorations lore) => LocalScope lore (RWST (Scope lore) w s m)

Defined in Futhark.IR.Prop.Scope

Methods

localScope :: Scope lore -> RWST (Scope lore) w s m a -> RWST (Scope lore) w s m a

(Applicative m, Monad m, Monoid w, Decorations lore) => HasScope lore (RWST (Scope lore) w s m)

Defined in Futhark.IR.Prop.Scope

Methods

lookupType :: VName -> RWST (Scope lore) w s m Type

lookupInfo :: VName -> RWST (Scope lore) w s m (NameInfo lore)

askScope :: RWST (Scope lore) w s m (Scope lore)

asksScope :: (Scope lore -> a) -> RWST (Scope lore) w s m a

(Applicative m, Monad m, Monoid w, Decorations lore) => HasScope lore (RWST (Scope lore) w s m)

Defined in Futhark.IR.Prop.Scope

Methods

lookupType :: VName -> RWST (Scope lore) w s m Type

lookupInfo :: VName -> RWST (Scope lore) w s m (NameInfo lore)

askScope :: RWST (Scope lore) w s m (Scope lore)

asksScope :: (Scope lore -> a) -> RWST (Scope lore) w s m a

Decorations lore => Show (NameInfo lore)

Defined in Futhark.IR.Prop.Scope

Methods

showsPrec :: Int -> NameInfo lore -> ShowS

show :: NameInfo lore -> String

showList :: [NameInfo lore] -> ShowS

Decorations lore => Typed (NameInfo lore)

Defined in Futhark.IR.Prop.Scope

Methods

typeOf :: NameInfo lore -> Type

Substitutable lore => Substitute (NameInfo lore)

Defined in Futhark.Transform.Substitute

Methods

substituteNames :: Map VName VName -> NameInfo lore -> NameInfo lore

Monad m => MonadReader (Scope lore) (ExtendedScope lore m)

Defined in Futhark.IR.Prop.Scope

Methods

ask :: ExtendedScope lore m (Scope lore)

local :: (Scope lore -> Scope lore) -> ExtendedScope lore m a -> ExtendedScope lore m a

reader :: (Scope lore -> a) -> ExtendedScope lore m a

class (HasScope lore m, Monad m) => LocalScope lore m where

The class of monads that not only provide a Scope, but also the ability to locally extend it. A Reader containing a Scope is the prototypical example of such a monad.

Methods

localScope :: Scope lore -> m a -> m a

Run a computation with an extended type environment. Note that this is intended to *add* to the current type environment, it does not replace it.

Instances

LocalScope SOACS InternaliseM

Defined in Futhark.Internalise.Monad

Methods

localScope :: Scope SOACS -> InternaliseM a -> InternaliseM a

ASTLore lore => LocalScope lore (RuleM lore)

Defined in Futhark.Optimise.Simplify.Rule

Methods

localScope :: Scope lore -> RuleM lore a -> RuleM lore a

(Applicative m, Monad m, Decorations lore) => LocalScope lore (ReaderT (Scope lore) m)

Defined in Futhark.IR.Prop.Scope

Methods

localScope :: Scope lore -> ReaderT (Scope lore) m a -> ReaderT (Scope lore) m a

(Monad m, LocalScope lore m) => LocalScope lore (ExceptT e m)

Defined in Futhark.IR.Prop.Scope

Methods

localScope :: Scope lore -> ExceptT e m a -> ExceptT e m a

(ASTLore lore, Monad m) => LocalScope lore (BinderT lore m)

Defined in Futhark.Binder

Methods

localScope :: Scope lore -> BinderT lore m a -> BinderT lore m a

ASTLore tolore => LocalScope tolore (AllocM fromlore tolore)

Defined in Futhark.Pass.ExplicitAllocations

Methods

localScope :: Scope tolore -> AllocM fromlore tolore a -> AllocM fromlore tolore a

(Monad m, ASTLore lore) => LocalScope lore (DistNestT lore m)

Defined in Futhark.Pass.ExtractKernels.DistributeNests

Methods

localScope :: Scope lore -> DistNestT lore m a -> DistNestT lore m a

(Applicative m, Monad m, Monoid w, Decorations lore) => LocalScope lore (RWST (Scope lore) w s m)

Defined in Futhark.IR.Prop.Scope

Methods

localScope :: Scope lore -> RWST (Scope lore) w s m a -> RWST (Scope lore) w s m a

(Applicative m, Monad m, Monoid w, Decorations lore) => LocalScope lore (RWST (Scope lore) w s m)

Defined in Futhark.IR.Prop.Scope

Methods

localScope :: Scope lore -> RWST (Scope lore) w s m a -> RWST (Scope lore) w s m a

SimplifiableLore lore => LocalScope (Wise lore) (SimpleM lore)

Defined in Futhark.Optimise.Simplify.Engine

Methods

localScope :: Scope (Wise lore) -> SimpleM lore a -> SimpleM lore a

type Scope lore = Map VName (NameInfo lore)

A scope is a mapping from variable names to information about that name.

class Scoped lore a | a -> lore where

The class of things that can provide a scope. There is no overarching rule for what this means. For a Stm, it is the corresponding pattern. For a Lambda, is is the parameters.

Methods

scopeOf :: a -> Scope lore

Instances

Scoped lore (Lambda lore)

Defined in Futhark.IR.Prop.Scope

Methods

scopeOf :: Lambda lore -> Scope lore

Scoped lore (LoopForm lore)

Defined in Futhark.IR.Prop.Scope

Methods

scopeOf :: LoopForm lore -> Scope lore

Scoped lore (FunDef lore)

Defined in Futhark.IR.Prop.Scope

Methods

scopeOf :: FunDef lore -> Scope lore

Scoped lore (Stm lore)

Defined in Futhark.IR.Prop.Scope

Methods

scopeOf :: Stm lore -> Scope lore

Scoped lore (Stms lore)

Defined in Futhark.IR.Prop.Scope

Methods

scopeOf :: Stms lore -> Scope lore

Scoped lore a => Scoped lore [a]

Defined in Futhark.IR.Prop.Scope

Methods

scopeOf :: [a] -> Scope lore

Scoped lore (VName, NameInfo lore)

Defined in Futhark.IR.Prop.Scope

Methods

scopeOf :: (VName, NameInfo lore) -> Scope lore

inScopeOf :: (Scoped lore a, LocalScope lore m) => a -> m b -> m b

Extend the monadic scope with the scopeOf the given value.

scopeOfLParams :: LParamInfo lore ~ dec => [Param dec] -> Scope lore

The scope of some lambda parameters.

scopeOfFParams :: FParamInfo lore ~ dec => [Param dec] -> Scope lore

The scope of some function or loop parameters.

scopeOfPattern :: LetDec lore ~ dec => PatternT dec -> Scope lore

The scope of a pattern.

scopeOfPatElem :: LetDec lore ~ dec => PatElemT dec -> Scope lore

The scope of a pattern element.

type SameScope lore1 lore2 = (LetDec lore1 ~ LetDec lore2, FParamInfo lore1 ~ FParamInfo lore2, LParamInfo lore1 ~ LParamInfo lore2)

A constraint that indicates two lores have the same NameInfo representation.

castScope :: SameScope fromlore tolore => Scope fromlore -> Scope tolore

If two scopes are really the same, then you can convert one to the other.

Extended type environment

data ExtendedScope lore m a

A monad transformer that carries around an extended Scope. Its lookupType method will first look in the extended Scope, and then use the lookupType method of the underlying monad.

Instances

(HasScope lore m, Monad m) => HasScope lore (ExtendedScope lore m)

Defined in Futhark.IR.Prop.Scope

Methods

lookupType :: VName -> ExtendedScope lore m Type

lookupInfo :: VName -> ExtendedScope lore m (NameInfo lore)

askScope :: ExtendedScope lore m (Scope lore)

asksScope :: (Scope lore -> a) -> ExtendedScope lore m a

Monad m => MonadReader (Scope lore) (ExtendedScope lore m)

Defined in Futhark.IR.Prop.Scope

Methods

ask :: ExtendedScope lore m (Scope lore)

local :: (Scope lore -> Scope lore) -> ExtendedScope lore m a -> ExtendedScope lore m a

reader :: (Scope lore -> a) -> ExtendedScope lore m a

Monad m => Monad (ExtendedScope lore m)

Defined in Futhark.IR.Prop.Scope

Methods

(>>=) :: ExtendedScope lore m a -> (a -> ExtendedScope lore m b) -> ExtendedScope lore m b

(>>) :: ExtendedScope lore m a -> ExtendedScope lore m b -> ExtendedScope lore m b

return :: a -> ExtendedScope lore m a

Functor m => Functor (ExtendedScope lore m)

Defined in Futhark.IR.Prop.Scope

Methods

fmap :: (a -> b) -> ExtendedScope lore m a -> ExtendedScope lore m b

(<$) :: a -> ExtendedScope lore m b -> ExtendedScope lore m a

Applicative m => Applicative (ExtendedScope lore m)

Defined in Futhark.IR.Prop.Scope

Methods

pure :: a -> ExtendedScope lore m a

(<*>) :: ExtendedScope lore m (a -> b) -> ExtendedScope lore m a -> ExtendedScope lore m b

liftA2 :: (a -> b -> c) -> ExtendedScope lore m a -> ExtendedScope lore m b -> ExtendedScope lore m c

(*>) :: ExtendedScope lore m a -> ExtendedScope lore m b -> ExtendedScope lore m b

(<*) :: ExtendedScope lore m a -> ExtendedScope lore m b -> ExtendedScope lore m a

extendedScope :: ExtendedScope lore m a -> Scope lore -> m a

Run a computation in the extended type environment.