Perf.Report

Reporting on performance, potentially checking versus a canned results.

Documentation

data Format

Type of format for report

Constructors

OrgMode

ConsoleMode

Instances

Generic Format

Defined in Perf.Report

Associated Types

type Rep Format :: Type -> Type

Methods

from :: Format -> Rep Format x

to :: Rep Format x -> Format

Show Format

Defined in Perf.Report

Methods

showsPrec :: Int -> Format -> ShowS

show :: Format -> String

showList :: [Format] -> ShowS

Eq Format

Defined in Perf.Report

Methods

(==) :: Format -> Format -> Bool

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

type Rep Format

Defined in Perf.Report

type Rep Format = D1 ('MetaData "Format" "Perf.Report" "perf-0.10.1-EUiicY4SYVb4NpAUwDYcFr" 'False) (C1 ('MetaCons "OrgMode" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ConsoleMode" 'PrefixI 'False) (U1 :: Type -> Type))

parseFormat :: Format -> Parser Format

Command-line parser for Format

data Header

Whether to include header information.

Constructors

Header

NoHeader

Instances

Generic Header

Defined in Perf.Report

Associated Types

type Rep Header :: Type -> Type

Methods

from :: Header -> Rep Header x

to :: Rep Header x -> Header

Show Header

Defined in Perf.Report

Methods

showsPrec :: Int -> Header -> ShowS

show :: Header -> String

showList :: [Header] -> ShowS

Eq Header

Defined in Perf.Report

Methods

(==) :: Header -> Header -> Bool

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

type Rep Header

Defined in Perf.Report

type Rep Header = D1 ('MetaData "Header" "Perf.Report" "perf-0.10.1-EUiicY4SYVb4NpAUwDYcFr" 'False) (C1 ('MetaCons "Header" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoHeader" 'PrefixI 'False) (U1 :: Type -> Type))

parseHeader :: Header -> Parser Header

Command-line parser for Header

data CompareLevels

Levels of geometric difference in compared performance that triggers reporting.

Constructors

CompareLevels

Fields

• errorLevel :: Double
• warningLevel :: Double
• improvedLevel :: Double

Instances

Show CompareLevels

Defined in Perf.Report

Methods

showsPrec :: Int -> CompareLevels -> ShowS

show :: CompareLevels -> String

showList :: [CompareLevels] -> ShowS

Eq CompareLevels

Defined in Perf.Report

Methods

(==) :: CompareLevels -> CompareLevels -> Bool

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

defaultCompareLevels :: CompareLevels

>>> defaultCompareLevels
CompareLevels {errorLevel = 0.2, warningLevel = 5.0e-2, improvedLevel = 5.0e-2}

parseCompareLevels :: CompareLevels -> Parser CompareLevels

Command-line parser for CompareLevels

data ReportConfig

Report configuration options

Constructors

ReportConfig

Fields

• format :: Format
• includeHeader :: Header
• levels :: CompareLevels

Instances

Generic ReportConfig

Defined in Perf.Report

Associated Types

type Rep ReportConfig :: Type -> Type

Methods

from :: ReportConfig -> Rep ReportConfig x

to :: Rep ReportConfig x -> ReportConfig

Show ReportConfig

Defined in Perf.Report

Methods

showsPrec :: Int -> ReportConfig -> ShowS

show :: ReportConfig -> String

showList :: [ReportConfig] -> ShowS

Eq ReportConfig

Defined in Perf.Report

Methods

(==) :: ReportConfig -> ReportConfig -> Bool

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

type Rep ReportConfig

Defined in Perf.Report

type Rep ReportConfig = D1 ('MetaData "ReportConfig" "Perf.Report" "perf-0.10.1-EUiicY4SYVb4NpAUwDYcFr" 'False) (C1 ('MetaCons "ReportConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Format) :*: (S1 ('MetaSel ('Just "includeHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Header) :*: S1 ('MetaSel ('Just "levels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CompareLevels))))

defaultReportConfig :: ReportConfig

>>> defaultReportConfig
ReportConfig {format = ConsoleMode, includeHeader = Header, levels = CompareLevels {errorLevel = 0.2, warningLevel = 5.0e-2, improvedLevel = 5.0e-2}}

parseReportConfig :: ReportConfig -> Parser ReportConfig

Parse ReportConfig command line options.

writeResult :: FilePath -> Map [Text] Double -> IO ()

Write results to file

readResult :: FilePath -> IO (Map [Text] Double)

Read results from file

data CompareResult

Comparison data between two results.

Constructors

CompareResult

Fields

• oldResult :: Maybe Double
• newResult :: Maybe Double
• noteResult :: Text

Instances

Show CompareResult

Defined in Perf.Report

Methods

showsPrec :: Int -> CompareResult -> ShowS

show :: CompareResult -> String

showList :: [CompareResult] -> ShowS

Eq CompareResult

Defined in Perf.Report

Methods

(==) :: CompareResult -> CompareResult -> Bool

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

compareNote :: Ord a => CompareLevels -> Map a Double -> Map a Double -> Map a CompareResult

Compare two results and produce some notes given level triggers.

outercalate :: Text -> [Text] -> Text

Like intercalate, but on the outside as well.

reportGolden :: ReportConfig -> FilePath -> Map [Text] Double -> IO ()

Report to a console, comparing the measurement versus a canned file.

reportOrg2D :: Map [Text] Text -> IO ()

Format a result as a table.

data Golden

Golden file options.

Constructors

Golden

Fields

• golden :: FilePath
• check :: Bool
• record :: Bool

Instances

Generic Golden

Defined in Perf.Report

Associated Types

type Rep Golden :: Type -> Type

Methods

from :: Golden -> Rep Golden x

to :: Rep Golden x -> Golden

Show Golden

Defined in Perf.Report

Methods

showsPrec :: Int -> Golden -> ShowS

show :: Golden -> String

showList :: [Golden] -> ShowS

Eq Golden

Defined in Perf.Report

Methods

(==) :: Golden -> Golden -> Bool

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

type Rep Golden

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

parseGolden :: String -> Parser Golden

Parse command-line golden file options.

report :: ReportConfig -> Golden -> [Text] -> Map [Text] [Double] -> IO ()

Report results