.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "Perl::Critic::Policy::BuiltinFunctions::ProhibitBooleanGrep 3pm"
.TH Perl::Critic::Policy::BuiltinFunctions::ProhibitBooleanGrep 3pm 2023-07-26 "perl v5.38.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
Perl::Critic::Policy::BuiltinFunctions::ProhibitBooleanGrep \- Use "any" from "List::Util", "List::SomeUtils", or "List::MoreUtils" instead of "grep" in boolean context.
.SH AFFILIATION
.IX Header "AFFILIATION"
This Policy is part of the core Perl::Critic
distribution.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Using \f(CW\*(C`grep\*(C'\fR in boolean context is a common idiom for checking if any
elements in a list match a condition.  This works because boolean
context is a subset of scalar context, and grep returns the number of
matches in scalar context.  A non-zero number of matches means a
match.
.PP
But consider the case of a long array where the first element is a
match.  Boolean \f(CW\*(C`grep\*(C'\fR still checks all of the rest of the elements
needlessly.  Instead, a better solution is to use the \f(CW\*(C`any\*(C'\fR function
from either List::Util, List::SomeUtils, or
List::MoreUtils. The \f(CW\*(C`any\*(C'\fR function will return as soon
as a successful match is found, rather than processing the entire list.
This saves time.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
This Policy is not configurable except for the standard options.
.SH CAVEATS
.IX Header "CAVEATS"
The algorithm for detecting boolean context takes a LOT of shortcuts.
There are lots of known false negatives.  But, I was conservative in
writing this, so I hope there are no false positives.
.SH AUTHOR
.IX Header "AUTHOR"
Chris Dolan <cdolan@cpan.org>
.SH CREDITS
.IX Header "CREDITS"
Initial development of this policy was supported by a grant from the
Perl Foundation.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2007\-2021 Chris Dolan.  Many rights reserved.
.PP
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.  The full text of this license
can be found in the LICENSE file included with this module.