NAME
    Bencher::Scenario::AcmePERLANCARTestPerformance - Benchmark
    Acme::PERLANCAR::Test::Performance

VERSION
    This document describes version 0.060 of
    Bencher::Scenario::AcmePERLANCARTestPerformance (from Perl distribution
    Bencher-Scenario-AcmePERLANCARTestPerformance), released on 2021-07-31.

SYNOPSIS
    To run benchmark with default option:

     % bencher -m AcmePERLANCARTestPerformance

    To run module startup overhead benchmark:

     % bencher --module-startup -m AcmePERLANCARTestPerformance

    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.

    Acme::PERLANCAR::Test::Performance 0.06

BENCHMARK PARTICIPANTS
    *   Acme::PERLANCAR::Test::Performance::primes (perl_code)

        Function call template:

         Acme::PERLANCAR::Test::Performance::primes(<num>)

BENCHMARK DATASETS
    *   100

BENCHMARK SAMPLE RESULTS
  Sample benchmark #1
    Run on: perl: *v5.34.0*, CPU: *Intel(R) Core(TM) i7-4770 CPU @ 3.40GHz
    (4 cores)*, OS: *GNU/Linux LinuxMint version 19*, OS kernel: *Linux
    version 5.3.0-68-generic*.

    Benchmark command:

     % bencher -m AcmePERLANCARTestPerformance --include-path /home/s1/repos/perl-Acme-PERLANCAR-Test-Performance/archive/0.01 --include-path /home/s1/repos/perl-Acme-PERLANCAR-Test-Performance/archive/0.02 --include-path /home/s1/repos/perl-Acme-PERLANCAR-Test-Performance/archive/0.03 --include-path /home/s1/repos/perl-Acme-PERLANCAR-Test-Performance/archive/0.04 --include-path /home/s1/repos/perl-Acme-PERLANCAR-Test-Performance/archive/0.05 --include-path /home/s1/repos/perl-Acme-PERLANCAR-Test-Performance/archive/0.06 --multimodver Acme::PERLANCAR::Test::Performance

    Result formatted as table:

     #table1#
     | participant                                | dataset | perl | modver | rate (/s) | time (μs) | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors | samples | ds_tags | p_tags |
     |--------------------------------------------+---------+------+--------+-----------+-----------+-----------------------+-----------------------+---------+---------+---------+--------|
     | Acme::PERLANCAR::Test::Performance::primes | 100     | perl | 0.06   |    108000 |      9.24 |                 0.00% |                 0.00% | 3.3e-09 |      20 |         |        |

    The above result formatted in Benchmark.pm style:

             Rate     
         108000/s  -- 
 
     Legends:
       : dataset=100 ds_tags= modver=0.06 p_tags= participant=Acme::PERLANCAR::Test::Performance::primes perl=perl

    The above result presented as chart:

  Sample benchmark #2
    Benchmark command:

     % bencher -m AcmePERLANCARTestPerformance --include-path /home/s1/repos/perl-Acme-PERLANCAR-Test-Performance/archive/0.01 --include-path /home/s1/repos/perl-Acme-PERLANCAR-Test-Performance/archive/0.02 --include-path /home/s1/repos/perl-Acme-PERLANCAR-Test-Performance/archive/0.03 --include-path /home/s1/repos/perl-Acme-PERLANCAR-Test-Performance/archive/0.04 --include-path /home/s1/repos/perl-Acme-PERLANCAR-Test-Performance/archive/0.05 --include-path /home/s1/repos/perl-Acme-PERLANCAR-Test-Performance/archive/0.06 --module-startup --multimodver Acme::PERLANCAR::Test::Performance

    Result formatted as table:

     #table2#
     | participant                        | time (ms) | mod_overhead_time | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors  | samples |
     |------------------------------------+-----------+-------------------+-----------------------+-----------------------+----------+---------|
     | Acme::PERLANCAR::Test::Performance |       5.5 |               3.5 |                 0.00% |               166.32% | 4.8e-05  |      20 |
     | perl -e1 (baseline)                |       2   |               0   |               166.32% |                 0.00% |   0.0001 |      33 |

    The above result formatted in Benchmark.pm style:

                              Rate  APT:P  perl -e1 (baseline) 
      APT:P                181.8/s     --                 -63% 
      perl -e1 (baseline)  500.0/s   175%                   -- 
 
     Legends:
       APT:P: mod_overhead_time=3.5 participant=Acme::PERLANCAR::Test::Performance
       perl -e1 (baseline): mod_overhead_time=0 participant=perl -e1 (baseline)

    The above result presented as chart:

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

CONTRIBUTOR
    perlancar (on netbook-zenbook-ux305) <perlancar@gmail.com>

HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/Bencher-Scenario-AcmePERLANCARTestPerforma
    nce>.

SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-Bencher-Scenario-AcmePERLANCARTestPer
    formance>.

BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=Bencher-Scenario-Acme
    PERLANCARTestPerformance>

    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.

AUTHOR
    perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE
    This software is copyright (c) 2021, 2017, 2016 by 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.