NAME

Sort::Sub::by_perl_function - Sort by Perl function

VERSION

This document describes version 0.120 of Sort::Sub::by_perl_function (from Perl distribution Sort-Sub), released on 2020-05-25.

SYNOPSIS

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

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

Generate sorter (accessed as subroutine):

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

Generate directly without Sort::Sub:

 use Sort::Sub::by_perl_function;
 my $sorter = Sort::Sub::by_perl_function::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 sortsub (from App::sortsub):

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

DESCRIPTION

This:

 use Sort::Sub '$by_perl_function', {function=>'length'};
 my @sorted = sort $by_perl_function @data;

is equivalent to:

 my @sorted = sort { length($a) <=> length($b) } @data;

SORT ARGUMENTS

"*" marks required arguments.

function*

perl::funcname.

numeric

bool.

Compare using Perl's <=> instead of cmp.

HOMEPAGE

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

SOURCE

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

BUGS

Please report any bugs or feature requests on the bugtracker website <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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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