NAME

Bencher::Scenario::ColorANSIUtil::ansifg - Benchmark ansifg()

VERSION

This document describes version 0.002 of Bencher::Scenario::ColorANSIUtil::ansifg (from Perl distribution Bencher-Scenarios-ColorANSIUtil), released on 2017-01-25.

SYNOPSIS

To run benchmark with default option:

 % bencher -m ColorANSIUtil::ansifg

To run module startup overhead benchmark:

 % bencher --module-startup -m ColorANSIUtil::ansifg

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.

Color::ANSI::Util 0.15

BENCHMARK PARTICIPANTS

• Color::ANSI::Util::ansi16fg (perl_code)

  Function call template:

   Color::ANSI::Util::ansi16fg(<rgb>)

• Color::ANSI::Util::ansi256fg (perl_code)

  Function call template:

   Color::ANSI::Util::ansi256fg(<rgb>)

• Color::ANSI::Util::ansi24bfg (perl_code)

  Function call template:

   Color::ANSI::Util::ansi24bfg(<rgb>)

BENCHMARK DATASETS

• 000000

• eeeeef

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 ColorANSIUtil::ansifg):

 #table1#
 +------------------------------+---------+-----------+-----------+------------+---------+---------+
 | participant                  | dataset | rate (/s) | time (μs) | vs_slowest |  errors | samples |
 +------------------------------+---------+-----------+-----------+------------+---------+---------+
 | Color::ANSI::Util::ansi16fg  | eeeeef  |    129000 |    7.76   |    1       |   3e-09 |      24 |
 | Color::ANSI::Util::ansi256fg | eeeeef  |    131000 |    7.61   |    1.02    | 2.9e-09 |      27 |
 | Color::ANSI::Util::ansi16fg  | 000000  |    540000 |    1.9    |    4.2     | 3.1e-09 |      23 |
 | Color::ANSI::Util::ansi256fg | 000000  |    560000 |    1.8    |    4.4     | 3.3e-09 |      20 |
 | Color::ANSI::Util::ansi24bfg | eeeeef  |   1208610 |    0.8274 |    9.37589 |   0     |      20 |
 | Color::ANSI::Util::ansi24bfg | 000000  |   1300000 |    0.78   |    9.9     | 1.7e-09 |      20 |
 +------------------------------+---------+-----------+-----------+------------+---------+---------+

Benchmark module startup overhead (bencher -m ColorANSIUtil::ansifg --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 |
 +---------------------+------------------------------+--------------------+----------------+-----------+------------------------+------------+---------+---------+
 | Color::ANSI::Util   | 1.2                          | 4.6                | 16             |       8.7 |                    4.6 |        1   | 3.5e-05 |      20 |
 | perl -e1 (baseline) | 1.2                          | 4.7                | 16             |       4.1 |                    0   |        2.1 | 7.2e-06 |      21 |
 +---------------------+------------------------------+--------------------+----------------+-----------+------------------------+------------+---------+---------+

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

BENCHMARK NOTES

We can see the overhead of _rgb_to_indexed() in the ansi16fg() and ansi256fg() functions. For colors that immediately result in an exact match like 000000, the overhead is smaller. For colors that need calculation of minimum square distance like eeeeef, the overhead is larger.

Although in general we do not need to worry about this overhead unless we're calculating colors at rates of hundreds of thousands per seconds.

HOMEPAGE

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

SOURCE

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

BUGS

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

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.

SEE ALSO

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.

cpanm Bencher::Scenarios::ColorANSIUtil

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