/ 
Sort-SubBundle-BySimilarity-0.001
River stage one • 1 direct dependent • 2 total dependents
/ Sort::Sub::by_similarity_using_editdist

NAME

Sort::Sub::by_similarity_using_editdist - Sort strings by similarity to target string (most similar first)

VERSION

This document describes version 0.001 of Sort::Sub::by_similarity_using_editdist (from Perl distribution Sort-SubBundle-BySimilarity), released on 2024-01-12.

SYNOPSIS

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

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

Generate sorter (accessed as subroutine):

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

Generate directly without Sort::Sub:

use Sort::Sub::by_similarity_using_editdist;
my $sorter = Sort::Sub::by_similarity_using_editdist::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_similarity_using_editdist
% some-cmd | sortsub by_similarity_using_editdist --ignore-case -r

DESCRIPTION

This module can generate sort subroutine. It is meant to be used via Sort::Sub, although you can also use it directly via gen_sorter().

SORT ARGUMENTS

* marks required arguments.

string*

str.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Sort-SubBundle-BySimilarity.

SOURCE

Source repository is at https://github.com/perlancar/perl-Sort-SubBundle-BySimilarity.

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 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-SubBundle-BySimilarity

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.