The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Bencher::Scenario::ManipulatingSymbolTable::ListingSymbols - Benchmark listing symbols of a package

VERSION

This document describes version 0.001 of Bencher::Scenario::ManipulatingSymbolTable::ListingSymbols (from Perl distribution Bencher-Scenarios-ManipulatingSymbolTable), released on 2019-01-06.

SYNOPSIS

To run benchmark with default option:

 % bencher -m ManipulatingSymbolTable::ListingSymbols

To run module startup overhead benchmark:

 % bencher --module-startup -m ManipulatingSymbolTable::ListingSymbols

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.

Package::Stash::XS 0.28

Package::Stash::PP 0.37

Package::MoreUtil 0.591

BENCHMARK PARTICIPANTS

  • PS:XS::list_all_symbols (perl_code)

    Code template:

     Package::Stash::XS->new("strict")->list_all_symbols
  • PS:PP::list_all_symbols (perl_code)

    Code template:

     Package::Stash::PP->new("strict")->list_all_symbols
  • PS:XS::get_all_symbols (perl_code)

    Code template:

     Package::Stash::XS->new("strict")->get_all_symbols
  • PS:PP::get_all_symbols (perl_code)

    Code template:

     Package::Stash::PP->new("strict")->get_all_symbols
  • Package::MoreUtil::list_package_contents (perl_code)

    Function call template:

     Package::MoreUtil::list_package_contents("strict")

SAMPLE BENCHMARK RESULTS

Run on: perl: v5.26.1, CPU: Intel(R) Core(TM) M-5Y71 CPU @ 1.20GHz (2 cores), OS: GNU/Linux LinuxMint version 18.3, OS kernel: Linux version 4.10.0-38-generic.

Benchmark with default options (bencher -m ManipulatingSymbolTable::ListingSymbols):

 #table1#
 +------------------------------------------+-----------+-----------+------------+---------+---------+
 | participant                              | rate (/s) | time (μs) | vs_slowest |  errors | samples |
 +------------------------------------------+-----------+-----------+------------+---------+---------+
 | Package::MoreUtil::list_package_contents |     44600 |     22.4  |        1   | 5.4e-09 |      31 |
 | PS:PP::get_all_symbols                   |    170000 |      5.9  |        3.8 | 1.1e-08 |      27 |
 | PS:PP::list_all_symbols                  |    330000 |      3    |        7.5 | 6.5e-09 |      21 |
 | PS:XS::get_all_symbols                   |    420000 |      2.4  |        9.4 | 3.3e-09 |      20 |
 | PS:XS::list_all_symbols                  |    506000 |      1.97 |       11.3 | 7.5e-10 |      25 |
 +------------------------------------------+-----------+-----------+------------+---------+---------+

Benchmark module startup overhead (bencher -m ManipulatingSymbolTable::ListingSymbols --module-startup):

 #table2#
 +---------------------+-----------+------------------------+------------+---------+---------+
 | participant         | time (ms) | mod_overhead_time (ms) | vs_slowest |  errors | samples |
 +---------------------+-----------+------------------------+------------+---------+---------+
 | Package::Stash::PP  |      15   |                   10.1 |        1   | 4.2e-05 |      20 |
 | Package::MoreUtil   |       7.6 |                    2.7 |        1.9 | 1.6e-05 |      20 |
 | Package::Stash::XS  |       7.6 |                    2.7 |        1.9 | 2.7e-05 |      20 |
 | perl -e1 (baseline) |       4.9 |                    0   |        3   | 2.8e-05 |      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-ManipulatingSymbolTable.

SOURCE

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

BUGS

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

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) 2019 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.