.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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 "Mango::BSON::Number 3pm"
.TH Mango::BSON::Number 3pm "2020-06-05" "perl v5.30.3" "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"
Mango::BSON::Number \- Numerical types
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use Mango::BSON;
\&  use Mango::BSON::Number;
\&
\&  my $number = Mango::BSON::Number\->new(666, Mango::BSON::INT64);
\&  say $number;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Mango::BSON::Number is a container for numerical values with a strict
type.
.SH "METHODS"
.IX Header "METHODS"
Mango::BSON::Number inherits all methods from Mojo::Base and implements
the following new ones.
.SS "new"
.IX Subsection "new"
.Vb 1
\&  my $number = Mango::BSON::Number\->new(3.14, Mango::BSON::DOUBLE);
.Ve
.PP
Construct a new Mango::BSON::Number object. Croak if the value is
incompatible with the given type. The 3 supported types are \f(CW\*(C`DOUBLE\*(C'\fR,
\&\f(CW\*(C`INT32\*(C'\fR and \f(CW\*(C`INT64\*(C'\fR.
.SS "\s-1TO_JSON\s0"
.IX Subsection "TO_JSON"
.Vb 1
\&  my $num = $obj\->TO_JSON;
.Ve
.PP
Return the numerical value.
.SS "to_string"
.IX Subsection "to_string"
.Vb 1
\&  my $str = $num\->to_string;
.Ve
.PP
Return the value as a string.
.SS "isa_number"
.IX Subsection "isa_number"
.Vb 1
\&  my $flags = Mango::BSON::Number::isa_number(25);
.Ve
.PP
Determine if the given variable is a number by looking at the internal
flags of the perl scalar object.
.PP
Return \f(CW\*(C`undef\*(C'\fR if the value is not a number, or a non-null value otherwise.
This value contains flags which can be used for finer analysis of the scalar.
.SS "guess_type"
.IX Subsection "guess_type"
.Vb 1
\&  my $mongo_type = Mango::BSON::Number::guess_type(25);
.Ve
.PP
Chose which \s-1BSON\s0 type to use to encode the given numeric value. Possible
types are: \f(CW\*(C`Mango::BSON::DOUBLE\*(C'\fR, \f(CW\*(C`Mango::BSON::INT32\*(C'\fR or
\&\f(CW\*(C`Mango::BSON::INT64\*(C'\fR.
.PP
Return \f(CW\*(C`undef\*(C'\fR if the given value is not a number.
.SH "OPERATORS"
.IX Header "OPERATORS"
Mango::BSON::Time overloads the following operators.
.SS "bool"
.IX Subsection "bool"
.Vb 1
\&  my $bool = !!$num;
.Ve
.SS "stringify"
.IX Subsection "stringify"
.Vb 1
\&  my $str = "$num";
.Ve
.PP
Alias for \*(L"to_string\*(R".
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mango, Mojolicious::Guides, <http://mojolicio.us>.