Moduleweigh-0.0.18Haskell2010

Weigh

Framework for seeing how much a function allocates.

WARNING: weigh is incompatible with profiling. It reports much more allocations with profiling turned on.

Example:

import Weigh
main =
  mainWith (do func "integers count 0" count 0
               func "integers count 1" count 1
               func "integers count 2" count 2
               func "integers count 3" count 3
               func "integers count 10" count 10
               func "integers count 100" count 100)
  where count :: Integer -> ()
        count 0 = ()
        count a = count (a - 1)

Use wgroup to group sets of tests.

Contents

Main entry points
Configuration
Simple combinators
Validating combinators
Validators
Types
Handy utilities
Internals

Synopsis

value mainWith
value weighResults
value setColumns
data Column
value setFormat
data Format
value setConfig
data Config
value defaultConfig
value func
value func'
value io
value value
value action
value wgroup
value validateAction
value validateFunc
value maxAllocs
newtype Weigh
data Weight
value commas
value reportGroup
value weighDispatch
value weighFunc
value weighFuncResult
value weighAction
value weighActionResult
data Grouped

Packageweigh-0.0.18
Exports28
LanguageHaskell2010
LicenceBSD-3-Clause
SourceWeigh.hs

Main entry points

valuemainWith :: Weigh a -> IO ()

Source#

Just run the measuring and print a report. Uses weighResults.

valueweighResults :: Weigh a -> IO ([Grouped (Weight, Maybe String)], Config)

Source#

Run the measuring and return all the results, each one may have an error.

Configuration

valuesetColumns :: [Column] -> Weigh ()

Source#

Set the columns to display in the config

datadata Column

Source#

Table column.

Constructors

Case
Case name for the column
Allocated
Total bytes allocated
GCs
Total number of GCs
Live
Total amount of live data in the heap
Check
Table column indicating about the test status
Max
Maximum residency memory in use
MaxOS
Maximum memory in use by the RTS. Valid only for GHC >= 8.2.2. For unsupported GHC, this is reported as 0.
WallTime
Rough execution time. For general indication, not a benchmark tool.

Instances3Enum, Eq, Show

Enum ColumnDefined in weigh-0.0.18 · Weigh
Eq ColumnDefined in weigh-0.0.18 · Weigh
Show ColumnDefined in weigh-0.0.18 · Weigh

valuesetFormat :: Format -> Weigh ()

Source#

Set the output format in the config

datadata Format

Plain Markdown

Instances1Show

Show FormatDefined in weigh-0.0.18 · Weigh

valuesetConfig :: Config -> Weigh ()

Source#

Set the config. Default is: defaultConfig.

datadata Config

Source#

Weigh configuration.

Constructors

Config
- configColumns :: [Column]
- configPrefix :: String
- configFormat :: !Format

Instances1Show

Show ConfigDefined in weigh-0.0.18 · Weigh

valuedefaultConfig :: Config

Source#

Default config.

Simple combinators

valuefunc

:: NFData a
=> String
Name of the case.
-> (b -> a)
Function that does some action to measure.
-> b
Argument to that function.
-> Weigh ()

Source#

Weigh a function applied to an argument.

Implemented in terms of validateFunc.

valuefunc' :: (NFData a, NFData b) => String -> (b -> a) -> b -> Weigh ()

Source#

Weigh a function applied to an argument. Unlike func, the argument is evaluated to normal form before the function is applied.

valueio

:: NFData a
=> String
Name of the case.
-> (b -> IO a)
Action that does some IO to measure.
-> b
Argument to that function.
-> Weigh ()

Source#

Weigh an action applied to an argument.

Implemented in terms of validateAction.

valuevalue

:: NFData a
=> String
Name for the value.
-> a
The value to measure.
-> Weigh ()

Source#

Weigh a value.

Implemented in terms of action.

valueaction

:: NFData a
=> String
Name for the value.
-> IO a
The action to measure.
-> Weigh ()

Source#

Weigh an IO action.

Implemented in terms of validateAction.

valuewgroup :: String -> Weigh () -> Weigh ()

Source#

Make a grouping of tests.

Validating combinators

valuevalidateAction

:: NFData a
=> String
Name of the action.
-> (b -> IO a)
The function which performs some IO.
-> b
Argument to the function. Doesn't have to be forced.
-> (Weight -> Maybe String)
A validating function, returns maybe an error.
-> Weigh ()

