Array::Sample::Partition - Sample elements from an array by equal partitions
This document describes version 0.003 of Array::Sample::Partition (from Perl distribution Array-Sample-Partition), released on 2022-05-20.
use Array::Sample::Partition qw(sample_partition);
sample_partition([0,1,2,3,4], 1); => (2)
sample_partition([0,1,2,3,4], 2); => (1,3)
sample_partition([0,1,2,3,4], 3); => (1,2,3)
sample_partition([0,1,2,3,4,5], 1); => (3)
sample_partition([0,1,2,3,4,5], 2); => (2,4)
sample_partition([0,1,2,3,4,5], 3); => (1,3,4)
sample_partition([0,1,2,3,4,5], 4); => (1,2,3,4)
All functions are not exported by default, but exportable.
Syntax: sample_partition(\@ary, $n [ , \%opts ]) => list
pos => bool
If set to true, will return positions instead of the elements.
The function takes an array reference (\@ary) and number of samples to take ($n). It will first divide the array into $n+1 of (whenever possible) equal-sized partitions, leaving an element between partitions, then get the elements between the partitions.
Please visit the project's homepage at https://metacpan.org/release/Array-Sample-Partition.
Source repository is at https://github.com/perlancar/perl-Array-Sample-Partition.
Other sampling methods: Array::Sample::SysRand, Array::Sample::SimpleRandom, Array::Sample::WeightedRandom.
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2022, 2017 by perlancar <email@example.com>.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Array-Sample-Partition
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.
To install Array::Sample::Partition, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell
For more information on module installation, please visit the detailed CPAN module installation guide.