File Coverage

blib/lib/Sort/Sub/by_rand.pm

Criterion	Covered	Total	%
statement	11	12	91.6
branch			n/a
condition			n/a
subroutine	5	6	83.3
pod	0	2	0.0
total	16	20	80.0

package Sort::Sub::by_rand;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2020-02-28'; # DATE
our $DIST = 'Sort-Sub'; # DIST
our $VERSION = '0.117'; # VERSION

use 5.010;
use strict;
use warnings;

sub meta {
    return {
        v => 1,
        summary => "Sort randomly using Perl's rand()",
    };
}

sub gen_sorter {
    my ($is_reverse, $is_ci) = @_;

    sub { int(3*rand())-1 };
}

1;
# ABSTRACT: Sort randomly using Perl's rand()

__END__

=pod

=encoding UTF-8

=head1 NAME

Sort::Sub::by_rand - Sort randomly using Perl's rand()

=head1 VERSION

This document describes version 0.117 of Sort::Sub::by_rand (from Perl distribution Sort-Sub), released on 2020-02-28.

=head1 SYNOPSIS

Generate sorter (accessed as variable) via L<Sort::Sub> import:

 use Sort::Sub '$by_rand'; # use '$by_rand<i>' for case-insensitive sorting, '$by_rand<r>' for reverse sorting
 my @sorted = sort $by_rand ('item', ...);

Generate sorter (accessed as subroutine):

 use Sort::Sub 'by_rand<ir>';
 my @sorted = sort {by_rand} ('item', ...);

Generate directly without Sort::Sub:

 use Sort::Sub::by_rand;
 my $sorter = Sort::Sub::by_rand::gen_sorter(
     ci => 1,      # default 0, set 1 to sort case-insensitively
     reverse => 1, # default 0, set 1 to sort in reverse order
 );
 my @sorted = sort $sorter ('item', ...);

Use in shell/CLI with L<sortsub> (from L<App::sortsub>):

 % some-cmd | sortsub by_rand
 % some-cmd | sortsub by_rand --ignore-case -r

=head1 DESCRIPTION

This is equivalent to:

 sub { int(3*rand())-1 }

The case sensitivity (C<i>) and reverse (C<r>) flags are not relevant.

=for Pod::Coverage ^(gen_sorter|meta)$

=head1 HOMEPAGE

Please visit the project's homepage at L<https://metacpan.org/release/Sort-Sub>.

=head1 SOURCE

Source repository is at L<https://github.com/perlancar/perl-Sort-Sub>.

=head1 BUGS

Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=Sort-Sub>

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.

=head1 SEE ALSO

L<Sort::Sub>

=head1 AUTHOR

perlancar <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2020, 2019, 2018, 2016, 2015 by [e-mail].

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut