NAME
    Bencher::Scenario::FileWhichCached - Benchmark File::Which::Cached

VERSION
    This document describes version 0.001 of
    Bencher::Scenario::FileWhichCached (from Perl distribution
    Bencher-Scenario-FileWhichCached), released on 2019-06-08.

SYNOPSIS
    To run benchmark with default option:

     % bencher -m FileWhichCached

    To run module startup overhead benchmark:

     % bencher --module-startup -m FileWhichCached

    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.

    File::Which 1.22

    File::Which::Cached 1.03

BENCHMARK PARTICIPANTS
    *   File::Which::which (perl_code)

        Function call template:

         File::Which::which("ls")

    *   File::Which::Cached::which (perl_code)

        Function call template:

         File::Which::Cached::which("ls")

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 FileWhichCached"):

     #table1#
     +----------------------------+-----------+-----------+------------+---------+---------+
     | participant                | rate (/s) | time (μs) | vs_slowest |  errors | samples |
     +----------------------------+-----------+-----------+------------+---------+---------+
     | File::Which::which         |     23000 |     44    |          1 | 4.4e-08 |      29 |
     | File::Which::Cached::which |   8310000 |      0.12 |        364 | 6.2e-11 |      20 |
     +----------------------------+-----------+-----------+------------+---------+---------+

    Benchmark module startup overhead ("bencher -m FileWhichCached
    --module-startup"):

     #table2#
     +---------------------+-----------+------------------------+------------+---------+---------+
     | participant         | time (ms) | mod_overhead_time (ms) | vs_slowest |  errors | samples |
     +---------------------+-----------+------------------------+------------+---------+---------+
     | File::Which::Cached |       9.9 |                    5.9 |        1   | 2.5e-05 |      20 |
     | File::Which         |       9.7 |                    5.7 |        1   | 2.2e-05 |      20 |
     | perl -e1 (baseline) |       4   |                    0   |        2.5 | 2.1e-05 |      20 |
     +---------------------+-----------+------------------------+------------+---------+---------+

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

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

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

    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.

