Copyright	(c) Dominik Schrempf 2021
License	GPL-3.0-or-later
Maintainer	dominik.schrempf@gmail.com
Stability	unstable
Portability	portable
Safe Haskell	None
Language	Haskell2010

ELynx.Tools.Reproduction

Contents

Reproduction

Description

Creation date: Tue Nov 19 15:07:09 2019.

Use of standard input is not supported.

Synopsis

data SeedOpt
- = RandomUnset
- | RandomSet (Vector Word32)
- | Fixed (Vector Word32)
class Reproducible a where
- inFiles :: a -> [FilePath]
- outSuffixes :: a -> [String]
- getSeed :: a -> Maybe SeedOpt
- setSeed :: a -> SeedOpt -> a
- parser :: Parser a
- cmdName :: String
- cmdDsc :: [String]
- cmdFtr :: [String]
getReproductionHash :: forall a. Reproducible a => Reproduction a -> String
data Reproduction a = Reproduction {
- progName :: String
- argsStr :: [String]
- rVersion :: Version
- rHash :: Maybe String
- files :: [FilePath]
- checkSums :: [String]
- reproducible :: a
}
writeReproduction :: forall a. (Eq a, Show a, Reproducible a, ToJSON a) => String -> a -> IO ()
hashFile :: FilePath -> IO ByteString

Reproduction

data SeedOpt Source #

Random or fixed seed.

Constructors

RandomUnset
RandomSet (Vector Word32)
Fixed (Vector Word32)

Instances

Instances details

Eq SeedOpt Source #
Instance details Defined in ELynx.Tools.Reproduction Methods (==) :: SeedOpt -> SeedOpt -> Bool # (/=) :: SeedOpt -> SeedOpt -> Bool #
Show SeedOpt Source #
Instance details Defined in ELynx.Tools.Reproduction Methods showsPrec :: Int -> SeedOpt -> ShowS # show :: SeedOpt -> String # showList :: [SeedOpt] -> ShowS #
Generic SeedOpt Source #
Instance details Defined in ELynx.Tools.Reproduction Associated Types type Rep SeedOpt :: Type -> Type # Methods from :: SeedOpt -> Rep SeedOpt x # to :: Rep SeedOpt x -> SeedOpt #
ToJSON SeedOpt Source #
Instance details Defined in ELynx.Tools.Reproduction Methods toJSON :: SeedOpt -> Value # toEncoding :: SeedOpt -> Encoding # toJSONList :: [SeedOpt] -> Value # toEncodingList :: [SeedOpt] -> Encoding #
FromJSON SeedOpt Source #
Instance details Defined in ELynx.Tools.Reproduction Methods parseJSON :: Value -> Parser SeedOpt # parseJSONList :: Value -> Parser [SeedOpt] #
type Rep SeedOpt Source #
Instance details Defined in ELynx.Tools.Reproduction type Rep SeedOpt = D1 ('MetaData "SeedOpt" "ELynx.Tools.Reproduction" "elynx-tools-0.6.1.0-AWjKNFEpQDhHVmYwSmmoU2" 'False) (C1 ('MetaCons "RandomUnset" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "RandomSet" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Word32))) :+: C1 ('MetaCons "Fixed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Word32)))))

class Reproducible a where Source #

Reproducible commands have - a set of input files to be checked for consistency, - a set of output suffixes which define output files to be checked for consistency, - a function to get the seed, if available, - a function to set the seed, if applicable, - a parser to read the command line, - a nice program name, description, and footer.

Minimal complete definition

inFiles, outSuffixes, getSeed, setSeed, parser, cmdName, cmdDsc

Methods

inFiles :: a -> [FilePath] Source #

outSuffixes :: a -> [String] Source #

getSeed :: a -> Maybe SeedOpt Source #

setSeed :: a -> SeedOpt -> a Source #

parser :: Parser a Source #

cmdName :: String Source #

cmdDsc :: [String] Source #

cmdFtr :: [String] Source #

Instances

Instances details

Reproducible a => Reproducible (Arguments a) Source #
Instance details Defined in ELynx.Tools.Options Methods inFiles :: Arguments a -> [FilePath] Source # outSuffixes :: Arguments a -> [String] Source # getSeed :: Arguments a -> Maybe SeedOpt Source # setSeed :: Arguments a -> SeedOpt -> Arguments a Source # parser :: Parser (Arguments a) Source # cmdName :: String Source # cmdDsc :: [String] Source # cmdFtr :: [String] Source #

getReproductionHash :: forall a. Reproducible a => Reproduction a -> String Source #

A unique hash of the reproduction data type.

data Reproduction a Source #

Necessary information for a reproducible run. Notably, the input files are checked for consistency!

Constructors

Reproduction
Fields progName :: String Program name. argsStr :: [String] Command line arguments without program name. rVersion :: Version rHash :: Maybe String Unique hash; see `getReproductionHash`. files :: [FilePath] File paths of used files. checkSums :: [String] SHA256 sums of used files. reproducible :: a Command argument.

Instances

Instances details

Generic (Reproduction a) Source #
Instance details Defined in ELynx.Tools.Reproduction Associated Types type Rep (Reproduction a) :: Type -> Type # Methods from :: Reproduction a -> Rep (Reproduction a) x # to :: Rep (Reproduction a) x -> Reproduction a #
ToJSON a => ToJSON (Reproduction a) Source #
Instance details Defined in ELynx.Tools.Reproduction Methods toJSON :: Reproduction a -> Value # toEncoding :: Reproduction a -> Encoding # toJSONList :: [Reproduction a] -> Value # toEncodingList :: [Reproduction a] -> Encoding #
FromJSON a => FromJSON (Reproduction a) Source #
Instance details Defined in ELynx.Tools.Reproduction Methods parseJSON :: Value -> Parser (Reproduction a) # parseJSONList :: Value -> Parser [Reproduction a] #
type Rep (Reproduction a) Source #
Instance details Defined in ELynx.Tools.Reproduction type Rep (Reproduction a) = D1 ('MetaData "Reproduction" "ELynx.Tools.Reproduction" "elynx-tools-0.6.1.0-AWjKNFEpQDhHVmYwSmmoU2" 'False) (C1 ('MetaCons "Reproduction" 'PrefixI 'True) ((S1 ('MetaSel ('Just "progName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :: (S1 ('MetaSel ('Just "argsStr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :: S1 ('MetaSel ('Just "rVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Version))) :: ((S1 ('MetaSel ('Just "rHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe String)) :: S1 ('MetaSel ('Just "files") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath])) :: (S1 ('MetaSel ('Just "checkSums") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String]) :: S1 ('MetaSel ('Just "reproducible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))))

writeReproduction :: forall a. (Eq a, Show a, Reproducible a, ToJSON a) => String -> a -> IO () Source #

Write an ELynx reproduction file.

hashFile :: FilePath -> IO ByteString Source #

Helper function.