NAME
    Bencher::Scenario::MemoryInfo - Benchmark getting system memory
    information

VERSION
    This document describes version 0.001 of Bencher::Scenario::MemoryInfo
    (from Perl distribution Bencher-Scenario-MemoryInfo), released on
    2017-11-19.

SYNOPSIS
    To run benchmark with default option:

     % bencher -m MemoryInfo

    To run module startup overhead benchmark:

     % bencher --module-startup -m MemoryInfo

    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.

    Sys::MemInfo 0.99

    Linux::MemInfo 0.03

    Linux::Info::MemStats 1.3

BENCHMARK PARTICIPANTS
    *   Sys::MemInfo::freemem (perl_code)

        Function call template:

         Sys::MemInfo::freemem()

    *   Linux::MemInfo::get_mem_info (perl_code)

        Function call template:

         Linux::MemInfo::get_mem_info()

    *   Linux::Info::MemStats (perl_code)

        Code template:

         my $lxs = Linux::Info::MemStats->new; $lxs->get

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 18.2*, OS kernel: *Linux
    version 4.8.0-53-generic*.

    Benchmark with default options ("bencher -m MemoryInfo"):

     #table1#
     +------------------------------+-----------+-----------+------------+---------+---------+
     | participant                  | rate (/s) | time (μs) | vs_slowest |  errors | samples |
     +------------------------------+-----------+-----------+------------+---------+---------+
     | Linux::MemInfo::get_mem_info |     11000 |    90     |        1   | 1.1e-07 |      29 |
     | Linux::Info::MemStats        |     17000 |    58     |        1.5 | 1.2e-07 |      24 |
     | Sys::MemInfo::freemem        |   4426000 |     0.226 |      397.6 | 1.2e-11 |      22 |
     +------------------------------+-----------+-----------+------------+---------+---------+

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

     #table2#
     +-----------------------+------------------------------+--------------------+----------------+-----------+------------------------+------------+---------+---------+
     | participant           | proc_private_dirty_size (MB) | proc_rss_size (MB) | proc_size (MB) | time (ms) | mod_overhead_time (ms) | vs_slowest |  errors | samples |
     +-----------------------+------------------------------+--------------------+----------------+-----------+------------------------+------------+---------+---------+
     | Linux::Info::MemStats | 0.82                         | 4.2                | 16             |      11   |                    5.8 |        1   | 4.4e-05 |      20 |
     | Sys::MemInfo          | 1                            | 4.6                | 16             |      11   |                    5.8 |        1   | 5.7e-05 |      20 |
     | Linux::MemInfo        | 1.3                          | 4.8                | 16             |       9.4 |                    4.2 |        1.1 | 5.4e-05 |      20 |
     | perl -e1 (baseline)   | 1.2                          | 4.7                | 18             |       5.2 |                    0   |        2.1 |   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-MemoryInfo>.

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

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

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