Source#

Weigh an IO action, validating the result.

valuevalidateFunc

:: NFData a
=> String
Name of the function.
-> (b -> a)
The function which calculates something.
-> b
Argument to the function. Doesn't have to be forced.
-> (Weight -> Maybe String)
A validating function, returns maybe an error.
-> Weigh ()

Source#

Weigh a function, validating the result

Validators

valuemaxAllocs

:: Word64
The upper bound.
-> Weight
-> Maybe String

Source#

Make a validator that set sthe maximum allocations.

Types

newtypenewtype Weigh a

Source#

Weigh specification monad.

Instances3Monad, Functor, Applicative

Monad WeighDefined in weigh-0.0.18 · Weigh
Functor WeighDefined in weigh-0.0.18 · Weigh
Applicative WeighDefined in weigh-0.0.18 · Weigh

datadata Weight

Source#

How much a computation weighed in at.

Constructors

Weight
- weightLabel :: !String
- weightAllocatedBytes :: !Word64
- weightGCs :: !Word32
- weightLiveBytes :: !Word64
- weightMaxBytes :: !Word64
- weightMaxOSBytes :: !Word64
- weightWallTime :: !Double

Instances2Read, Show

Read WeightDefined in weigh-0.0.18 · Weigh
Show WeightDefined in weigh-0.0.18 · Weigh

Handy utilities

valuecommas :: (Num a, Integral a, Show a) => a -> String

Source#

Formatting an integral number to 1,000,000, etc.

valuereportGroup

:: Config
-> [Char]
-> [Grouped (Weight, Maybe String)]
-> [Char]

Internals

valueweighDispatch

:: Maybe String
The content of then env variable WEIGH_CASE.
-> [Grouped Action]
Weigh name:action mapping.
-> IO (Maybe [Grouped Weight])

Source#

Weigh a set of actions. The value of the actions are forced completely to ensure they are fully allocated.

valueweighFunc

:: NFData a
=> (b -> a)
A function whose memory use we want to measure.
-> b
Argument to the function. Doesn't have to be forced.
-> IO (Word64, Word32, Word64, Word64, Word64)
Bytes allocated and garbage collections.

Source#

Weigh a pure function. This function is built on top of weighFuncResult, which is heavily documented inside

valueweighFuncResult

:: NFData a
=> (b -> a)
A function whose memory use we want to measure.
-> b
Argument to the function. Doesn't have to be forced.
-> IO (a, (Word64, Word32, Word64, Word64, Word64))
Result, Bytes allocated, GCs.

Source#

Weigh a pure function and return the result. This function is heavily documented inside.

valueweighAction

:: NFData a
=> (b -> IO a)
A function whose memory use we want to measure.
-> b
Argument to the function. Doesn't have to be forced.
-> IO (Word64, Word32, Word64, Word64, Word64)
Bytes allocated and garbage collections.

Source#

Weigh an IO action. This function is based on weighActionResult, which is heavily documented inside.

valueweighActionResult

:: NFData a
=> (b -> IO a)
A function whose memory use we want to measure.
-> b
Argument to the function. Doesn't have to be forced.
-> IO (a, (Word64, Word32, Word64, Word64, Word64))
Result, Bytes allocated and GCs.

Source#

Weigh an IO action, and return the result. This function is heavily documented inside.

datadata Grouped a

Source#

Some grouped thing.

Constructors

Grouped String [Grouped a]
Singleton a

Instances8Functor, Foldable, Traversable, Eq, Show, Generic, …

Functor GroupedDefined in weigh-0.0.18 · Weigh
Foldable GroupedDefined in weigh-0.0.18 · Weigh
Traversable GroupedDefined in weigh-0.0.18 · Weigh
Eq a => Eq (Grouped a)Defined in weigh-0.0.18 · Weigh
Show a => Show (Grouped a)Defined in weigh-0.0.18 · Weigh
Generic (Grouped a)Defined in weigh-0.0.18 · Weigh
NFData a => NFData (Grouped a)Defined in weigh-0.0.18 · Weigh
type Rep (Grouped a) = D1 ('MetaData "Grouped" "Weigh" "weigh-0.0.18-2Xf5DKnZcnzC6iiAC1lF4s" 'False) (C1 ('MetaCons "Grouped" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Grouped a])) :+: C1 ('MetaCons "Singleton" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))Defined in weigh-0.0.18 · Weigh