Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Defines description generators for common SCS functions, classes, and modules.
Synopsis
- modDesc :: GenState [Description] -> GenState Description
- unmodularDesc :: GenState Description
- inputParametersDesc :: GenState [Description]
- inputConstructorDesc :: GenState Description
- inputFormatDesc :: GenState Description
- derivedValuesDesc :: GenState Description
- inputConstraintsDesc :: GenState Description
- constModDesc :: GenState Description
- outputFormatDesc :: GenState Description
- inputClassDesc :: GenState Description
- constClassDesc :: GenState Description
- inFmtFuncDesc :: GenState Description
- inConsFuncDesc :: GenState Description
- dvFuncDesc :: GenState Description
- calcModDesc :: Description
- woFuncDesc :: GenState Description
Documentation
modDesc :: GenState [Description] -> GenState Description Source #
Returns a module description based on a list of descriptions of what is contained in the module.
unmodularDesc :: GenState Description Source #
Returns description of what is contained in the module that is generated when the user chooses an Unmodular design. Module is described as either a program or library, depending on the user's choice of implementation type.
inputParametersDesc :: GenState [Description] Source #
Returns description of what is contained in the Input Parameters module.
If user chooses the Bundled
input parameter, this module will include the structure for holding the
input values. Does not include the structure if they choose Unbundled
.
If the user chooses the Combined
input parameter, this module includes the input-related functions.
Does not inlcude those functions if they choose Separated
.
inputConstructorDesc :: GenState Description Source #
Returns a description of the input constructor, checking whether each possible method that may be called by the constructor is defined, and including it in the description if so.
inputFormatDesc :: GenState Description Source #
Returns a description of what is contained in the Input Format module, if it exists.
derivedValuesDesc :: GenState Description Source #
Returns a description of what is contained in the Derived Values module, if it exists.
inputConstraintsDesc :: GenState Description Source #
Returns a description of what is contained in the Input Constraints module, if it exists.
constModDesc :: GenState Description Source #
Returns a description of what is contained in the Constants module, if it exists.
outputFormatDesc :: GenState Description Source #
Returns a description of what is contained in the Output Format module, if it exists.
inputClassDesc :: GenState Description Source #
Returns a description for the generated function that stores inputs, if it exists. Checks whether explicit inputs, derived inputs, and constants are defined in the InputParameters class and includes each in the description if so.
constClassDesc :: GenState Description Source #
Returns a description for the generated class that stores constants, if it exists. If no constants are defined in the Constants class, then it does not exist and an empty description is returned.
inFmtFuncDesc :: GenState Description Source #
Returns a description for the generated function that reads input from a file, if it exists.
inConsFuncDesc :: GenState Description Source #
Returns a description for the generated function that checks input constraints, if it exists.
dvFuncDesc :: GenState Description Source #
Returns a description for the generated function that calculates derived inputs, if it exists.
calcModDesc :: Description Source #
Description of the generated Calculations module.
woFuncDesc :: GenState Description Source #
Returns description for generated output-printing function, if it exists.