/ 
Sort-Sub-0.121
River stage three • 27 direct dependents • 266 total dependents
/ Sort::Sub::by_perl_function

NAME

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

VERSION

This document describes version 0.121 of Sort::Sub::by_perl_function (from Perl distribution Sort-Sub), released on 2024-07-17.

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.

SEE ALSO

Sort::Sub

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, 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) 2024, 2020, 2019, 2018, 2016, 2015 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=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.