MatthewPeterKelly/fractal-renderer

Add some benchmarks!

Open

#42 opened on Jun 4, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (0 forks)github user discovery
good first issue

Repository metrics

Stars
 (6 stars)
PR merge metrics
 (Avg merge 1d 16h) (6 merged PRs in 30d)

Description

One of the main focuses of this library is on making the fractal generation and rendering pipelines as fast as possible... it would be nice to have a way to automatically check if the changes in a given PR have an impact on the speed. The best way to do this is with a proper benchmarking suite. We have an approximation now, by measuring the time to generate each fractal and saving it to a file, but we could do much better.

It looks like https://crates.io/crates/criterion is a popular crate for doing this. There might be others.

Benchmarks to add:

  • Inner loop of the mandelbrot set (pixel iteration)
  • simulation for the DDP at a single initial condition
  • (TODO: add more ideas here)

Contributor guide

Research direction
Install the criterion crate and create benchmark tests for the mandelbrot inner loop and DDP simulation.
Tech stack
rust
Domain
performancetesting
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60