.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "SHARYANTO::Array::Util 3pm"
.TH SHARYANTO::Array::Util 3pm "2022-06-17" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
SHARYANTO::Array::Util \- Array\-related utilities
.SH "VERSION"
.IX Header "VERSION"
This document describes version 0.77 of SHARYANTO::Array::Util (from Perl distribution SHARYANTO-Utils), released on 2015\-09\-04.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use SHARYANTO::Array::Util qw(match_array_or_regex split_array);
\&
\& match_array_or_regex(\*(Aqbar\*(Aq,  [\*(Aqfoo\*(Aq, \*(Aqbar\*(Aq, qr/[xyz]/]); # true, matches string
\& match_array_or_regex(\*(Aqbaz\*(Aq,  [\*(Aqfoo\*(Aq, \*(Aqbar\*(Aq, qr/[xyz]/]); # true, matches regex
\& match_array_or_regex(\*(Aqoops\*(Aq, [\*(Aqfoo\*(Aq, \*(Aqbar\*(Aq, qr/[xyz]/]); # false
\&
\& my @res = split_array(\*(Aq\-\-\*(Aq, [qw/\-\-opt1 \-\-opt2 \-\- foo bar \-\- \-\-val/]);
\& # \-> ([qw/\-\-opt1 \-\-opt2/],  [qw/foo bar/],  [qw/\-\-val/])
\&
\& my @res = split_array(qr/\-\-/, [qw/\-\-opt1 \-\-opt2 \-\- foo bar \-\- \-\-val/], 2);
\& # \-> ([qw/\-\-opt1 \-\-opt2/],  [qw/foo bar \-\- \-\-val/])
\&
\& my @res = split_array(qr/(\-\-)/, [qw/\-\-opt1 \-\-opt2 \-\- foo bar \-\- \-\-val/], 2);
\& # \-> ([qw/\-\-opt1 \-\-opt2/],  [qw/\-\-/],  [qw/foo bar \-\- \-\-val/])
\&
\& my @res = split_array(qr/(\-)(\-)/, [qw/\-\-opt1 \-\-opt2 \-\- foo bar \-\- \-\-val/], 2);
\& # \-> ([qw/\-\-opt1 \-\-opt2/],  [qw/\- \-/],  [qw/foo bar \-\- \-\-val/])
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.ie n .SS "match_array_or_regex($needle, $haystack) \-> any"
.el .SS "match_array_or_regex($needle, \f(CW$haystack\fP) \-> any"
.IX Subsection "match_array_or_regex($needle, $haystack) -> any"
Check whether an item matches (list of) values/regexes.
.PP
Examples:
.PP
.Vb 5
\& match_array_or_regex("abc", ["abc", "abd"]); # \-> 1
\& match_array_or_regex("abc", qr/ab./); # \-> 1
\& match_array_or_regex("abc", [qr/ab./, "abd"]); # \-> 1
\&This routine can be used to match an item against a regex or a list of
\&strings/regexes, e.g. when matching against an ACL.
.Ve
.PP
Since the smartmatch (\f(CW\*(C`~~\*(C'\fR) operator can already match against a list of strings
or regexes, this function is currently basically equivalent to:
.PP
.Vb 5
\& if (ref($haystack) eq \*(AqARRAY\*(Aq) {
\&     return $needle ~~ @$haystack;
\& } else {
\&     return $needle =~ /$haystack/;
\& }
.Ve
.PP
Arguments ('*' denotes required arguments):
.IP "\(bu" 4
\&\fBhaystack\fR* => \fIre|str|array[re|str]\fR
.IP "\(bu" 4
\&\fBneedle\fR* => \fIstr\fR
.PP
Return value:  (any)
.ie n .SS "match_regex_or_array($needle, $haystack) \-> any"
.el .SS "match_regex_or_array($needle, \f(CW$haystack\fP) \-> any"
.IX Subsection "match_regex_or_array($needle, $haystack) -> any"
Alias for match_array_or_regex.
.PP
Examples:
.PP
.Vb 5
\& match_regex_or_array("abc", ["abc", "abd"]); # \-> 1
\& match_regex_or_array("abc", qr/ab./); # \-> 1
\& match_regex_or_array("abc", [qr/ab./, "abd"]); # \-> 1
\&This routine can be used to match an item against a regex or a list of
\&strings/regexes, e.g. when matching against an ACL.
.Ve
.PP
Since the smartmatch (\f(CW\*(C`~~\*(C'\fR) operator can already match against a list of strings
or regexes, this function is currently basically equivalent to:
.PP
.Vb 5
\& if (ref($haystack) eq \*(AqARRAY\*(Aq) {
\&     return $needle ~~ @$haystack;
\& } else {
\&     return $needle =~ /$haystack/;
\& }
.Ve
.PP
Arguments ('*' denotes required arguments):
.IP "\(bu" 4
\&\fBhaystack\fR* => \fIre|str|array[re|str]\fR
.IP "\(bu" 4
\&\fBneedle\fR* => \fIstr\fR
.PP
Return value:  (any)
.ie n .SS "split_array($str_or_re, \e@array[, $limit]) => \s-1LIST\s0"
.el .SS "split_array($str_or_re, \e@array[, \f(CW$limit\fP]) => \s-1LIST\s0"
.IX Subsection "split_array($str_or_re, @array[, $limit]) => LIST"
Like the \f(CW\*(C`split()\*(C'\fR builtin Perl function, but applies on an array instead of a
scalar. It loosely follows the \f(CW\*(C`split()\*(C'\fR semantic, with some exceptions.
.ie n .SS "replace_array_content($aryref, @elems) => $aryref"
.el .SS "replace_array_content($aryref, \f(CW@elems\fP) => \f(CW$aryref\fP"
.IX Subsection "replace_array_content($aryref, @elems) => $aryref"
Replace elements in <$aryref> with \f(CW@elems\fR. Return \f(CW$aryref\fR. Do not create a
new arrayref object (i.e. it is different from: \f(CW\*(C`$aryref = ["new", "content"]\*(C'\fR).
.PP
Do not use this function. In Perl you can just use: \f(CW\*(C`splice(@$aryref, 0,
length(@$aryref), @elems)\*(C'\fR or even easier: \f(CW\*(C`@$aryref = @elems\*(C'\fR. I put the
function here for reminder.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1SHARYANTO\s0
.SH "HOMEPAGE"
.IX Header "HOMEPAGE"
Please visit the project's homepage at <https://metacpan.org/release/SHARYANTO\-Utils>.
.SH "SOURCE"
.IX Header "SOURCE"
Source repository is at <https://github.com/perlancar/perl\-SHARYANTO\-Utils>.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=SHARYANTO\-Utils>
.PP
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.
.SH "AUTHOR"
.IX Header "AUTHOR"
perlancar <perlancar@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2015 by perlancar@cpan.org.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.