NAME

Bencher::Scenario::StringModules::Startup - Benchmark startup of string modules

VERSION

This document describes version 0.006 of Bencher::Scenario::StringModules::Startup (from Perl distribution Bencher-Scenarios-StringFunctions), released on 2022-03-27.

SYNOPSIS

To run benchmark with default option:

 % bencher -m StringModules::Startup

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.

String::CommonPrefix 0.01

String::CommonSuffix 0.01

String::Trim::More 0.03

String::Util 1.32

Text::Minify::XS v0.6.1

BENCHMARK PARTICIPANTS

• String::CommonPrefix (perl_code)

  String::CommonPrefix

• String::CommonSuffix (perl_code)

  String::CommonSuffix

• String::Trim::More (perl_code)

  String::Trim::More

• String::Util (perl_code)

  String::Util

• Text::Minify::XS (perl_code)

  Text::Minify::XS

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 StringModules::Startup):

 #table1#
 {dataset=>undef}
 +----------------------+-----------+-------------------+-----------------------+-----------------------+---------+---------+
 | participant          | time (ms) | mod_overhead_time | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors | samples |
 +----------------------+-----------+-------------------+-----------------------+-----------------------+---------+---------+
 | String::Util         |     14.3  |              8.1  |                 0.00% |               131.58% |   1e-05 |      20 |
 | Text::Minify::XS     |      9.35 |              3.15 |                52.82% |                51.54% | 4.5e-06 |      20 |
 | String::Trim::More   |      9.08 |              2.88 |                57.37% |                47.16% | 8.7e-06 |      20 |
 | String::CommonSuffix |      8.95 |              2.75 |                59.67% |                45.04% | 8.1e-06 |      20 |
 | String::CommonPrefix |      8.9  |              2.7  |                59.85% |                44.88% | 9.8e-06 |      20 |
 | perl -e1 (baseline)  |      6.2  |              0    |               131.58% |                 0.00% | 6.7e-06 |      20 |
 +----------------------+-----------+-------------------+-----------------------+-----------------------+---------+---------+

Formatted as Benchmark.pm result:

                           Rate  String::Util  Text::Minify::XS  String::Trim::More  String::CommonSuffix  String::CommonPrefix  perl -e1 (baseline) 
  String::Util           69.9/s            --              -34%                -36%                  -37%                  -37%                 -56% 
  Text::Minify::XS      107.0/s           52%                --                 -2%                   -4%                   -4%                 -33% 
  String::Trim::More    110.1/s           57%                2%                  --                   -1%                   -1%                 -31% 
  String::CommonSuffix  111.7/s           59%                4%                  1%                    --                    0%                 -30% 
  String::CommonPrefix  112.4/s           60%                5%                  2%                    0%                    --                 -30% 
  perl -e1 (baseline)   161.3/s          130%               50%                 46%                   44%                   43%                   -- 
 
 Legends:
   String::CommonPrefix: mod_overhead_time=2.7 participant=String::CommonPrefix
   String::CommonSuffix: mod_overhead_time=2.75 participant=String::CommonSuffix
   String::Trim::More: mod_overhead_time=2.88 participant=String::Trim::More
   String::Util: mod_overhead_time=8.1 participant=String::Util
   Text::Minify::XS: mod_overhead_time=3.15 participant=Text::Minify::XS
   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-StringFunctions.

SOURCE

Source repository is at https://github.com/perlancar/perl-Bencher-Scenarios-StringFunctions.

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, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2022, 2021, 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-StringFunctions

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.

cpanm Bencher::Scenarios::StringFunctions

perl -MCPAN -e shell
install Bencher::Scenarios::StringFunctions