-data Builtins = Builtins {
- dphModules :: Modules
- , parrayTyCon :: TyCon
- , parrayDataCon :: DataCon
- , pdataTyCon :: TyCon
- , paTyCon :: TyCon
- , paDataCon :: DataCon
- , preprTyCon :: TyCon
- , prTyCon :: TyCon
- , prDataCon :: DataCon
- , voidTyCon :: TyCon
- , wrapTyCon :: TyCon
- , selTys :: Array Int Type
- , selReplicates :: Array Int CoreExpr
- , selPicks :: Array Int CoreExpr
- , selTagss :: Array Int CoreExpr
- , selEls :: Array (Int, Int) CoreExpr
- , sumTyCons :: Array Int TyCon
- , closureTyCon :: TyCon
- , voidVar :: Var
- , pvoidVar :: Var
- , fromVoidVar :: Var
- , punitVar :: Var
- , closureVar :: Var
- , applyVar :: Var
- , liftedClosureVar :: Var
- , liftedApplyVar :: Var
- , replicatePDVar :: Var
- , emptyPDVar :: Var
- , packPDVar :: Var
- , packByTagPDVar :: Var
- , combinePDVars :: Array Int Var
- , scalarClass :: Class
- , scalarZips :: Array Int Var
- , closureCtrFuns :: Array Int Var
- , liftingContext :: Var
- }
-
-indexBuiltin :: (Ix i, Outputable i) => String -> (Builtins -> Array i a)
- -> i -> Builtins -> a
+
+-- | Information about what builtin stuff to use from the DPH base libraries.
+data Builtins
+ = Builtins
+ { dphModules :: Modules
+
+ -- From dph-common:Data.Array.Parallel.Lifted.PArray
+ , parrayTyCon :: TyCon -- ^ PArray
+ , parrayDataCon :: DataCon -- ^ PArray
+ , pdataTyCon :: TyCon -- ^ PData
+ , paTyCon :: TyCon -- ^ PA
+ , paDataCon :: DataCon -- ^ PA
+ , preprTyCon :: TyCon -- ^ PRepr
+ , prTyCon :: TyCon -- ^ PR
+ , prDataCon :: DataCon -- ^ PR
+ , replicatePDVar :: Var -- ^ replicatePD
+ , emptyPDVar :: Var -- ^ emptyPD
+ , packByTagPDVar :: Var -- ^ packByTagPD
+ , combinePDVars :: Array Int Var -- ^ combinePD
+ , scalarClass :: Class -- ^ Scalar
+
+ -- From dph-common:Data.Array.Parallel.Lifted.Closure
+ , closureTyCon :: TyCon -- ^ :->
+ , closureVar :: Var -- ^ closure
+ , applyVar :: Var -- ^ $:
+ , liftedClosureVar :: Var -- ^ liftedClosure
+ , liftedApplyVar :: Var -- ^ liftedApply
+ , closureCtrFuns :: Array Int Var -- ^ closure1 .. closure2
+
+ -- From dph-common:Data.Array.Parallel.Lifted.Repr
+ , voidTyCon :: TyCon -- ^ Void
+ , wrapTyCon :: TyCon -- ^ Wrap
+ , sumTyCons :: Array Int TyCon -- ^ Sum2 .. Sum3
+ , voidVar :: Var -- ^ void
+ , pvoidVar :: Var -- ^ pvoid
+ , fromVoidVar :: Var -- ^ fromVoid
+ , punitVar :: Var -- ^ punit
+
+ -- From dph-common:Data.Array.Parallel.Lifted.Selector
+ , selTys :: Array Int Type -- ^ Sel2
+ , selReplicates :: Array Int CoreExpr -- ^ replicate2
+ , selPicks :: Array Int CoreExpr -- ^ pick2
+ , selTagss :: Array Int CoreExpr -- ^ tagsSel2
+ , selEls :: Array (Int, Int) CoreExpr -- ^ elementsSel2_0 .. elementsSel_2_1
+
+ -- From dph-common:Data.Array.Parallel.Lifted.Scalar
+ -- NOTE: map is counted as a zipWith fn with one argument array.
+ , scalarZips :: Array Int Var -- ^ map, zipWith, zipWith3
+
+ -- A Fresh variable
+ , liftingContext :: Var -- ^ lc
+ }
+
+
+-- | Get an element from one of the arrays of contained by a `Builtins`.
+-- If the indexed thing is not in the array then panic.
+indexBuiltin
+ :: (Ix i, Outputable i)
+ => String -- ^ Name of the selector we've used, for panic messages.
+ -> (Builtins -> Array i a) -- ^ Field selector for the `Builtins`.
+ -> i -- ^ Index into the array.
+ -> Builtins
+ -> a
+