NAME

Bencher::Scenario::DateTime::Format::Duration::ISO8601::Formatting - Benchmark formatting with DateTime::Format::Duration::ISO8601

VERSION

This document describes version 0.002 of Bencher::Scenario::DateTime::Format::Duration::ISO8601::Formatting (from Perl distribution Bencher-Scenarios-DateTime-Format-Duration-ISO8601), released on 2023-01-19.

SYNOPSIS

To run benchmark with default option:

% bencher -m DateTime::Format::Duration::ISO8601::Formatting

To run module startup overhead benchmark:

% bencher --module-startup -m DateTime::Format::Duration::ISO8601::Formatting

For more options (dump scenario, list/include/exclude/add participants, list/include/exclude/add datasets, etc), see bencher or run bencher --help.

DESCRIPTION

Packaging a benchmark script as a Bencher scenario makes it convenient to include/exclude/add participants/datasets (either via CLI or Perl code), send the result to a central repository, among others . See Bencher and bencher (CLI) for more details.

BENCHMARKED MODULES

Version numbers shown below are the versions used when running the sample benchmark.

DateTime::Format::Duration::ISO8601 0.008

BENCHMARK PARTICIPANTS

  • format_duration (perl_code)

    Function call template:

    DateTime::Format::Duration::ISO8601->new->format_duration(<dur>)

BENCHMARK DATASETS

  • [bless({days=>3,end_of_month=>"wrap",minutes=>245,months=>14,nanoseconds=>700000000,seconds=>6},"DateTime::Duration")]

SAMPLE BENCHMARK RESULTS

Run on: perl: v5.34.0, CPU: Intel(R) Core(TM) i5-7200U CPU @ 2.50GHz (2 cores), OS: GNU/Linux Ubuntu version 20.04, OS kernel: Linux version 5.4.0-91-generic.

Benchmark with default options (bencher -m DateTime::Format::Duration::ISO8601::Formatting):

#table1#
+-----------------+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+---------+--------+------+-----------+-----------+-----------------------+-----------------------+--------+---------+
| participant     | dataset                                                                                                                | arg_dur                                 | ds_tags | p_tags | perl | rate (/s) | time (μs) | pct_faster_vs_slowest | pct_slower_vs_fastest | errors | samples |
+-----------------+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+---------+--------+------+-----------+-----------+-----------------------+-----------------------+--------+---------+
| format_duration | [bless({days=>3,end_of_month=>"wrap",minutes=>245,months=>14,nanoseconds=>700000000,seconds=>6},"DateTime::Duration")] | DateTime::Duration=HASH(0x558b4ff169c8) |         |        | perl |     53000 |      18.9 |                 0.00% |                 0.00% |  6e-09 |      25 |
+-----------------+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------+---------+--------+------+-----------+-----------+-----------------------+-----------------------+--------+---------+

Formatted as Benchmark.pm result:

      Rate     
   53000/s  -- 

Legends:
  : arg_dur=DateTime::Duration=HASH(0x558b4ff169c8) dataset=[bless({days=>3,end_of_month=>"wrap",minutes=>245,months=>14,nanoseconds=>700000000,seconds=>6},"DateTime::Duration")] ds_tags= p_tags= participant=format_duration perl=perl

Benchmark module startup overhead (bencher -m DateTime::Format::Duration::ISO8601::Formatting --module-startup):

#table2#
+-------------------------------------+-----------+-------------------+-----------------------+-----------------------+---------+---------+
| participant                         | time (ms) | mod_overhead_time | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors | samples |
+-------------------------------------+-----------+-------------------+-----------------------+-----------------------+---------+---------+
| DateTime::Format::Duration::ISO8601 |       8.9 |               2.6 |                 0.00% |                41.39% |   3e-05 |      20 |
| perl -e1 (baseline)                 |       6.3 |               0   |                41.39% |                 0.00% | 2.3e-05 |      20 |
+-------------------------------------+-----------+-------------------+-----------------------+-----------------------+---------+---------+

Formatted as Benchmark.pm result:

                         Rate  DFD:I  perl -e1 (baseline) 
 DFD:I                112.4/s     --                 -29% 
 perl -e1 (baseline)  158.7/s    41%                   -- 

Legends:
  DFD:I: mod_overhead_time=2.6 participant=DateTime::Format::Duration::ISO8601
  perl -e1 (baseline): mod_overhead_time=0 participant=perl -e1 (baseline)

To display as an interactive HTML table on a browser, you can add option --format html+datatables.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Bencher-Scenarios-DateTime-Format-Duration-ISO8601.

SOURCE

Source repository is at https://github.com/perlancar/perl-Bencher-Scenarios-DateTime-Format-Duration-ISO8601.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

% prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023, 2018 by perlancar <perlancar@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Bencher-Scenarios-DateTime-Format-Duration-ISO8601

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.