Benchmark::Featureset::SetOps - Compare various array/set handling modules
#!/usr/bin/env perl use Benchmark::Featureset::SetOps; Benchmark::Featureset::SetOps -> new -> run;
See scripts/setops.report.pl.
Hint: Redirect the output of that script to your $doc_root/setops.report.html.
A copy of the report ships in html/setops.report.html.
View this report on my website.
Benchmark::Featureset::SetOps compares various array/set handling modules.
The list of modules processed is shipped in data/module.list.ini, and can easily be edited before re-running:
shell> scripts/copy.config.pl shell> scripts/setops.report.pl
The config stuff is explained below.
This module is available as a Unix-style distro (*.tgz).
See http://savage.net.au/Perl-modules/html/installing-a-module.html for help on unpacking and installing distros.
Install Benchmark::Featureset::SetOps as you would for any Perl module:
Perl
Run:
cpanm Benchmark::Featureset::SetOps
or run:
sudo cpan Benchmark::Featureset::SetOps
or unpack the distro, and then either:
perl Build.PL ./Build ./Build test sudo ./Build install
or:
perl Makefile.PL make (or dmake or nmake) make test make install
All that remains is to tell Benchmark::Featureset::SetOps your values for some options.
For that, see config/.htbenchmark.featureset.setops.conf.
If you are using Build.PL, running Build (without parameters) will run scripts/copy.config.pl, as explained next.
If you are using Makefile.PL, running make (without parameters) will also run scripts/copy.config.pl.
Either way, before editing the config file, ensure you run scripts/copy.config.pl. It will copy the config file using File::HomeDir, to a directory where the run-time code in Benchmark::Featureset::SetOps will look for it.
shell>cd Benchmark-Featureset-SetOps-1.00 shell>perl scripts/copy.config.pl
Under Debian, this directory will be $HOME/.perl/Benchmark-Featureset-SetOps/. When you run copy.config.pl, it will report where it has copied the config file to.
Check the docs for File::HomeDir to see what your operating system returns for a call to my_dist_config().
The point of this is that after the module is installed, the config file will be easily accessible and editable without needing permission to write to the directory structure in which modules are stored.
That's why File::HomeDir and Path::Class are pre-requisites for this module.
Although this is a good mechanism for modules which ship with their own config files, be advised that some CPAN tester machines run tests as users who don't have home directories, resulting in test failures.
new() is called as my($builder) = Benchmark::Featureset::SetOps -> new(k1 => v1, k2 => v2, ...).
new()
my($builder) = Benchmark::Featureset::SetOps -> new(k1 => v1, k2 => v2, ...)
It returns a new object of type Benchmark::Featureset::SetOps.
Benchmark::Featureset::SetOps
Key-value pairs in accepted in the parameter list (see corresponding methods for details):
For use by subclasses.
Does the real work.
See scripts/setops.report.pl and its output html/setops.report.html.
Hint: Redirect the output of that script to $doc_root/setops.report.html.
Templates ship in htdocs/assets/templates/benchmark/featureset/setops/.
See also htdocs/assets/css/benchmark/featureset/setops/.
I maintain (but did not write) Set::Array. I have never really liked its interface, so when I started a home-grown script that Kim Ryan (author of Locale::SubCountry) and I use to compare his module with my WWW::Scraper::Wikipedia::ISO3166, I wondered if there was some module more to my liking. Hence the search for alternatives. Then I realized my work could benefit the Perl community if I formalized the results of this search.
Also, I have 7 modules on CPAN which use Set::Array, so I wanted a good idea of the array/set modules before I decided to switch.
https://github.com/ronsavage/Benchmark-Featureset-SetOps
The modules compared in this package often have links to various modules, which I won't repeat here...
The other module in this series is Benchmark::Featureset::LocaleCountry.
The file Changes was converted into Changelog.ini by Module::Metadata::Changes.
Version numbers < 1.00 represent development versions. From 1.00 up, they are production versions.
Email the author, or log a bug on RT:
https://rt.cpan.org/Public/Dist/Display.html?Name=Benchmark::Featureset::SetOps.
Benchmark::Featureset::SetOps was written by Ron Savage <ron@savage.net.au> in 2012.
Home page: http://savage.net.au/index.html.
Australian copyright (c) 2012, Ron Savage.
All Programs of mine are 'OSI Certified Open Source Software'; you can redistribute them and/or modify them under the terms of The Artistic License, a copy of which is available at: http://www.opensource.org/licenses/index.html
To install Benchmark::Featureset::SetOps, copy and paste the appropriate command in to your terminal.
cpanm
CPAN shell
perl -MCPAN -e shell install Benchmark::Featureset::SetOps
For more information on module installation, please visit the detailed CPAN module installation guide.