Safe Haskell	None
Language	Haskell2010

Camfort.Specification.Units.Monad

Contents

State Helpers
- Getters
- Modifiers
Runners

Description

Defines the monad for the units-of-measure modules

Synopsis

type UA = Analysis (UnitAnnotation A)
type VV = (Name, Name)
type UnitSolver = StateT UnitState UnitAnalysis
data UnitOpts = UnitOpts {
- uoLiterals :: LiteralsOpt
}
unitOpts0 :: UnitOpts
data UnitState
data UnitEnv = UnitEnv {
- unitOpts :: UnitOpts
- unitProgramFile :: ProgramFile Annotation
}
data LiteralsOpt
- = LitPoly
- | LitUnitless
- | LitMixed
type VarUnitMap = Map VV UnitInfo
type GivenVarSet = Set Name
type UnitAliasMap = Map String UnitInfo
type TemplateMap = Map Name Constraints
type CallIdMap = IntMap Int
type NameParamMap = Map ProgramUnitName (Map NameParamKey [UnitInfo])
data NameParamKey
- = NPKParam PP Int
- | NPKVariable VV
freshId :: UnitSolver Int
getConstraints :: UnitSolver Constraints
getNameParamMap :: UnitSolver NameParamMap
getProgramFile :: UnitSolver (ProgramFile UA)
getTemplateMap :: UnitSolver TemplateMap
getUnitAliasMap :: UnitSolver UnitAliasMap
getVarUnitMap :: UnitSolver VarUnitMap
usCallIdRemap :: UnitState -> CallIdMap
usConstraints :: UnitState -> Constraints
usGivenVarSet :: UnitState -> GivenVarSet
usNameParamMap :: UnitState -> NameParamMap
usProgramFile :: UnitState -> ProgramFile UA
usTemplateMap :: UnitState -> TemplateMap
usUnitAliasMap :: UnitState -> UnitAliasMap
usVarUnitMap :: UnitState -> VarUnitMap
modifyCallIdRemap :: (CallIdMap -> CallIdMap) -> UnitSolver ()
modifyCallIdRemapM :: (CallIdMap -> UnitSolver (a, CallIdMap)) -> UnitSolver a
modifyConstraints :: (Constraints -> Constraints) -> UnitSolver ()
modifyGivenVarSet :: (GivenVarSet -> GivenVarSet) -> UnitSolver ()
modifyNameParamMap :: (NameParamMap -> NameParamMap) -> UnitSolver ()
modifyProgramFile :: (ProgramFile UA -> ProgramFile UA) -> UnitSolver ()
modifyProgramFileM :: (ProgramFile UA -> UnitSolver (ProgramFile UA)) -> UnitSolver ()
modifyTemplateMap :: (TemplateMap -> TemplateMap) -> UnitSolver ()
modifyUnitAliasMap :: (UnitAliasMap -> UnitAliasMap) -> UnitSolver ()
modifyVarUnitMap :: (VarUnitMap -> VarUnitMap) -> UnitSolver ()
runUnitSolver :: ProgramFile UA -> UnitSolver a -> UnitAnalysis (a, UnitState)
runUnitAnalysis :: UnitEnv -> UnitAnalysis a -> AnalysisT () () IO a

Documentation

type UA = Analysis (UnitAnnotation A) Source #

type VV = (Name, Name) Source #

A (unique name, source name) variable

type UnitSolver = StateT UnitState UnitAnalysis Source #

UnitSolvers are analyses annotated with unit information.

data UnitOpts Source #

Options for the unit solver

Constructors

UnitOpts
Fields uoLiterals :: LiteralsOpt how to handle literals

Instances

Instances details

Eq UnitOpts Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Methods (==) :: UnitOpts -> UnitOpts -> Bool # (/=) :: UnitOpts -> UnitOpts -> Bool #
Data UnitOpts Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UnitOpts -> c UnitOpts # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UnitOpts # toConstr :: UnitOpts -> Constr # dataTypeOf :: UnitOpts -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UnitOpts) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UnitOpts) # gmapT :: (forall b. Data b => b -> b) -> UnitOpts -> UnitOpts # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UnitOpts -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UnitOpts -> r # gmapQ :: (forall d. Data d => d -> u) -> UnitOpts -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UnitOpts -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UnitOpts -> m UnitOpts # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UnitOpts -> m UnitOpts # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UnitOpts -> m UnitOpts #
Ord UnitOpts Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Methods compare :: UnitOpts -> UnitOpts -> Ordering # (<) :: UnitOpts -> UnitOpts -> Bool # (<=) :: UnitOpts -> UnitOpts -> Bool # (>) :: UnitOpts -> UnitOpts -> Bool # (>=) :: UnitOpts -> UnitOpts -> Bool # max :: UnitOpts -> UnitOpts -> UnitOpts # min :: UnitOpts -> UnitOpts -> UnitOpts #
Show UnitOpts Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Methods showsPrec :: Int -> UnitOpts -> ShowS # show :: UnitOpts -> String # showList :: [UnitOpts] -> ShowS #

unitOpts0 :: UnitOpts Source #

data UnitState Source #

Working state for the monad

Instances

Instances details

Data UnitState Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UnitState -> c UnitState # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UnitState # toConstr :: UnitState -> Constr # dataTypeOf :: UnitState -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UnitState) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UnitState) # gmapT :: (forall b. Data b => b -> b) -> UnitState -> UnitState # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UnitState -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UnitState -> r # gmapQ :: (forall d. Data d => d -> u) -> UnitState -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UnitState -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UnitState -> m UnitState # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UnitState -> m UnitState # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UnitState -> m UnitState #
Show UnitState Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Methods showsPrec :: Int -> UnitState -> ShowS # show :: UnitState -> String # showList :: [UnitState] -> ShowS #

