Skip to content

Benchmark Summary #64

@hendriknielaender

Description

@hendriknielaender

Description

One feature that would significantly enhance its utility is the addition of a summary of the benchmarks at the end of its output, similar to the functionality offered by the hyperfine command-line tool.

Proposed Feature Details

The summary would be implemented as a method in the Benchmark class. This method would be responsible for formatting and displaying the summary. Here's a high-level overview of what the summary would include:

  • A bold "Summary" heading.
  • The name of the benchmark that ran the fastest, highlighted in green.
  • A comparison of each subsequent benchmark, showing how many times slower they are compared to the fastest one. This would be visually distinguished with indentation and color coding (e.g., green for the times faster value and blue for the benchmark name).

Use Case

This feature would be particularly useful for developers looking to:

  • Quickly assess the performance characteristics of their code.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions