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 = StateT UnitState UnitAnalysis

UnitSolvers are analyses annotated with unit information.

data UnitOpts

Options for the unit solver

Constructors

UnitOpts

Fields

• uoLiterals :: LiteralsOpt

  how to handle literals

Instances

Eq UnitOpts

Defined in Camfort.Specification.Units.MonadTypes

Methods

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

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

Data UnitOpts

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

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

Defined in Camfort.Specification.Units.MonadTypes

Methods

showsPrec :: Int -> UnitOpts -> ShowS

show :: UnitOpts -> String

showList :: [UnitOpts] -> ShowS

unitOpts0 :: UnitOpts

data UnitState

Working state for the monad

Instances

Data UnitState

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

Defined in Camfort.Specification.Units.MonadTypes

Methods

showsPrec :: Int -> UnitState -> ShowS

show :: UnitState -> String

showList :: [UnitState] -> ShowS

data UnitEnv

Constructors

UnitEnv

Fields

• unitOpts :: UnitOpts
• unitProgramFile :: ProgramFile Annotation

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

Defined in Camfort.Specification.Units.MonadTypes

Methods

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

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

Data LiteralsOpt

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

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

Defined in Camfort.Specification.Units.MonadTypes

Methods

readsPrec :: Int -> ReadS LiteralsOpt

readList :: ReadS [LiteralsOpt]

readPrec :: ReadPrec LiteralsOpt

readListPrec :: ReadPrec [LiteralsOpt]

Show LiteralsOpt

Defined in Camfort.Specification.Units.MonadTypes

Methods

showsPrec :: Int -> LiteralsOpt -> ShowS

show :: LiteralsOpt -> String

showList :: [LiteralsOpt] -> ShowS

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

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

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

data NameParamKey

Things that can be exported from modules

Constructors

NPKParam PP Int

Function/subroutine name, position of parameter

NPKVariable VV

variable

Instances

Eq NameParamKey

Defined in Camfort.Specification.Units.MonadTypes

Methods

(==) :: NameParamKey -> NameParamKey -> Bool

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

Data NameParamKey

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

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

Defined in Camfort.Specification.Units.MonadTypes

Methods

showsPrec :: Int -> NameParamKey -> ShowS

show :: NameParamKey -> String

showList :: [NameParamKey] -> ShowS

Generic NameParamKey

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

Defined in Camfort.Specification.Units.MonadTypes

Methods

put :: NameParamKey -> Put

get :: Get NameParamKey

putList :: [NameParamKey] -> Put

type Rep NameParamKey

Defined in Camfort.Specification.Units.MonadTypes

type Rep NameParamKey = D1 ('MetaData "NameParamKey" "Camfort.Specification.Units.MonadTypes" "camfort-1.1.2-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)))

State Helpers

freshId :: UnitSolver Int

Generate a number guaranteed to be unique in the current analysis.

Getters

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

Modifiers

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

Runners

runUnitSolver :: ProgramFile UA -> UnitSolver a -> UnitAnalysis (a, UnitState)

Runs the stateful part of the unit solver.

runUnitAnalysis :: UnitEnv -> UnitAnalysis a -> AnalysisT () () IO a