Futhark.AD.Rev.Monad

Documentation

data ADM a

Instances

Applicative ADM

Defined in Futhark.AD.Rev.Monad

Methods

pure :: a -> ADM a

(<*>) :: ADM (a -> b) -> ADM a -> ADM b

liftA2 :: (a -> b -> c) -> ADM a -> ADM b -> ADM c

(*>) :: ADM a -> ADM b -> ADM b

(<*) :: ADM a -> ADM b -> ADM a

Functor ADM

Defined in Futhark.AD.Rev.Monad

Methods

fmap :: (a -> b) -> ADM a -> ADM b

(<$) :: a -> ADM b -> ADM a

Monad ADM

Defined in Futhark.AD.Rev.Monad

Methods

(>>=) :: ADM a -> (a -> ADM b) -> ADM b

(>>) :: ADM a -> ADM b -> ADM b

return :: a -> ADM a

MonadBuilder ADM

Defined in Futhark.AD.Rev.Monad

Associated Types

type Rep ADM

Methods

mkExpDecM :: Pat (LetDec (Rep ADM)) -> Exp (Rep ADM) -> ADM (ExpDec (Rep ADM))

mkBodyM :: Stms (Rep ADM) -> Result -> ADM (Body (Rep ADM))

mkLetNamesM :: [VName] -> Exp (Rep ADM) -> ADM (Stm (Rep ADM))

addStm :: Stm (Rep ADM) -> ADM ()

addStms :: Stms (Rep ADM) -> ADM ()

collectStms :: ADM a -> ADM (a, Stms (Rep ADM))

certifying :: Certs -> ADM a -> ADM a

MonadFreshNames ADM

Defined in Futhark.AD.Rev.Monad

Methods

getNameSource :: ADM VNameSource

putNameSource :: VNameSource -> ADM ()

HasScope SOACS ADM

Defined in Futhark.AD.Rev.Monad

Methods

lookupType :: VName -> ADM Type

lookupInfo :: VName -> ADM (NameInfo SOACS)

askScope :: ADM (Scope SOACS)

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

LocalScope SOACS ADM

Defined in Futhark.AD.Rev.Monad

Methods

localScope :: Scope SOACS -> ADM a -> ADM a

MonadState RState ADM

Defined in Futhark.AD.Rev.Monad

Methods

get :: ADM RState

put :: RState -> ADM ()

state :: (RState -> (a, RState)) -> ADM a

type Rep ADM

Defined in Futhark.AD.Rev.Monad

type Rep ADM = SOACS

data RState

Constructors

RState

Fields

• stateAdjs :: Map VName Adj
• stateLoopTape :: Substitutions
• stateSubsts :: Substitutions
• stateNameSource :: VNameSource

Instances

MonadState RState ADM

Defined in Futhark.AD.Rev.Monad

Methods

get :: ADM RState

put :: RState -> ADM ()

state :: (RState -> (a, RState)) -> ADM a

MonadFreshNames (State RState)

Defined in Futhark.AD.Rev.Monad

Methods

getNameSource :: State RState VNameSource

putNameSource :: VNameSource -> State RState ()

runADM :: MonadFreshNames m => ADM a -> m a

data Adj

The adjoint of a variable.

Constructors

AdjSparse Sparse

AdjVal SubExp

AdjZero Shape PrimType

Instances

Show Adj

Defined in Futhark.AD.Rev.Monad

Methods

showsPrec :: Int -> Adj -> ShowS

show :: Adj -> String

showList :: [Adj] -> ShowS

Substitute Adj

Defined in Futhark.AD.Rev.Monad

Methods

substituteNames :: Map VName VName -> Adj -> Adj

Eq Adj

Defined in Futhark.AD.Rev.Monad

Methods

(==) :: Adj -> Adj -> Bool

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

Ord Adj

Defined in Futhark.AD.Rev.Monad

Methods

compare :: Adj -> Adj -> Ordering

(<) :: Adj -> Adj -> Bool

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

(>) :: Adj -> Adj -> Bool

(>=) :: Adj -> Adj -> Bool

max :: Adj -> Adj -> Adj

min :: Adj -> Adj -> Adj

data InBounds

Whether Sparse should check bounds or assume they are correct. The latter results in simpler code.

Constructors

CheckBounds (Maybe SubExp)

If a SubExp is provided, it references a boolean that is true when in-bounds.

AssumeBounds

OutOfBounds

Dynamically these will always fail, so don't bother generating code for the update. This is only needed to ensure a consistent representation of sparse Jacobians.

Instances

Show InBounds

Defined in Futhark.AD.Rev.Monad

Methods

showsPrec :: Int -> InBounds -> ShowS

