criterion- Robust, reliable performance measurement and analysis

Copyright(c) 2009-2014 Bryan O'Sullivan
Safe HaskellNone




Reporting functions.



formatReport Source


:: [Report] 
-> Text

Hastache template.

-> IO Text 

Format a series of Report values using the given Hastache template.

report :: [Report] -> Criterion () Source

Write out a series of Report values to a single file, if configured to do so.

tidyTails :: KDE -> KDE Source

Trim long flat tails from a KDE plot.

Rendering helper functions

loadTemplate Source


:: [FilePath]

Search path.

-> FilePath

Name of template file.

-> IO Text 

Load a Hastache template file.

If the name is an absolute or relative path, the search path is not used, and the name is treated as a literal path.

This function throws a TemplateException if the template could not be found, or an IOException if no template could be loaded.

includeFile Source


:: MonadIO m 
=> [FilePath]

Directories to search.

-> Text

Name of the file to search for.

-> m Text 

Attempt to include the contents of a file based on a search path. Returns empty if the search fails or the file could not be read.

Intended for use with Hastache's MuLambdaM, for example:

context "include" = MuLambdaM $ includeFile [templateDir]

Hastache template expansion is not performed within the included file. No attempt is made to ensure that the included file path is safe, i.e. that it does not refer to an unexpected file such as "etcpasswd".

getTemplateDir :: IO FilePath Source

Return the path to the template and other files used for generating reports.

vector Source


:: (Monad m, Vector v a, MuVar a) 
=> String

Name to use when substituting.

-> v a 
-> MuType m 

Render the elements of a vector.

For example, given this piece of Haskell:

mkStrContext $ \name ->
 case name of
   "foo" -> vector "x" foo

It will substitute each value in the vector for x in the following Hastache template:


vector2 Source


:: (Monad m, Vector v a, Vector v b, MuVar a, MuVar b) 
=> String

Name for elements from the first vector.

-> String

Name for elements from the second vector.

-> v a

First vector.

-> v b

Second vector.

-> MuType m 

Render the elements of two vectors.