# Glychee
[](https://hex.pm/packages/glychee)
[](https://hexdocs.pm/glychee/)
A simple Gleam benchmark runner which wraps
[Benchee](https://github.com/bencheeorg/benchee) for the heavy lifting.
Named after [Gleam](https://gleam.run), Benchee and their fruity offspring, [Lychee](https://en.wikipedia.org/wiki/Lychee):
<img src="https://upload.wikimedia.org/wikipedia/commons/4/46/Litchi_chinensis_fruits.JPG" alt="photo of a Lychee" style="max-height: 10em"/>
## Quick start
_Notice: Requires at least gleam 0.24 (or gleam 0.0.0-nightly-221019 or later)._
Also requires `Elixir` and `hex` be installed. You might be required to run
`mix local.hex` after installing Elixir.
1. Add glychee to your project: `gleam add glychee`.
2. Create a a custom benchmarking module for example named `my_benchmark` that
contains a `main`-function. In that module you will define which `Function`s
to benchmark with one or many `Data`.
3. Run the benchmark:
```sh
gleam clean && \
gleam build && \
erl -pa ./build/dev/erlang/*/ebin -noshell -eval 'gleam@@main:run(my_benchmark)'
```
### Full example
If you do not have a Gleam project yet, create it with:
```sh
gleam new foobar
cd foobar
```
In your project create a file named `src/benchmark.gleam` with following
source code:
```gleam
if erlang {
import glychee/benchmark
import gleam/list
import gleam/int
pub fn main() {
benchmark.run(
[
benchmark.Function(
label: "list.sort()",
callable:fn(test_data) {
fn() {
list.sort(test_data, int.compare)
}
},
),
],
[
benchmark.Data(
label: "pre-sorted list",
data: list.range(1, 100_000),
),
benchmark.Data(
label: "reversed list",
data: list.range(1, 100_000)
|> list.reverse,
),
],
)
}
}
```
Then run in your terminal via:
```sh
gleam clean && \
gleam build && \
erl -pa ./build/dev/erlang/*/ebin -noshell -eval 'gleam@@main:run(benchmark)'
```
Now you can alter the functions and data specified in above's example to
whichever function of your application or library you want to benchmark.
Note that you can benchmark multiple functions with different data sets
in one go.
## Installation
If available on Hex this package can be added to your Gleam project:
```sh
gleam add glychee
```
Glychee's documentation can be found at <https://hexdocs.pm/glychee>.
## License
Apache 2.0
