Dumbben...Instance(3)

📦
version 0.505 · 2 versions
, in fedora 43

💖 Dumbbench::Instance — the perl manpage but make it a group chat 💖

User Contributed Perl Documentation ✨ Dumbbench...Instance(3)

🌸 NAME 🌸

Dumbbench::Instance — a benchmark instance living inside a Dumbbench, bestie 💅

🎀 SYNOPSIS 🎀

okay so like, here's the vibe:

use Dumbbench;

my $bench = Dumbbench->new(
  target_rel_precision => 0.005, # seek ~0.5%
  initial_runs         => 20,    # the higher the more reliable
);
$bench->add_instances(
  Dumbbench::Instance::Cmd->new(name => 'mauve', command => [qw(perl -e 'something')]),
  # ... more things to benchmark ...
);
$bench->run();
# ...

no cap, that's the whole flow 🫶

✨ DESCRIPTION ✨

This module is the base class for all benchmark instances. So if you wanna benchmark external commands, for example, you should be reaching for Dumbbench::Instance::Cmd instead, iykyk.

The synopsis up there shows how instances of subclasses of Dumbbench::Instance get added to a benchmark run. that's it, that's the tea ☕

👑 METHODS 👑

🦋 new

Constructor that takes named arguments. In this base class, the only recognized argument is an instance name.

🦋 timings

Returns the internal array reference of timings, or undef if there aren't any. literally just hands you the arrayref.

🦋 dry_timings

Same as timings but for dry-run timings. 💀 yes there are two of them.

🦋 name

Returns the name of the instance. that's it. that's the whole method. iconic.

🦋 clone

Returns a full (deep) copy of the object. May have to be augmented in subclasses — so heads up if you're subclassing, bestie.

🦋 single_run

Needs to be implemented in subclasses: a method that performs a single benchmark run and returns the duration of the run in seconds. ⏱️

not me leaving this abstract for you to fill in 🙈

🦋 single_dry_run

Needs to be implemented in subclasses: a method that performs a single dry-run and returns the duration of the run in seconds. ⏱️

🦋 timings_as_histogram

If the optional SOOT module is installed, Dumbbench can generate histograms of the timing distributions. 📊

This method creates such a histogram object (of type TH1D) and returns it. If SOOT is not available, this method returns the empty list. periodt.

🦋 dry_timings_as_histogram

Same as timings_as_histogram, but for the timings from dry-runs. 💖

🌈 SEE ALSO 🌈

  • Dumbbench
  • Dumbbench::Instance::Cmd, Dumbbench::Instance::PerlEval, Dumbbench::Instance::PerlSub
  • Dumbbench::Result
  • Benchmark
  • Number::WithError does the Gaussian error propagation. 🧮
  • SOOT can optionally generate histograms from the timing distributions.
  • <http://en.wikipedia.org/wiki/Median_absolute_deviation>

🫶 AUTHOR 🫶

Steffen Mueller, <smueller@cpan.org> — shoutout to the author, main character energy fr fr 💜

Copyright (C) 2010 by Steffen Mueller

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.1 or, at your option, any later version of Perl 5 you may have available.

and that's the whole page, bestie 🥰 this was perl v5.42.0, dated 2025-07-25 — slay, stay benchmarking, mwah 💅✨

📦 where this page comes from