Safe Haskell	None
Language	Haskell2010

Camfort.Specification.Units.Monad

Description

Defines the monad for the units-of-measure modules

Synopsis

Documentation

type UA = Analysis (UnitAnnotation A) Source #

type VV = (Name, Name) Source #

A (unique name, source name) variable

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

The monad

data UnitOpts Source #

Options for the unit solver

Constructors

UnitOpts
Fields uoDebug :: Bool debugging mode? uoLiterals :: LiteralsOpt how to handle literals uoModFiles :: Map String ModFile map of included modules

Instances

Eq UnitOpts Source #
Methods (==) :: UnitOpts -> UnitOpts -> Bool # (/=) :: UnitOpts -> UnitOpts -> Bool #
Data UnitOpts Source #
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 Source #
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 #
Methods showsPrec :: Int -> UnitOpts -> ShowS # show :: UnitOpts -> String # showList :: [UnitOpts] -> ShowS #

unitOpts0 :: UnitOpts Source #

type UnitLogs = String Source #

data UnitState Source #

Working state for the monad

Constructors

UnitState
Fields usProgramFile :: ProgramFile UA usVarUnitMap :: VarUnitMap usGivenVarSet :: GivenVarSet usUnitAliasMap :: UnitAliasMap usTemplateMap :: TemplateMap usNameParamMap :: NameParamMap usLitNums :: Int usCallIds :: Int usCallIdRemap :: CallIdMap usConstraints :: Constraints

Instances

Data UnitState Source #
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 Source #
Methods showsPrec :: Int -> UnitState -> ShowS # show :: UnitState -> String # showList :: [UnitState] -> ShowS #

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

Eq LiteralsOpt Source #
Methods (==) :: LiteralsOpt -> LiteralsOpt -> Bool # (/=) :: LiteralsOpt -> LiteralsOpt -> Bool #
Data LiteralsOpt Source #
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 Source #
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 #
Methods readsPrec :: Int -> ReadS LiteralsOpt # readList :: ReadS [LiteralsOpt] # readPrec :: ReadPrec LiteralsOpt # readListPrec :: ReadPrec [LiteralsOpt] #
Show LiteralsOpt Source #
Methods showsPrec :: Int -> LiteralsOpt -> ShowS # show :: LiteralsOpt -> String # showList :: [LiteralsOpt] -> ShowS #

type UnitException = () Source #

whenDebug :: UnitSolver () -> UnitSolver () Source #

Only run the argument if debugging mode enabled.

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

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

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

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

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

modifyNameParamMap :: (NameParamMap -> NameParamMap) -> UnitSolver () Source #

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

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

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

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

Run the unit solver monad.

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

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

data CompiledUnits Source #

The data-structure stored in 'fortran-src mod files'

Constructors

CompiledUnits
Fields cuTemplateMap :: TemplateMap cuNameParamMap :: NameParamMap

Instances

Eq CompiledUnits Source #
Methods (==) :: CompiledUnits -> CompiledUnits -> Bool # (/=) :: CompiledUnits -> CompiledUnits -> Bool #
Data CompiledUnits Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CompiledUnits -> c CompiledUnits # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CompiledUnits # toConstr :: CompiledUnits -> Constr # dataTypeOf :: CompiledUnits -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c CompiledUnits) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CompiledUnits) # gmapT :: (forall b. Data b => b -> b) -> CompiledUnits -> CompiledUnits # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CompiledUnits -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CompiledUnits -> r # gmapQ :: (forall d. Data d => d -> u) -> CompiledUnits -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CompiledUnits -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CompiledUnits -> m CompiledUnits # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CompiledUnits -> m CompiledUnits # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CompiledUnits -> m CompiledUnits #
Ord CompiledUnits Source #
Methods compare :: CompiledUnits -> CompiledUnits -> Ordering # (<) :: CompiledUnits -> CompiledUnits -> Bool # (<=) :: CompiledUnits -> CompiledUnits -> Bool # (>) :: CompiledUnits -> CompiledUnits -> Bool # (>=) :: CompiledUnits -> CompiledUnits -> Bool # max :: CompiledUnits -> CompiledUnits -> CompiledUnits # min :: CompiledUnits -> CompiledUnits -> CompiledUnits #
Show CompiledUnits Source #
Methods showsPrec :: Int -> CompiledUnits -> ShowS # show :: CompiledUnits -> String # showList :: [CompiledUnits] -> ShowS #
Generic CompiledUnits Source #
Associated Types type Rep CompiledUnits :: * -> * # Methods from :: CompiledUnits -> Rep CompiledUnits x # to :: Rep CompiledUnits x -> CompiledUnits #
Binary CompiledUnits Source #
Methods put :: CompiledUnits -> Put # get :: Get CompiledUnits # putList :: [CompiledUnits] -> Put #
type Rep CompiledUnits Source #
type Rep CompiledUnits = D1 (MetaData "CompiledUnits" "Camfort.Specification.Units.Monad" "camfort-0.904-Fd2p4aOxDp58zSsRDqamtC" False) (C1 (MetaCons "CompiledUnits" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "cuTemplateMap") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TemplateMap)) (S1 (MetaSel (Just Symbol "cuNameParamMap") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 NameParamMap))))

type NameParamMap = 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

Eq NameParamKey Source #
Methods (==) :: NameParamKey -> NameParamKey -> Bool # (/=) :: NameParamKey -> NameParamKey -> Bool #
Data NameParamKey Source #
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 :: (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 #
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 #
Methods showsPrec :: Int -> NameParamKey -> ShowS # show :: NameParamKey -> String # showList :: [NameParamKey] -> ShowS #
Generic NameParamKey Source #
Associated Types type Rep NameParamKey :: * -> * # Methods from :: NameParamKey -> Rep NameParamKey x # to :: Rep NameParamKey x -> NameParamKey #
Binary NameParamKey Source #
Methods put :: NameParamKey -> Put # get :: Get NameParamKey # putList :: [NameParamKey] -> Put #
type Rep NameParamKey Source #
type Rep NameParamKey = D1 (MetaData "NameParamKey" "Camfort.Specification.Units.Monad" "camfort-0.904-Fd2p4aOxDp58zSsRDqamtC" False) ((:+:) (C1 (MetaCons "NPKParam" PrefixI False) ((:*:) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 PP)) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))) (C1 (MetaCons "NPKVariable" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 VV))))

emptyCompiledUnits :: CompiledUnits Source #