.\" -*- 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 "Number::Compare 3"
.TH Number::Compare 3 2023-07-25 "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
Number::Compare \- numeric comparisons
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& Number::Compare\->new(">1Ki")\->test(1025); # is 1025 > 1024
\&
\& my $c = Number::Compare\->new(">1M");
\& $c\->(1_200_000);                          # slightly terser invocation
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Number::Compare compiles a simple comparison to an anonymous
subroutine, which you can call with a value to be tested again.
.PP
Now this would be very pointless, if Number::Compare didn't understand
magnitudes.
.PP
The target value may use magnitudes of kilobytes (\f(CW\*(C`k\*(C'\fR, \f(CW\*(C`ki\*(C'\fR),
megabytes (\f(CW\*(C`m\*(C'\fR, \f(CW\*(C`mi\*(C'\fR), or gigabytes (\f(CW\*(C`g\*(C'\fR, \f(CW\*(C`gi\*(C'\fR).  Those suffixed
with an \f(CW\*(C`i\*(C'\fR use the appropriate 2**n version in accordance with the
IEC standard: http://physics.nist.gov/cuu/Units/binary.html
.SH METHODS
.IX Header "METHODS"
.ie n .SS "\->new( $test )"
.el .SS "\->new( \f(CW$test\fP )"
.IX Subsection "->new( $test )"
Returns a new object that compares the specified test.
.ie n .SS "\->test( $value )"
.el .SS "\->test( \f(CW$value\fP )"
.IX Subsection "->test( $value )"
A longhanded version of \f(CW$compare\fR\->( \f(CW$value\fR ).  Predates blessed
subroutine reference implementation.
.ie n .SS "\->parse_to_perl( $test )"
.el .SS "\->parse_to_perl( \f(CW$test\fP )"
.IX Subsection "->parse_to_perl( $test )"
Returns a perl code fragment equivalent to the test.
.SH AUTHOR
.IX Header "AUTHOR"
Richard Clamp <richardc@unixbeard.net>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2002,2011 Richard Clamp.  All Rights Reserved.
.PP
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
http://physics.nist.gov/cuu/Units/binary.html