NAME

Array::Sample::SimpleRandom - Sample elements randomly (with or without replacement)

VERSION

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

SYNOPSIS

 use Array::Sample:: qw(sample_simple_random_with_replacement sample_simple_random_no_replacement);

 sample_simple_random_with_replacement([0,1], 1); => (0)
 sample_simple_random_with_replacement([0,1], 3); => (0,1,0)

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

DESCRIPTION

FUNCTIONS

All functions are not exported by default, but exportable.

sample_simple_random_with_replacement

Syntax: sample_simple_random_with_replacement(\@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 number of samples to take ($n). It will take samples at random position. An element can be picked more than once.

sample_simple_random_no_replacement

Syntax: sample_simple_random_no_replacement(\@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 number of samples to take ($n). It will take samples at random position. An element can only be epicked once. If $n is larger than the number of elements in the array, only that many elements will be taken.

The implementation constructs a (shallow) copy of the array then remove elements randomly from the copy-array until the number of requested samples are met. There is another implementation that avoids creating a copy but scans the array once; see Array::Sample::SimpleRandom::Scan.

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

Other sampling methods: Array::Sample::SysRand, Array::Sample::Partition, Array::Sample::WeightedRandom.

Array::Sample::SimpleRandom::Scan

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.