gleamy/bench

Types

BenchResults

pub type BenchResults {
  BenchResults(options: Options, sets: List(Set))
}

Constructors

BenchResults(options: Options, sets: List(Set))

Function

</>

pub type Function(a, b) {
  Function(label: String, function: fn(a) -> b)
  SetupFunction(
    label: String,
    setup_function: fn(a) -> fn(a) -> b,
  )
}

Constructors

Function(label: String, function: fn(a) -> b)

SetupFunction(label: String, setup_function: fn(a) -> fn(a) -> b)

Input

</>

pub type Input(a) {
  Input(label: String, value: a)
}

Constructors

```
Input(label: String, value: a)
```

Option

</>

pub type Option {
  Warmup(ms: Int)
  Duration(ms: Int)
  Decimals(n: Int)
  Quiet
}

Constructors

```
Warmup(ms: Int)
```
```
Duration(ms: Int)
```
```
Decimals(n: Int)
```
```
Quiet
```

Options

</>

pub type Options {
  Options(warmup: Int, duration: Int, decimals: Int, quiet: Bool)
}

Constructors

Options(warmup: Int, duration: Int, decimals: Int, quiet: Bool)

Set

</>

pub type Set {
  Set(input: String, function: String, reps: List(Float))
}

Constructors

Set(input: String, function: String, reps: List(Float))

Stat

</>

pub type Stat {
  P(Int)
  IPS
  Min
  Max
  Mean
  SD
  SDPercent
  Stat(name: String, calculate: fn(Set) -> Float)
}

Constructors

```
P(Int)
```
```
IPS
```
```
Min
```
```
Max
```
```
Mean
```
```
SD
```
```
SDPercent
```

Stat(name: String, calculate: fn(Set) -> Float)

Functions

do_repeat

</>

pub fn do_repeat(n: Int, input: a, fun: fn(a) -> b) -> Nil

now

</>

pub fn now() -> Float

timestamp in milliseconds

repeat

</>

pub fn repeat(n: Int, fun: fn(a) -> b) -> fn(a) -> Nil

run

</>

pub fn run(
  inputs: List(Input(a)),
  functions: List(Function(a, b)),
  options: List(Option),
) -> BenchResults

table

</>

pub fn table(result: BenchResults, stats: List(Stat)) -> String