NAME
Array::Sample::SysRand - Systematic random sampling from an array
VERSION
This document describes version 0.004 of Array::Sample::SysRand (from Perl distribution Array-Sample-SysRand), released on 2023-06-20.
SYNOPSIS
use Array::Sample::SysRand qw(sample_sysrand);
sample_sysrand([0,1,2,3,4,5,6,7,8,9], 5); => (5, 7, 9, 1, 3)
sample_sysrand([0,1,2,3,4,5,6,7,8,9], 5); => (2, 4, 6, 8, 0)
sample_sysrand([0,1,2,3,4,5,6,7,8,9], 3); => (2, 6, 9)
sample_sysrand([0,1,2,3,4,5,6,7,8,9], 3); => (4, 8, 1)DESCRIPTION
Keywords: systematic sampling, interval sampling.
FUNCTIONS
All functions are not exported by default, but exportable.
sample_sysrand
Syntax: sample_sysrand(\@ary, $n [ , \%opts ]) => list
Options:
pos => bool
If set to true, will return positions instead of the elements.
The function takes an array reference (\@ary) and the number of samples requested ($n) and will return a list of samples. It will start from a random position to get the first sample then jump at fixed interval to get the subsequent ones.
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Array-Sample-SysRand.
SOURCE
Source repository is at https://github.com/perlancar/perl-Array-Sample-SysRand.
SEE ALSO
About systematic (random) sampling: https://www.investopedia.com/terms/s/systematic-sampling.asp
Other sampling methods: Array::Sample::Partition, Array::Sample::SimpleRandom, Array::Sample::WeightedRandom
AUTHOR
perlancar <perlancar@cpan.org>
CONTRIBUTING
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 -lIf 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, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me.
COPYRIGHT AND LICENSE
This software is copyright (c) 2023, 2022 by perlancar <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.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Array-Sample-SysRand
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.