/ 
Bencher-Scenarios-TextANSIUtil-0.02
River stage one • 1 direct dependent • 1 total dependent
/ Bencher::Scenario::TextANSIUtil::Wrap

NAME

Bencher::Scenario::TextANSIUtil::Wrap - Benchmark text wrapping

VERSION

This document describes version 0.02 of Bencher::Scenario::TextANSIUtil::Wrap (from Perl distribution Bencher-Scenarios-TextANSIUtil), released on 2017-01-25.

SYNOPSIS

To run benchmark with default option:

% bencher -m TextANSIUtil::Wrap

To run module startup overhead benchmark:

% bencher --module-startup -m TextANSIUtil::Wrap

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.

Text::ANSI::Util 0.22

Text::ANSI::WideUtil 0.22

Text::Wrap 2013.0523

BENCHMARK PARTICIPANTS

  • Text::ANSI::Util::ta_wrap (perl_code)

    Function call template:

    Text::ANSI::Util::ta_wrap(<text>, <width>)

  • Text::ANSI::WideUtil::ta_mbwrap (perl_code)

    Function call template:

    Text::ANSI::WideUtil::ta_mbwrap(<text>, <width>)

  • Text::Wrap (perl_code)

    Code template:

    local $Text::Wrap::columns = <width>; Text::Wrap::wrap("", "", <text>)

BENCHMARK DATASETS

  • ascii-100c-nocolor [ascii]

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 TextANSIUtil::Wrap):

#table1#
+---------------------------------+-----------+-----------+------------+---------+---------+
| participant                     | rate (/s) | time (μs) | vs_slowest |  errors | samples |
+---------------------------------+-----------+-----------+------------+---------+---------+
| Text::ANSI::WideUtil::ta_mbwrap |      3500 |       290 |        1   | 2.7e-06 |      21 |
| Text::ANSI::Util::ta_wrap       |      5400 |       180 |        1.6 | 1.8e-06 |      20 |
| Text::Wrap                      |     23000 |        43 |        6.7 | 3.3e-07 |      20 |
+---------------------------------+-----------+-----------+------------+---------+---------+

Benchmark module startup overhead (bencher -m TextANSIUtil::Wrap --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 |
+----------------------+------------------------------+--------------------+----------------+-----------+------------------------+------------+-----------+---------+
| Text::ANSI::WideUtil | 1.3                          | 4.9                | 19             |      38   |                   33.6 |        1   |   0.00012 |      20 |
| Text::Wrap           | 0.83                         | 4.2                | 16             |      11   |                    6.6 |        3.5 | 7.1e-05   |      20 |
| Text::ANSI::Util     | 5.4                          | 9.2                | 29             |      11   |                    6.6 |        3.6 | 2.6e-05   |      20 |
| perl -e1 (baseline)  | 1.4                          | 4.9                | 19             |       4.4 |                    0   |        8.7 | 1.4e-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-Scenarios-TextANSIUtil.

SOURCE

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

BUGS

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

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.