Camfort.Specification.Units.Monad

Defines the monad for the units-of-measure modules

Documentation

type UA = Analysis (UnitAnnotation A)

type VV = (Name, Name)

A (unique name, source name) variable

type UnitSolver a = ExceptT UnitException (RWS UnitOpts UnitLogs UnitState) a

The monad

data UnitOpts

Constructors

UnitOpts

Fields

• uoDebug :: Bool

  debugging mode?

• uoLiterals :: LiteralsOpt

  how to handle literals

• uoNameMap :: NameMap

  map of unique names to original names

Instances

Eq UnitOpts

Methods

(==) :: UnitOpts -> UnitOpts -> Bool

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

Data UnitOpts

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 :: (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

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

Read UnitOpts

Methods

readsPrec :: Int -> ReadS UnitOpts

readList :: ReadS [UnitOpts]

readPrec :: ReadPrec UnitOpts

readListPrec :: ReadPrec [UnitOpts]

Show UnitOpts

Methods

showsPrec :: Int -> UnitOpts -> ShowS

show :: UnitOpts -> String

showList :: [UnitOpts] -> ShowS

unitOpts0 :: UnitOpts

type UnitLogs = String

data UnitState

Working state for the monad

Constructors

UnitState

Fields

• usProgramFile :: ProgramFile UA
• usVarUnitMap :: VarUnitMap
• usGivenVarSet :: GivenVarSet
• usUnitAliasMap :: UnitAliasMap
• usTemplateMap :: TemplateMap
• usLitNums :: Int
• usCallIds :: Int
• usCallIdRemap :: CallIdMap
• usConstraints :: Constraints

Instances

Data UnitState

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 :: (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

Methods

showsPrec :: Int -> UnitState -> ShowS

show :: UnitState -> String

showList :: [UnitState] -> ShowS

data LiteralsOpt

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

Eq LiteralsOpt

Methods

(==) :: LiteralsOpt -> LiteralsOpt -> Bool

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

Data LiteralsOpt

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 :: (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

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

Methods

readsPrec :: Int -> ReadS LiteralsOpt

readList :: ReadS [LiteralsOpt]

readPrec :: ReadPrec LiteralsOpt

readListPrec :: ReadPrec [LiteralsOpt]

Show LiteralsOpt

Methods

showsPrec :: Int -> LiteralsOpt -> ShowS

show :: LiteralsOpt -> String

showList :: [LiteralsOpt] -> ShowS

type UnitException = ()

whenDebug :: UnitSolver () -> UnitSolver ()

Only run the argument if debugging mode enabled.

modifyVarUnitMap :: (VarUnitMap -> VarUnitMap) -> UnitSolver ()

modifyGivenVarSet :: (GivenVarSet -> GivenVarSet) -> UnitSolver ()

modifyUnitAliasMap :: (UnitAliasMap -> UnitAliasMap) -> UnitSolver ()

type VarUnitMap = Map VV UnitInfo

Variable => unit

type GivenVarSet = Set Name

Set of variables given explicit unit annotations

type UnitAliasMap = Map String UnitInfo

Alias name => definition

type TemplateMap = Map Name Constraints

Function/subroutine name -> associated, parametric polymorphic constraints

type CallIdMap = IntMap Int

Map of CallId to CallId

modifyTemplateMap :: (TemplateMap -> TemplateMap) -> UnitSolver ()

modifyProgramFile :: (ProgramFile UA -> ProgramFile UA) -> UnitSolver ()

modifyProgramFileM :: (ProgramFile UA -> UnitSolver (ProgramFile UA)) -> UnitSolver ()

modifyCallIdRemapM :: (CallIdMap -> UnitSolver (a, CallIdMap)) -> UnitSolver a

runUnitSolver :: UnitOpts -> ProgramFile UA -> UnitSolver a -> (Either UnitException a, UnitState, UnitLogs)

Run the unit solver monad.

evalUnitSolver :: UnitOpts -> ProgramFile UA -> UnitSolver a -> (Either UnitException a, UnitLogs)

execUnitSolver :: UnitOpts -> ProgramFile UA -> UnitSolver a -> Either UnitException (UnitState, UnitLogs)