Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Reporting on performance, potentially checking versus a canned results.
Synopsis
- data Format
- parseFormat :: Format -> Parser Format
- data Header
- parseHeader :: Header -> Parser Header
- data CompareLevels = CompareLevels {}
- defaultCompareLevels :: CompareLevels
- parseCompareLevels :: CompareLevels -> Parser CompareLevels
- data ReportConfig = ReportConfig {}
- defaultReportConfig :: ReportConfig
- parseReportConfig :: ReportConfig -> Parser ReportConfig
- writeResult :: FilePath -> Map [Text] Double -> IO ()
- readResult :: FilePath -> IO (Map [Text] Double)
- data CompareResult = CompareResult {}
- compareNote :: Ord a => CompareLevels -> Map a Double -> Map a Double -> Map a CompareResult
- outercalate :: Text -> [Text] -> Text
- reportGolden :: ReportConfig -> FilePath -> Map [Text] Double -> IO ()
- reportOrg2D :: Map [Text] Text -> IO ()
- data Golden = Golden {}
- parseGolden :: String -> Parser Golden
- report :: ReportConfig -> Golden -> [Text] -> Map [Text] [Double] -> IO ()
Documentation
Type of format for report
Whether to include header information.
data CompareLevels Source #
Levels of geometric difference in compared performance that triggers reporting.
Instances
Show CompareLevels Source # | |
Defined in Perf.Report showsPrec :: Int -> CompareLevels -> ShowS # show :: CompareLevels -> String # showList :: [CompareLevels] -> ShowS # | |
Eq CompareLevels Source # | |
Defined in Perf.Report (==) :: CompareLevels -> CompareLevels -> Bool # (/=) :: CompareLevels -> CompareLevels -> Bool # |
defaultCompareLevels :: CompareLevels Source #
>>>
defaultCompareLevels
CompareLevels {errorLevel = 0.2, warningLevel = 5.0e-2, improvedLevel = 5.0e-2}
parseCompareLevels :: CompareLevels -> Parser CompareLevels Source #
Command-line parser for CompareLevels
data ReportConfig Source #
Report configuration options
Instances
defaultReportConfig :: ReportConfig Source #
>>>
defaultReportConfig
ReportConfig {format = ConsoleMode, includeHeader = Header, levels = CompareLevels {errorLevel = 0.2, warningLevel = 5.0e-2, improvedLevel = 5.0e-2}}
parseReportConfig :: ReportConfig -> Parser ReportConfig Source #
Parse ReportConfig
command line options.
data CompareResult Source #
Comparison data between two results.
Instances
Show CompareResult Source # | |
Defined in Perf.Report showsPrec :: Int -> CompareResult -> ShowS # show :: CompareResult -> String # showList :: [CompareResult] -> ShowS # | |
Eq CompareResult Source # | |
Defined in Perf.Report (==) :: CompareResult -> CompareResult -> Bool # (/=) :: CompareResult -> CompareResult -> Bool # |
compareNote :: Ord a => CompareLevels -> Map a Double -> Map a Double -> Map a CompareResult Source #
Compare two results and produce some notes given level triggers.
reportGolden :: ReportConfig -> FilePath -> Map [Text] Double -> IO () Source #
Report to a console, comparing the measurement versus a canned file.
Golden file options.
Instances
Generic Golden Source # | |
Show Golden Source # | |
Eq Golden Source # | |
type Rep Golden Source # | |
Defined in Perf.Report type Rep Golden = D1 ('MetaData "Golden" "Perf.Report" "perf-0.10.1-EUiicY4SYVb4NpAUwDYcFr" 'False) (C1 ('MetaCons "Golden" 'PrefixI 'True) (S1 ('MetaSel ('Just "golden") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: (S1 ('MetaSel ('Just "check") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "record") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))) |