NAME

Bencher::Scenario::StringFunctions::Indent - Benchmark string indenting (adding whitespace to lines of text)

VERSION

This document describes version 0.004 of Bencher::Scenario::StringFunctions::Indent (from Perl distribution Bencher-Scenarios-StringFunctions), released on 2021-07-30.

SYNOPSIS

To run benchmark with default option:

% bencher -m StringFunctions::Indent

To run module startup overhead benchmark:

% bencher --module-startup -m StringFunctions::Indent

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.

String::Nudge 1.0002

String::Indent 0.03

String::Indent::Join

BENCHMARK PARTICIPANTS

String::Nudge::nudge (perl_code)

Function call template:
```
String::Nudge::nudge(<num_spaces>, <str>)
```
String::Indent::indent (perl_code)

Function call template:
```
String::Indent::indent(<indent>, <str>)
```
String::Indent::Join::indent (perl_code)

Function call template:
```
String::Indent::Join::indent(<indent>, <str>)
```

BENCHMARK DATASETS

empty
1line
10line
100line
1000line

SAMPLE BENCHMARK RESULTS

Run on: perl: v5.34.0, CPU: Intel(R) Core(TM) i7-4770 CPU @ 3.40GHz (4 cores), OS: GNU/Linux LinuxMint version 19, OS kernel: Linux version 5.3.0-68-generic.

Benchmark with default options (bencher -m StringFunctions::Indent):

#table1#
{dataset=>"1000line"}
+------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+
| participant                  | rate (/s) | time (μs) | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors | samples |
+------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+
| String::Indent::indent       |      3000 |       333 |                 0.00% |                61.66% | 4.8e-08 |      25 |
| String::Nudge::nudge         |      4000 |       250 |                33.38% |                21.20% | 5.3e-08 |      20 |
| String::Indent::Join::indent |      4850 |       206 |                61.66% |                 0.00% | 1.6e-07 |      35 |
+------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+

Formatted as Benchmark.pm result:

          Rate  SI:i  SN:n  SIJ:i 
 SI:i   3000/s    --  -24%   -38% 
 SN:n   4000/s   33%    --   -17% 
 SIJ:i  4850/s   61%   21%     -- 

Legends:
  SI:i: participant=String::Indent::indent
  SIJ:i: participant=String::Indent::Join::indent
  SN:n: participant=String::Nudge::nudge

#table2#
{dataset=>"100line"}
+------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+
| participant                  | rate (/s) | time (μs) | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors | samples |
+------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+
| String::Indent::indent       |   28385.9 |   35.2288 |                 0.00% |                88.36% |   0     |      21 |
| String::Nudge::nudge         |   36903.3 |   27.0978 |                30.01% |                44.89% | 5.8e-12 |      26 |
| String::Indent::Join::indent |   53468   |   18.703  |                88.36% |                 0.00% | 2.3e-11 |      20 |
+------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+

Formatted as Benchmark.pm result:

             Rate  SI:i  SN:n  SIJ:i 
 SI:i   28385.9/s    --  -23%   -46% 
 SN:n   36903.3/s   30%    --   -30% 
 SIJ:i    53468/s   88%   44%     -- 

Legends:
  SI:i: participant=String::Indent::indent
  SIJ:i: participant=String::Indent::Join::indent
  SN:n: participant=String::Nudge::nudge

#table3#
{dataset=>"10line"}
+------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+
| participant                  | rate (/s) | time (μs) | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors | samples |
+------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+
| String::Indent::indent       |    219830 |   4.5489  |                 0.00% |               109.38% | 5.4e-12 |      20 |
| String::Nudge::nudge         |    280000 |   3.6     |                26.62% |                65.36% | 6.7e-09 |      20 |
| String::Indent::Join::indent |    460297 |   2.17251 |               109.38% |                 0.00% |   0     |      20 |
+------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+

Formatted as Benchmark.pm result:

            Rate  SI:i  SN:n  SIJ:i 
 SI:i   219830/s    --  -20%   -52% 
 SN:n   280000/s   26%    --   -39% 
 SIJ:i  460297/s  109%   65%     -- 

Legends:
  SI:i: participant=String::Indent::indent
  SIJ:i: participant=String::Indent::Join::indent
  SN:n: participant=String::Nudge::nudge

