NAME

Bencher::Scenario::ArgPassing::Mixed - Benchmark argument passing (mixed positional and named)

VERSION

This document describes version 0.003 of Bencher::Scenario::ArgPassing::Mixed (from Perl distribution Bencher-Scenarios-ArgPassing), released on 2017-01-25.

SYNOPSIS

To run benchmark with default option:

 % bencher -m ArgPassing::Mixed

To run module startup overhead benchmark:

 % bencher --module-startup -m ArgPassing::Mixed

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

DESCRIPTION

This scenario compares three style of passing mixed positional and named arguments:

 # hashref at the front
 func({named1=>1, named2=>2}, 'pos0', 'pos1', 'pos2');
 
 # optional hashref at the front. like the above but when there are no named
 # arguments, the hashref can be omitted
 func({named1=>1, named2=>2}, 'pos0', 'pos1', 'pos2');
 
 # positional then named as hash
 func('pos1', 'pos2', 'pos3', named1=>1, named2=>2);

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.

Bencher::Scenario::ArgPassing::Mixed

BENCHMARK PARTICIPANTS

• hashref_at_the_front (perl_code)

  Function call template:

   Bencher::Scenario::ArgPassing::Mixed::hashref_at_the_front(<named>, <pos1>, <pos2>, <pos3>)

• opt_hashref_at_the_front (perl_code)

  Function call template:

   Bencher::Scenario::ArgPassing::Mixed::opt_hashref_at_the_front(<named>, <pos1>, <pos2>, <pos3>)

• list_then_hash (perl_code)

  Function call template:

   Bencher::Scenario::ArgPassing::Mixed::list_then_hash(<pos1>, <pos2>, <pos3>, %{<named>})

BENCHMARK DATASETS

• pos=3 named=1

• pos=3 named=5

SAMPLE BENCHMARK RESULTS

Run on: perl: v5.24.0, CPU: Intel(R) Core(TM) M-5Y71 CPU @ 1.20GHz (2 cores), OS: GNU/Linux LinuxMint version 17.3, OS kernel: Linux version 3.19.0-32-generic.

Benchmark with default options (bencher -m ArgPassing::Mixed):

 #table1#
 +--------------------------+---------------+-----------+-----------+------------+---------+---------+
 | participant              | dataset       | rate (/s) | time (μs) | vs_slowest |  errors | samples |
 +--------------------------+---------------+-----------+-----------+------------+---------+---------+
 | list_then_hash           | pos=3 named=5 |    650000 |   1.5     |    1       | 2.9e-09 |      27 |
 | list_then_hash           | pos=3 named=1 |   1350000 |   0.742   |    2.08    | 3.2e-10 |      34 |
 | opt_hashref_at_the_front | pos=3 named=5 |   1376000 |   0.727   |    2.125   | 3.1e-11 |      20 |
 | hashref_at_the_front     | pos=3 named=5 |   1465000 |   0.6824  |    2.264   |   1e-11 |      20 |
 | opt_hashref_at_the_front | pos=3 named=1 |   2272470 |   0.44005 |    3.51039 |   0     |      20 |
 | hashref_at_the_front     | pos=3 named=1 |   2567000 |   0.3895  |    3.966   | 1.1e-11 |      21 |
 +--------------------------+---------------+-----------+-----------+------------+---------+---------+

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-ArgPassing.

SOURCE

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

BUGS

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

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.

SEE ALSO

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 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.

cpanm Bencher::Scenarios::ArgPassing

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