show :: InBounds -> String

showList :: [InBounds] -> ShowS

Eq InBounds

Defined in Futhark.AD.Rev.Monad

Methods

(==) :: InBounds -> InBounds -> Bool

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

Ord InBounds

Defined in Futhark.AD.Rev.Monad

Methods

compare :: InBounds -> InBounds -> Ordering

(<) :: InBounds -> InBounds -> Bool

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

(>) :: InBounds -> InBounds -> Bool

(>=) :: InBounds -> InBounds -> Bool

max :: InBounds -> InBounds -> InBounds

min :: InBounds -> InBounds -> InBounds

data Sparse

A symbolic representation of an array that is all zeroes, except at certain indexes.

Constructors

Sparse

Fields

• sparseShape :: Shape

  The shape of the array.

• sparseType :: PrimType

  Element type of the array.

• sparseIdxVals :: [(InBounds, SubExp, SubExp)]

  Locations and values of nonzero values. Indexes may be negative, in which case the value is ignored (unless AssumeBounds is used).

Instances

Show Sparse

Defined in Futhark.AD.Rev.Monad

Methods

showsPrec :: Int -> Sparse -> ShowS

show :: Sparse -> String

showList :: [Sparse] -> ShowS

Eq Sparse

Defined in Futhark.AD.Rev.Monad

Methods

(==) :: Sparse -> Sparse -> Bool

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

Ord Sparse

Defined in Futhark.AD.Rev.Monad

Methods

compare :: Sparse -> Sparse -> Ordering

(<) :: Sparse -> Sparse -> Bool

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

(>) :: Sparse -> Sparse -> Bool

(>=) :: Sparse -> Sparse -> Bool

max :: Sparse -> Sparse -> Sparse

min :: Sparse -> Sparse -> Sparse

adjFromParam :: Param t -> Adj

adjFromVar :: VName -> Adj

lookupAdj :: VName -> ADM Adj

lookupAdjVal :: VName -> ADM VName

adjVal :: Adj -> ADM VName

updateAdj :: VName -> VName -> ADM ()

updateSubExpAdj :: SubExp -> VName -> ADM ()

updateAdjSlice :: Slice SubExp -> VName -> VName -> ADM ()

updateAdjIndex :: VName -> (InBounds, SubExp) -> SubExp -> ADM ()

setAdj :: VName -> Adj -> ADM ()

Set a specific adjoint.

insAdj :: VName -> VName -> ADM ()

Set an AdjVal adjoint. Simple wrapper around setAdj.

adjsReps :: [Adj] -> ([SubExp], [SubExp] -> [Adj])

Conveniently convert a list of Adjs to their representation, as well as produce a function for converting back.

copyConsumedArrsInStm :: Stm SOACS -> ADM (Substitutions, Stms SOACS)

Create copies of all arrays consumed in the given statement, and return statements which include copies of the consumed arrays.

See Note [Consumption].

copyConsumedArrsInBody :: [VName] -> Body SOACS -> ADM Substitutions

addSubstitution :: VName -> VName -> ADM ()

returnSweepCode :: ADM a -> ADM a

adjVName :: VName -> ADM VName

subAD :: ADM a -> ADM a

Ignore any changes to adjoints made while evaluating this action.

noAdjsFor :: Names -> ADM a -> ADM a

subSubsts :: ADM a -> ADM a

isActive :: VName -> ADM Bool

Is this primal variable active in the AD sense? FIXME: this is (obviously) much too conservative.

tabNest :: Int -> [VName] -> ([VName] -> [VName] -> ADM [VName]) -> ADM [VName]

oneExp :: Type -> Exp rep

zeroExp :: Type -> Exp rep

unitAdjOfType :: Type -> ADM Adj

addLambda :: Type -> ADM (Lambda SOACS)

Construct a lambda for adding two values of the given type.

data VjpOps

Constructors

VjpOps

Fields

• vjpLambda :: [Adj] -> [VName] -> Lambda SOACS -> ADM (Lambda SOACS)
• vjpStm :: Stm SOACS -> ADM () -> ADM ()

setLoopTape :: VName -> VName -> ADM ()

setLoopTape v vs establishes vs as the name of the array where values of loop parameter v from the forward pass are stored.

lookupLoopTape :: VName -> ADM (Maybe VName)

Look-up the name of the array where v is stored.

substLoopTape :: VName -> VName -> ADM ()

substLoopTape v v' substitutes the key v for v'. That is, if v |-> vs then after the substitution v' |-> vs (and v points to nothing).

renameLoopTape :: Substitutions -> ADM ()

Renames the keys of the loop tape. Useful for fixing the the names in the loop tape after a loop rename.