Initial commit of OpenSPARC T2 architecture model.

[OpenSPARC-T2-SAM] / sam-t2 / devtools / v8plus / man / man3 / bignum.3

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "bignum 3"
.TH bignum 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
.SH "NAME"
bignum \- Transparent BigNumber support for Perl
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use bignum;
.Ve
.PP
.Vb 4
\&  $x = 2 + 4.5,"\en";                    # BigFloat 6.5
\&  print 2 ** 512 * 0.1,"\en";            # really is what you think it is
\&  print inf * inf,"\en";                 # prints inf
\&  print NaN * 3,"\en";                   # prints NaN
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
All operators (including basic math operations) are overloaded. Integer and
floating-point constants are created as proper BigInts or BigFloats,
respectively.
.PP
If you do 
.PP
.Vb 1
\&        use bignum;
.Ve
.PP
at the top of your script, Math::BigFloat and Math::BigInt will be loaded
and any constant number will be converted to an object (Math::BigFloat for
floats like 3.1415 and Math::BigInt for integers like 1234).
.PP
So, the following line:
.PP
.Vb 1
\&        $x = 1234;
.Ve
.PP
creates actually a Math::BigInt and stores a reference to in \f(CW$x\fR.
This happens transparently and behind your back, so to speak.
.PP
You can see this with the following:
.PP
.Vb 1
\&        perl -Mbignum -le 'print ref(1234)'
.Ve
.PP
Don't worry if it says Math::BigInt::Lite, bignum and friends will use Lite
if it is installed since it is faster for some operations. It will be
automatically upgraded to BigInt whenever neccessary:
.PP
.Vb 1
\&        perl -Mbignum -le 'print ref(2**255)'
.Ve
.PP
This also means it is a bad idea to check for some specific package, since
the actual contents of \f(CW$x\fR might be something unexpected. Due to the
transparent way of bignum \f(CW\*(C`ref()\*(C'\fR should not be neccessary, anyway.
.PP
Since Math::BigInt and BigFloat also overload the normal math operations,
the following line will still work:
.PP
.Vb 1
\&        perl -Mbignum -le 'print ref(1234+1234)'
.Ve
.PP
Since numbers are actually objects, you can call all the usual methods from
BigInt/BigFloat on them. This even works to some extent on expressions:
.PP
.Vb 4
\&        perl -Mbignum -le '$x = 1234; print $x->bdec()'
\&        perl -Mbignum -le 'print 1234->binc();'
\&        perl -Mbignum -le 'print 1234->binc->badd(6);'
\&        perl -Mbignum -le 'print +(1234)->binc()'
.Ve
.PP
(Note that print doesn't do what you expect if the expression starts with
\&'(' hence the \f(CW\*(C`+\*(C'\fR)
.PP
You can even chain the operations together as usual:
.PP
.Vb 2
\&        perl -Mbignum -le 'print 1234->binc->badd(6);'
\&        1241
.Ve
.PP
Under bignum (or bigint or bigrat), Perl will \*(L"upgrade\*(R" the numbers
appropriately. This means that:
.PP
.Vb 2
\&        perl -Mbignum -le 'print 1234+4.5'
\&        1238.5
.Ve
.PP
will work correctly. These mixed cases don't do always work when using
Math::BigInt or Math::BigFloat alone, or at least not in the way normal Perl
scalars work. 
.PP
If you do want to work with large integers like under \f(CW\*(C`use integer;\*(C'\fR, try
\&\f(CW\*(C`use bigint;\*(C'\fR:
.PP
.Vb 2
\&        perl -Mbigint -le 'print 1234.5+4.5'
\&        1238
.Ve
.PP
There is also \f(CW\*(C`use bigrat;\*(C'\fR which gives you big rationals:
.PP
.Vb 2
\&        perl -Mbigrat -le 'print 1234+4.1'
\&        12381/10
.Ve
.PP
The entire upgrading/downgrading is still experimental and might not work
as you expect or may even have bugs.
.PP
You might get errors like this:
.PP
.Vb 2
\&        Can't use an undefined value as an ARRAY reference at
\&        /usr/local/lib/perl5/5.8.0/Math/BigInt/Calc.pm line 864
.Ve
.PP
This means somewhere a routine got a BigFloat/Lite but expected a BigInt (or
vice versa) and the upgrade/downgrad path was missing. This is a bug, please
report it so that we can fix it.
.PP
You might consider using just Math::BigInt or Math::BigFloat, since they
allow you finer control over what get's done in which module/space. For
instance, simple loop counters will be Math::BigInts under \f(CW\*(C`use bignum;\*(C'\fR and
this is slower than keeping them as Perl scalars:
.PP
.Vb 1
\&        perl -Mbignum -le 'for ($i = 0; $i < 10; $i++) { print ref($i); }'
.Ve
.PP
Please note the following does not work as expected (prints nothing), since
overloading of '..' is not yet possible in Perl (as of v5.8.0):
.PP
.Vb 1
\&        perl -Mbignum -le 'for (1..2) { print ref($_); }'
.Ve
.Sh "Options"
.IX Subsection "Options"
bignum recognizes some options that can be passed while loading it via use.
The options can (currently) be either a single letter form, or the long form.
The following options exist:
.IP "a or accuracy" 2
.IX Item "a or accuracy"
This sets the accuracy for all math operations. The argument must be greater
than or equal to zero. See Math::BigInt's \fIbround()\fR function for details.
.Sp
.Vb 1
\&        perl -Mbignum=a,50 -le 'print sqrt(20)'
.Ve
.IP "p or precision" 2
.IX Item "p or precision"
This sets the precision for all math operations. The argument can be any
integer. Negative values mean a fixed number of digits after the dot, while
a positive value rounds to this digit left from the dot. 0 or 1 mean round to
integer. See Math::BigInt's \fIbfround()\fR function for details.
.Sp
.Vb 1
\&        perl -Mbignum=p,-50 -le 'print sqrt(20)'
.Ve
.IP "t or trace" 2
.IX Item "t or trace"
This enables a trace mode and is primarily for debugging bignum or
Math::BigInt/Math::BigFloat.
.IP "l or lib" 2
.IX Item "l or lib"
Load a different math lib, see \*(L"\s-1MATH\s0 \s-1LIBRARY\s0\*(R".
.Sp
.Vb 1
\&        perl -Mbignum=l,GMP -e 'print 2 ** 512'
.Ve
.Sp
Currently there is no way to specify more than one library on the command
line. This will be hopefully fixed soon ;)
.IP "v or version" 2
.IX Item "v or version"
This prints out the name and version of all modules used and then exits.
.Sp
.Vb 1
\&        perl -Mbignum=v
.Ve
.Sh "Methods"
.IX Subsection "Methods"
Beside \fIimport()\fR and \s-1\fIAUTOLOAD\s0()\fR there are only a few other methods.
.Sp
Since all numbers are now objects, you can use all functions that are part of
the BigInt or BigFloat \s-1API\s0. It is wise to use only the \fIbxxx()\fR notation, and not
the \fIfxxx()\fR notation, though. This makes it possible that the underlying object
might morph into a different class than BigFloat.
.Sh "Caveat"
.IX Subsection "Caveat"
But a warning is in order. When using the following to make a copy of a number,
only a shallow copy will be made.
.Sp
.Vb 2
\&        $x = 9; $y = $x;
\&        $x = $y = 7;
.Ve
.Sp
If you want to make a real copy, use the following:
.Sp
.Vb 1
\&        $y = $x->copy();
.Ve
.Sp
Using the copy or the original with overloaded math is okay, e.g. the
following work:
.Sp
.Vb 2
\&        $x = 9; $y = $x;
\&        print $x + 1, " ", $y,"\en";     # prints 10 9
.Ve
.Sp
but calling any method that modifies the number directly will result in
\&\fBboth\fR the original and the copy beeing destroyed:
.Sp
.Vb 2
\&        $x = 9; $y = $x;
\&        print $x->badd(1), " ", $y,"\en";        # prints 10 10
.Ve
.Sp
.Vb 2
\&        $x = 9; $y = $x;
\&        print $x->binc(1), " ", $y,"\en";        # prints 10 10
.Ve
.Sp
.Vb 2
\&        $x = 9; $y = $x;
\&        print $x->bmul(2), " ", $y,"\en";        # prints 18 18
.Ve
.Sp
Using methods that do not modify, but testthe contents works:
.Sp
.Vb 2
\&        $x = 9; $y = $x;
\&        $z = 9 if $x->is_zero();                # works fine
.Ve
.Sp
See the documentation about the copy constructor and \f(CW\*(C`=\*(C'\fR in overload, as
well as the documentation in BigInt for further details.
.RS 2
.IP "\fIinf()\fR" 2
.IX Item "inf()"
A shortcut to return Math::BigInt\->\fIbinf()\fR. Usefull because Perl does not always
handle bareword \f(CW\*(C`inf\*(C'\fR properly.
.IP "\fINaN()\fR" 2
.IX Item "NaN()"
A shortcut to return Math::BigInt\->\fIbnan()\fR. Usefull because Perl does not always
handle bareword \f(CW\*(C`NaN\*(C'\fR properly.
.IP "\fIupgrade()\fR" 2
.IX Item "upgrade()"
Return the class that numbers are upgraded to, is in fact returning
\&\f(CW$Math::BigInt::upgrade\fR.
.RE
.RS 2
.Sh "\s-1MATH\s0 \s-1LIBRARY\s0"
.IX Subsection "MATH LIBRARY"
Math with the numbers is done (by default) by a module called
Math::BigInt::Calc. This is equivalent to saying:
.Sp
.Vb 1
\&        use bignum lib => 'Calc';
.Ve
.Sp
You can change this by using:
.Sp
.Vb 1
\&        use bignum lib => 'BitVect';
.Ve
.Sp
The following would first try to find Math::BigInt::Foo, then
Math::BigInt::Bar, and when this also fails, revert to Math::BigInt::Calc:
.Sp
.Vb 1
\&        use bignum lib => 'Foo,Math::BigInt::Bar';
.Ve
.Sp
Please see respective module documentation for further details.
.Sh "\s-1INTERNAL\s0 \s-1FORMAT\s0"
.IX Subsection "INTERNAL FORMAT"
The numbers are stored as objects, and their internals might change at anytime,
especially between math operations. The objects also might belong to different
classes, like Math::BigInt, or Math::BigFLoat. Mixing them together, even
with normal scalars is not extraordinary, but normal and expected.
.Sp
You should not depend on the internal format, all accesses must go through
accessor methods. E.g. looking at \f(CW$x\fR\->{sign} is not a bright idea since there
is no guaranty that the object in question has such a hashkey, nor is a hash
underneath at all.
.Sh "\s-1SIGN\s0"
.IX Subsection "SIGN"
The sign is either '+', '\-', 'NaN', '+inf' or '\-inf' and stored seperately.
You can access it with the \fIsign()\fR method.
.Sp
A sign of 'NaN' is used to represent the result when input arguments are not
numbers or as a result of 0/0. '+inf' and '\-inf' represent plus respectively
minus infinity. You will get '+inf' when dividing a positive number by 0, and
\&'\-inf' when dividing any negative number by 0.
.SH "MODULES USED"
.IX Header "MODULES USED"
\&\f(CW\*(C`bignum\*(C'\fR is just a thin wrapper around various modules of the Math::BigInt
family. Think of it as the head of the family, who runs the shop, and orders
the others to do the work.
.Sp
The following modules are currently used by bignum:
.Sp
.Vb 3
\&        Math::BigInt::Lite      (for speed, and only if it is loadable)
\&        Math::BigInt
\&        Math::BigFloat
.Ve
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Some cool command line examples to impress the Python crowd ;)
.Sp
.Vb 8
\&        perl -Mbignum -le 'print sqrt(33)'
\&        perl -Mbignum -le 'print 2*255'
\&        perl -Mbignum -le 'print 4.5+2*255'
\&        perl -Mbignum -le 'print 3/7 + 5/7 + 8/3'
\&        perl -Mbignum -le 'print 123->is_odd()'
\&        perl -Mbignum -le 'print log(2)'
\&        perl -Mbignum -le 'print 2 ** 0.5'
\&        perl -Mbignum=a,65 -le 'print 2 ** 0.2'
.Ve
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you may redistribute it and/or modify it under
the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Especially bigrat as in \f(CW\*(C`perl \-Mbigrat \-le 'print 1/3+1/4'\*(C'\fR.
.Sp
Math::BigFloat, Math::BigInt, Math::BigRat and Math::Big as well
as Math::BigInt::BitVect, Math::BigInt::Pari and  Math::BigInt::GMP.
.SH "AUTHORS"
.IX Header "AUTHORS"
(C) by Tels <http://bloodgate.com/> in early 2002, 2003.