Simulation.Aivika.Experiment.Base.ExperimentWriter

Tested with: GHC 8.0.1

It defines the Exp monad that allows providing computation with an ability to resolve file paths.

Documentation

data ExperimentWriter a

Defines an IO derived computation whithin which we can resolve the unique file paths.

Instances

Monad ExperimentWriter

Methods

(>>=) :: ExperimentWriter a -> (a -> ExperimentWriter b) -> ExperimentWriter b

(>>) :: ExperimentWriter a -> ExperimentWriter b -> ExperimentWriter b

return :: a -> ExperimentWriter a

fail :: String -> ExperimentWriter a

Functor ExperimentWriter

Methods

fmap :: (a -> b) -> ExperimentWriter a -> ExperimentWriter b

(<$) :: a -> ExperimentWriter b -> ExperimentWriter a

Applicative ExperimentWriter

Methods

pure :: a -> ExperimentWriter a

(<*>) :: ExperimentWriter (a -> b) -> ExperimentWriter a -> ExperimentWriter b

(*>) :: ExperimentWriter a -> ExperimentWriter b -> ExperimentWriter b

(<*) :: ExperimentWriter a -> ExperimentWriter b -> ExperimentWriter a

MonadException ExperimentWriter

Methods

catchComp :: Exception e => ExperimentWriter a -> (e -> ExperimentWriter a) -> ExperimentWriter a

finallyComp :: ExperimentWriter a -> ExperimentWriter b -> ExperimentWriter a

throwComp :: Exception e => e -> ExperimentWriter a

MonadIO ExperimentWriter

Methods

liftIO :: IO a -> ExperimentWriter a

runExperimentWriter :: ExperimentWriter a -> IO a

Run the ExperimentWriter computation.

data ExperimentFilePath

Specifies the file name, unique or writable, which can be appended with extension if required.

Constructors

WritableFilePath FilePath

The file which is overwritten in case if it existed before.

UniqueFilePath FilePath

The file which is always unique, when an automatically generated suffix is added to the name in case of need.

experimentFilePath :: ExperimentFilePath

The default experiment file path.

resolveFilePath :: FilePath -> ExperimentFilePath -> ExperimentWriter FilePath

Resolve the file path relative to the specified directory passed in the first argument and taking into account a possible requirement to have an unique file name.

expandFilePath :: ExperimentFilePath -> Map String String -> ExperimentFilePath

Expand the file path using the specified table of substitutions.

mapFilePath :: (FilePath -> FilePath) -> ExperimentFilePath -> ExperimentFilePath

Transform the file path using the specified function.