#table4#
{dataset=>"1line"}
+------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+
| participant                  | rate (/s) | time (ns) | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors | samples |
+------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+
| String::Indent::indent       |    856314 |  1167.8   |                 0.00% |               171.82% |   0     |      20 |
| String::Nudge::nudge         |   1020000 |   980.4   |                19.11% |               128.20% | 5.6e-12 |      20 |
| String::Indent::Join::indent |   2327620 |   429.624 |               171.82% |                 0.00% |   0     |      29 |
+------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+

Formatted as Benchmark.pm result:

             Rate  SI:i  SN:n  SIJ:i 
 SI:i    856314/s    --  -16%   -63% 
 SN:n   1020000/s   19%    --   -56% 
 SIJ:i  2327620/s  171%  128%     -- 

Legends:
  SI:i: participant=String::Indent::indent
  SIJ:i: participant=String::Indent::Join::indent
  SN:n: participant=String::Nudge::nudge

#table5#
{dataset=>"empty"}
+------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+
| participant                  | rate (/s) | time (ns) | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors | samples |
+------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+
| String::Indent::indent       |    903880 |    1106.3 |                 0.00% |               565.74% | 5.8e-12 |      20 |
| String::Nudge::nudge         |   1226000 |     815.6 |                35.64% |               390.80% |   2e-11 |      20 |
| String::Indent::Join::indent |   6017000 |     166.2 |               565.74% |                 0.00% | 5.8e-12 |      20 |
+------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+

Formatted as Benchmark.pm result:

             Rate  SI:i  SN:n  SIJ:i 
 SI:i    903880/s    --  -26%   -84% 
 SN:n   1226000/s   35%    --   -79% 
 SIJ:i  6017000/s  565%  390%     -- 

Legends:
  SI:i: participant=String::Indent::indent
  SIJ:i: participant=String::Indent::Join::indent
  SN:n: participant=String::Nudge::nudge

Benchmark module startup overhead (bencher -m StringFunctions::Indent --module-startup):

#table6#
+----------------------+-----------+-------------------+-----------------------+-----------------------+---------+---------+
| participant          | time (ms) | mod_overhead_time | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors | samples |
+----------------------+-----------+-------------------+-----------------------+-----------------------+---------+---------+
| String::Indent::Join |       7   |               3   |                 0.00% |                81.24% | 0.00012 |      20 |
| String::Nudge        |       7.3 |               3.3 |                 0.94% |                79.55% | 7e-05   |      20 |
| String::Indent       |       7   |               3   |                 4.08% |                74.14% | 0.00013 |      20 |
| perl -e1 (baseline)  |       4   |               0   |                81.24% |                 0.00% | 0.00019 |      20 |
+----------------------+-----------+-------------------+-----------------------+-----------------------+---------+---------+

Formatted as Benchmark.pm result:

               Rate  S:N  SI:J  S:I  :perl -e1 ( 
 S:N          0.1/s   --   -4%  -4%         -45% 
 SI:J         0.1/s   4%    --   0%         -42% 
 S:I          0.1/s   4%    0%   --         -42% 
 :perl -e1 (  0.2/s  82%   75%  75%           -- 

Legends:
  :perl -e1 (: mod_overhead_time=0 participant=perl -e1 (baseline)
  S:I: mod_overhead_time=3 participant=String::Indent
  S:N: mod_overhead_time=3.3 participant=String::Nudge
  SI:J: mod_overhead_time=3 participant=String::Indent::Join

To display as an interactive HTML table on a browser, you can add option --format html+datatables.

BENCHMARK NOTES

Joining is faster than regex substitution for the datasets tested (0-1000 lines of short text).

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Bencher-Scenarios-StringFunctions.

SOURCE

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

BUGS

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

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 is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

To install Bencher::Scenarios::StringFunctions, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Bencher::Scenarios::StringFunctions

CPAN shell

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

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

BENCHMARKED MODULES

BENCHMARK PARTICIPANTS

BENCHMARK DATASETS

SAMPLE BENCHMARK RESULTS

BENCHMARK NOTES

HOMEPAGE

SOURCE

BUGS

AUTHOR

COPYRIGHT AND LICENSE

Module Install Instructions