.\" -*- 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 "Scalar::Util::Numeric 3pm"
.TH Scalar::Util::Numeric 3pm 2024-03-07 "perl v5.38.2" "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
Scalar::Util::Numeric \- numeric tests for perl scalars
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Scalar::Util::Numeric qw(isnum isint isfloat);
\&
\&    foo($bar / 2) if (isnum $bar);
\&
\&    if (isint $baz) {
\&        # ...
\&    } elsif (isfloat $baz) {
\&        # ...
\&    }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module exports a number of wrappers around perl's builtin \f(CW\*(C`grok_number\*(C'\fR function, which
returns the numeric type of its argument, or 0 if it isn't numeric.
.SH TAGS
.IX Header "TAGS"
All of the functions exported by Scalar::Util::Numeric can be imported by using the \f(CW\*(C`:all\*(C'\fR tag:
.PP
.Vb 1
\&    use Scalar::Util::Numeric qw(:all);
.Ve
.SH EXPORTS
.IX Header "EXPORTS"
.SS isnum
.IX Subsection "isnum"
.Vb 1
\&    isnum ($val)
.Ve
.PP
Returns a nonzero value (indicating the numeric type) if \f(CW$val\fR is a number.
.PP
The numeric type is a conjunction of the following flags:
.PP
.Vb 6
\&    0x01  IS_NUMBER_IN_UV               (number within UV range \- not necessarily an integer)
\&    0x02  IS_NUMBER_GREATER_THAN_UV_MAX (number is greater than UV_MAX)
\&    0x04  IS_NUMBER_NOT_INT             (saw . or E notation)
\&    0x08  IS_NUMBER_NEG                 (leading minus sign)
\&    0x10  IS_NUMBER_INFINITY            (Infinity)
\&    0x20  IS_NUMBER_NAN                 (NaN \- not a number)
.Ve
.SS isint
.IX Subsection "isint"
.SS isuv
.IX Subsection "isuv"
.SS isbig
.IX Subsection "isbig"
.SS isfloat
.IX Subsection "isfloat"
.SS isneg
.IX Subsection "isneg"
.SS isinf
.IX Subsection "isinf"
.SS isnan
.IX Subsection "isnan"
The following flavours of \f(CW\*(C`isnum\*(C'\fR (corresponding to the flags above) are also available:
.PP
.Vb 7
\&    isint
\&    isuv
\&    isbig
\&    isfloat
\&    isneg
\&    isinf
\&    isnan
.Ve
.PP
\&\f(CW\*(C`isint\*(C'\fR returns \-1 if its operand is a negative integer, 1 if
it's 0 or a positive integer, and 0 otherwise.
.PP
The others always return 1 or 0.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP \(bu 4
"type" in autobox
.IP \(bu 4
Data::Types
.IP \(bu 4
Params::Classify
.IP \(bu 4
Params::Util
.IP \(bu 4
Scalar::Util
.IP \(bu 4
String::Numeric
.SH VERSION
.IX Header "VERSION"
0.40
.SH AUTHORS
.IX Header "AUTHORS"
.IP \(bu 4
chocolateboy <chocolate@cpan.org>
.IP \(bu 4
Michael G. Schwern <schwern@pobox.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2005\-2014, chocolateboy.
.PP
This module is free software. It may be used, redistributed
and/or modified under the same terms as Perl itself.