data UnitEnv Source #

Constructors

UnitEnv
Fields unitOpts :: UnitOpts unitProgramFile :: ProgramFile Annotation

data LiteralsOpt Source #

Some options about how to handle literals.

Constructors

LitPoly	All literals are polymorphic.
LitUnitless	All literals are unitless.
LitMixed	The literal "0" or "0.0" is fully parametric polymorphic. All other literals are monomorphic, possibly unitless.

Instances

Instances details

Eq LiteralsOpt Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Methods (==) :: LiteralsOpt -> LiteralsOpt -> Bool # (/=) :: LiteralsOpt -> LiteralsOpt -> Bool #
Data LiteralsOpt Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LiteralsOpt -> c LiteralsOpt # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LiteralsOpt # toConstr :: LiteralsOpt -> Constr # dataTypeOf :: LiteralsOpt -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LiteralsOpt) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LiteralsOpt) # gmapT :: (forall b. Data b => b -> b) -> LiteralsOpt -> LiteralsOpt # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LiteralsOpt -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LiteralsOpt -> r # gmapQ :: (forall d. Data d => d -> u) -> LiteralsOpt -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> LiteralsOpt -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> LiteralsOpt -> m LiteralsOpt # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LiteralsOpt -> m LiteralsOpt # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LiteralsOpt -> m LiteralsOpt #
Ord LiteralsOpt Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Methods compare :: LiteralsOpt -> LiteralsOpt -> Ordering # (<) :: LiteralsOpt -> LiteralsOpt -> Bool # (<=) :: LiteralsOpt -> LiteralsOpt -> Bool # (>) :: LiteralsOpt -> LiteralsOpt -> Bool # (>=) :: LiteralsOpt -> LiteralsOpt -> Bool # max :: LiteralsOpt -> LiteralsOpt -> LiteralsOpt # min :: LiteralsOpt -> LiteralsOpt -> LiteralsOpt #
Read LiteralsOpt Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Methods readsPrec :: Int -> ReadS LiteralsOpt # readList :: ReadS [LiteralsOpt] # readPrec :: ReadPrec LiteralsOpt # readListPrec :: ReadPrec [LiteralsOpt] #
Show LiteralsOpt Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Methods showsPrec :: Int -> LiteralsOpt -> ShowS # show :: LiteralsOpt -> String # showList :: [LiteralsOpt] -> ShowS #

type VarUnitMap = Map VV UnitInfo Source #

Variable => unit

type GivenVarSet = Set Name Source #

Set of variables given explicit unit annotations

type UnitAliasMap = Map String UnitInfo Source #

Alias name => definition

type TemplateMap = Map Name Constraints Source #

Function/subroutine name -> associated, parametric polymorphic constraints

type CallIdMap = IntMap Int Source #

Map of CallId to CallId

type NameParamMap = Map ProgramUnitName (Map NameParamKey [UnitInfo]) Source #

mapped to a list of units (to be multiplied together)

data NameParamKey Source #

Things that can be exported from modules

Constructors

NPKParam PP Int	Function/subroutine name, position of parameter
NPKVariable VV	variable

Instances

Instances details

Eq NameParamKey Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Methods (==) :: NameParamKey -> NameParamKey -> Bool # (/=) :: NameParamKey -> NameParamKey -> Bool #
Data NameParamKey Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NameParamKey -> c NameParamKey # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c NameParamKey # toConstr :: NameParamKey -> Constr # dataTypeOf :: NameParamKey -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c NameParamKey) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NameParamKey) # gmapT :: (forall b. Data b => b -> b) -> NameParamKey -> NameParamKey # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NameParamKey -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NameParamKey -> r # gmapQ :: (forall d. Data d => d -> u) -> NameParamKey -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> NameParamKey -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> NameParamKey -> m NameParamKey # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NameParamKey -> m NameParamKey # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NameParamKey -> m NameParamKey #
Ord NameParamKey Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Methods compare :: NameParamKey -> NameParamKey -> Ordering # (<) :: NameParamKey -> NameParamKey -> Bool # (<=) :: NameParamKey -> NameParamKey -> Bool # (>) :: NameParamKey -> NameParamKey -> Bool # (>=) :: NameParamKey -> NameParamKey -> Bool # max :: NameParamKey -> NameParamKey -> NameParamKey # min :: NameParamKey -> NameParamKey -> NameParamKey #
Show NameParamKey Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Methods showsPrec :: Int -> NameParamKey -> ShowS # show :: NameParamKey -> String # showList :: [NameParamKey] -> ShowS #
Generic NameParamKey Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Associated Types type Rep NameParamKey :: Type -> Type # Methods from :: NameParamKey -> Rep NameParamKey x # to :: Rep NameParamKey x -> NameParamKey #
Binary NameParamKey Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes Methods put :: NameParamKey -> Put # get :: Get NameParamKey # putList :: [NameParamKey] -> Put #
type Rep NameParamKey Source #
Instance details Defined in Camfort.Specification.Units.MonadTypes type Rep NameParamKey = D1 ('MetaData "NameParamKey" "Camfort.Specification.Units.MonadTypes" "camfort-1.0.1-inplace" 'False) (C1 ('MetaCons "NPKParam" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PP) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "NPKVariable" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VV)))