NAME

Bencher::Scenario::Regexp::Pattern::Git - Benchmark patterns in Regexp::Pattern::Git

VERSION

This document describes version 0.003 of Bencher::Scenario::Regexp::Pattern::Git (from Perl distribution Bencher-Scenario-Regexp-Pattern-Git), released on 2023-01-17.

SYNOPSIS

To run benchmark with default option:

% bencher -m Regexp::Pattern::Git

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.

Regexp::Pattern 0.2.14

Regexp::Pattern::Git 0.002

BENCHMARK PARTICIPANTS

  • ref (perl_code)

    Code template:

    use Regexp::Pattern; state $re = re("Git::ref"); <data> =~ $re

BENCHMARK DATASETS

  • .one

  • one/two

  • one/two/three/four/five/six

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 Regexp::Pattern::Git):

#table1#
+-----------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+
| dataset                     | rate (/s) | time (μs) | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors | samples |
+-----------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+
| one/two/three/four/five/six |    536000 |    1.87   |                 0.00% |               593.02% | 7.3e-10 |      26 |
| one/two                     |    859380 |    1.1636 |                60.40% |               332.05% | 5.8e-12 |      20 |
| .one                        |   3713000 |    0.2693 |               593.02% |                 0.00% | 5.8e-12 |      20 |
+-----------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+

Formatted as Benchmark.pm result:

                                   Rate  one/two/three/four/five/six  one/two  .one 
 one/two/three/four/five/six   536000/s                           --     -37%  -85% 
 one/two                       859380/s                          60%       --  -76% 
 .one                         3713000/s                         594%     332%    -- 

Legends:
  .one: dataset=.one
  one/two: dataset=one/two
  one/two/three/four/five/six: dataset=one/two/three/four/five/six

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-Scenario-Regexp-Pattern-Git.

SOURCE

Source repository is at https://github.com/perlancar/perl-Bencher-Scenario-RegexpPatternGit.

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, 2019 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-Scenario-Regexp-Pattern-Git

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.