The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Array-Sample-SimpleRandom-0.003
River stage one • 1 direct dependent • 1 total dependent
/ Array::Sample::SimpleRandom::Scan

NAME

Array::Sample::SimpleRandom::Scan - Simple random sampling from an array (scan algorithm)

VERSION

This document describes version 0.003 of Array::Sample::SimpleRandom::Scan (from Perl distribution Array-Sample-SimpleRandom), released on 2022-05-21.

SYNOPSIS

 use Array::Sample::SimpleRandom::Scan qw(sample_simple_random_no_replacement);

 sample_simple_random_no_replacement([0,1,2,3,4,5], 1); # => (3)
 sample_simple_random_no_replacement([0,1,2,3,4,5], 1); # => (5)

 sample_simple_random_no_replacement([0,1,2,3,4,5], 3); # => (4,1,5)
 sample_simple_random_no_replacement([0,1,2,3,4,5], 3); # => (1,4,3)

DESCRIPTION

FUNCTIONS

sample_simple_random_no_replacement

Usage:

 my @items = sample_simple_random_no_replacement(\@ary, $n [ , \%opts ]);

This function takes an array reference (\@ary) and the number of samples requested ($n) and will return a list of elements. Samples will be picked without replacement, e.g. an element will not be chosen more than once (note that it still possible to return duplicate values if the original array contain duplicate values).

This function is the same as the one in Array::Sample::SimpleRandom, except that it uses a scan algorithm from Array::Pick::Scan.

  • pos

    Bool. If set to true, function will return positions instead of the items.

FAQ

Why no sample_simple_random_with_replacement?

This kind of sampling does not require scanning algorithm.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Array-Sample-SimpleRandom.

SOURCE

Source repository is at https://github.com/perlancar/perl-Array-Sample-SimpleRandom.

SEE ALSO

Array::Sample::SimpleRandom

Other sampling methods: Array::Sample::Partition, Array::Sample::SysRand, 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 -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.

COPYRIGHT AND LICENSE

This software is copyright (c) 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-SimpleRandom

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.