7 @EXPORT_OK = qw( PI e );
8 @EXPORT = qw( inf NaN );
12 require bigint; # no "use" to avoid callind import
14 ##############################################################################
22 # These are all alike, and thus faked by AUTOLOAD
24 my @faked = qw/round_mode accuracy precision div_scale/;
25 use vars qw/$VERSION $AUTOLOAD $_lite/; # _lite for testsuite
31 $name =~ s/.*:://; # split package
33 foreach my $n (@faked)
37 *{"bigrat::$name"} = sub
43 Math::BigInt->$name($_[0]);
44 Math::BigFloat->$name($_[0]);
45 return Math::BigRat->$name($_[0]);
47 return Math::BigInt->$name();
53 # delayed load of Carp and avoid recursion
55 Carp::croak ("Can't call bigrat\-\>$name, not a valid method");
60 $^H{bigrat} = undef; # no longer in effect
61 overload::remove_constant('binary','','float','','integer');
66 my $level = shift || 0;
67 my $hinthash = (caller($level))[10];
71 #############################################################################
72 # the following two routines are for Perl 5.9.4 or later and are lexical
76 return CORE::hex($_[0]) unless in_effect(1);
78 $i = '0x'.$i unless $i =~ /^0x/;
79 Math::BigInt->new($i);
84 return CORE::oct($_[0]) unless in_effect(1);
86 return Math::BigInt->from_oct($i) if $i =~ /^0[0-7]/;
87 Math::BigInt->new($i);
94 # see also bignum->import() for additional comments
96 $^H{bigrat} = 1; # we are in effect
99 # for newer Perls always override hex() and oct() with a lexical version:
106 my $lib = ''; my $lib_kind = 'try'; my $upgrade = 'Math::BigFloat';
108 my @import = ( ':constant' ); # drive it w/ constant
109 my @a = @_; my $l = scalar @_; my $j = 0;
111 my ($ver,$trace); # version? trace?
112 for ( my $i = 0; $i < $l ; $i++,$j++ )
114 if ($_[$i] eq 'upgrade')
116 # this causes upgrading
117 $upgrade = $_[$i+1]; # or undef to disable
118 my $s = 2; $s = 1 if @a-$j < 2; # avoid "can not modify non-existant..."
119 splice @a, $j, $s; $j -= $s;
121 elsif ($_[$i] =~ /^(l|lib|try|only)$/)
123 # this causes a different low lib to take care...
124 $lib_kind = $1; $lib_kind = 'lib' if $lib_kind eq 'l';
125 $lib = $_[$i+1] || '';
126 my $s = 2; $s = 1 if @a-$j < 2; # avoid "can not modify non-existant..."
127 splice @a, $j, $s; $j -= $s; $i++;
129 elsif ($_[$i] =~ /^(a|accuracy)$/)
132 my $s = 2; $s = 1 if @a-$j < 2; # avoid "can not modify non-existant..."
133 splice @a, $j, $s; $j -= $s; $i++;
135 elsif ($_[$i] =~ /^(p|precision)$/)
138 my $s = 2; $s = 1 if @a-$j < 2; # avoid "can not modify non-existant..."
139 splice @a, $j, $s; $j -= $s; $i++;
141 elsif ($_[$i] =~ /^(v|version)$/)
144 splice @a, $j, 1; $j --;
146 elsif ($_[$i] =~ /^(t|trace)$/)
149 splice @a, $j, 1; $j --;
151 elsif ($_[$i] eq 'hex')
153 splice @a, $j, 1; $j --;
154 $hex = \&bigint::_hex_global;
156 elsif ($_[$i] eq 'oct')
158 splice @a, $j, 1; $j --;
159 $oct = \&bigint::_oct_global;
161 elsif ($_[$i] !~ /^(PI|e)\z/)
163 die ("unknown option $_[$i]");
167 $_lite = 0; # using M::BI::L ?
170 require Math::BigInt::Trace; $class = 'Math::BigInt::Trace';
171 $upgrade = 'Math::BigFloat::Trace';
175 # see if we can find Math::BigInt::Lite
176 if (!defined $a && !defined $p) # rounding won't work to well
178 eval 'require Math::BigInt::Lite;';
181 @import = ( ); # :constant in Lite, not MBI
182 Math::BigInt::Lite->import( ':constant' );
183 $_lite= 1; # signal okay
186 require Math::BigInt if $_lite == 0; # not already loaded?
187 $class = 'Math::BigInt'; # regardless of MBIL or not
189 push @import, $lib_kind => $lib if $lib ne '';
190 # Math::BigInt::Trace or plain Math::BigInt
191 $class->import(@import, upgrade => $upgrade);
193 require Math::BigFloat;
194 Math::BigFloat->import( upgrade => 'Math::BigRat', ':constant' );
195 require Math::BigRat;
197 bigrat->accuracy($a) if defined $a;
198 bigrat->precision($p) if defined $p;
201 print "bigrat\t\t\t v$VERSION\n";
202 print "Math::BigInt::Lite\t v$Math::BigInt::Lite::VERSION\n" if $_lite;
203 print "Math::BigInt\t\t v$Math::BigInt::VERSION";
204 my $config = Math::BigInt->config();
205 print " lib => $config->{lib} v$config->{lib_version}\n";
206 print "Math::BigFloat\t\t v$Math::BigFloat::VERSION\n";
207 print "Math::BigRat\t\t v$Math::BigRat::VERSION\n";
211 # Take care of octal/hexadecimal constants
212 overload::constant binary => sub { bigint::_binary_constant(shift) };
214 # if another big* was already loaded:
215 my ($package) = caller();
218 if (!defined *{"${package}::inf"})
220 $self->export_to_level(1,$self,@a); # export inf and NaN
223 no warnings 'redefine';
224 *CORE::GLOBAL::oct = $oct if $oct;
225 *CORE::GLOBAL::hex = $hex if $hex;
229 sub PI { local $Math::BigFloat::upgrade = undef; Math::BigFloat::bpi(@_); }
230 sub e { local $Math::BigFloat::upgrade = undef; Math::BigFloat->bone()->bexp(@_); }
238 bigrat - Transparent BigNumber/BigRational support for Perl
244 print 2 + 4.5,"\n"; # BigFloat 6.5
245 print 1/3 + 1/4,"\n"; # produces 7/12
249 print 1/3,"\n"; # 0.33333...
252 # Note that this will make hex() and oct() be globally overriden:
253 use bigrat qw/hex oct/;
254 print hex("0x1234567890123490"),"\n";
255 print oct("01234567890123490"),"\n";
259 All operators (including basic math operations) are overloaded. Integer and
260 floating-point constants are created as proper BigInts or BigFloats,
263 Other than L<bignum>, this module upgrades to Math::BigRat, meaning that
264 instead of 2.5 you will get 2+1/2 as output.
268 C<bigrat> is just a thin wrapper around various modules of the Math::BigInt
269 family. Think of it as the head of the family, who runs the shop, and orders
270 the others to do the work.
272 The following modules are currently used by bignum:
274 Math::BigInt::Lite (for speed, and only if it is loadable)
281 Math with the numbers is done (by default) by a module called
282 Math::BigInt::Calc. This is equivalent to saying:
284 use bigrat lib => 'Calc';
286 You can change this by using:
288 use bignum lib => 'GMP';
290 The following would first try to find Math::BigInt::Foo, then
291 Math::BigInt::Bar, and when this also fails, revert to Math::BigInt::Calc:
293 use bigrat lib => 'Foo,Math::BigInt::Bar';
295 Using C<lib> warns if none of the specified libraries can be found and
296 L<Math::BigInt> did fall back to one of the default libraries.
297 To supress this warning, use C<try> instead:
299 use bignum try => 'GMP';
301 If you want the code to die instead of falling back, use C<only> instead:
303 use bignum only => 'GMP';
305 Please see respective module documentation for further details.
309 The sign is either '+', '-', 'NaN', '+inf' or '-inf'.
311 A sign of 'NaN' is used to represent the result when input arguments are not
312 numbers or as a result of 0/0. '+inf' and '-inf' represent plus respectively
313 minus infinity. You will get '+inf' when dividing a positive number by 0, and
314 '-inf' when dividing any negative number by 0.
318 Since all numbers are not objects, you can use all functions that are part of
319 the BigInt or BigFloat API. It is wise to use only the bxxx() notation, and not
320 the fxxx() notation, though. This makes you independed on the fact that the
321 underlying object might morph into a different class than BigFloat.
327 A shortcut to return Math::BigInt->binf(). Useful because Perl does not always
328 handle bareword C<inf> properly.
332 A shortcut to return Math::BigInt->bnan(). Useful because Perl does not always
333 handle bareword C<NaN> properly.
337 Returns Euler's number C<e>, aka exp(1), to the given number of digits.
341 Returns PI to the given number of digits.
345 Return the class that numbers are upgraded to, is in fact returning
346 C<$Math::BigInt::upgrade>.
352 print "in effect\n" if bigrat::in_effect; # true
355 print "in effect\n" if bigrat::in_effect; # false
358 Returns true or false if C<bigrat> is in effect in the current scope.
360 This method only works on Perl v5.9.4 or later.
366 Math with the numbers is done (by default) by a module called
370 But a warning is in order. When using the following to make a copy of a number,
371 only a shallow copy will be made.
376 If you want to make a real copy, use the following:
380 Using the copy or the original with overloaded math is okay, e.g. the
384 print $x + 1, " ", $y,"\n"; # prints 10 9
386 but calling any method that modifies the number directly will result in
387 B<both> the original and the copy being destroyed:
390 print $x->badd(1), " ", $y,"\n"; # prints 10 10
393 print $x->binc(1), " ", $y,"\n"; # prints 10 10
396 print $x->bmul(2), " ", $y,"\n"; # prints 18 18
398 Using methods that do not modify, but testthe contents works:
401 $z = 9 if $x->is_zero(); # works fine
403 See the documentation about the copy constructor and C<=> in overload, as
404 well as the documentation in BigInt for further details.
408 bignum recognizes some options that can be passed while loading it via use.
409 The options can (currently) be either a single letter form, or the long form.
410 The following options exist:
416 This sets the accuracy for all math operations. The argument must be greater
417 than or equal to zero. See Math::BigInt's bround() function for details.
419 perl -Mbigrat=a,50 -le 'print sqrt(20)'
421 Note that setting precision and accurary at the same time is not possible.
425 This sets the precision for all math operations. The argument can be any
426 integer. Negative values mean a fixed number of digits after the dot, while
427 a positive value rounds to this digit left from the dot. 0 or 1 mean round to
428 integer. See Math::BigInt's bfround() function for details.
430 perl -Mbigrat=p,-50 -le 'print sqrt(20)'
432 Note that setting precision and accurary at the same time is not possible.
436 This enables a trace mode and is primarily for debugging bignum or
437 Math::BigInt/Math::BigFloat.
441 Load a different math lib, see L<MATH LIBRARY>.
443 perl -Mbigrat=l,GMP -e 'print 2 ** 512'
445 Currently there is no way to specify more than one library on the command
446 line. This means the following does not work:
448 perl -Mbignum=l,GMP,Pari -e 'print 2 ** 512'
450 This will be hopefully fixed soon ;)
454 Override the build-in hex() method with a version that can handle big
455 integers. Note that under Perl v5.9.4 or ealier, this will be global
456 and cannot be disabled with "no bigint;".
460 Override the build-in oct() method with a version that can handle big
461 integers. Note that under Perl v5.9.4 or ealier, this will be global
462 and cannot be disabled with "no bigint;".
466 This prints out the name and version of all modules used and then exits.
478 This method only works on Perl v5.9.4 or later.
482 C<bigint> overrides these routines with versions that can also handle
483 big integer values. Under Perl prior to version v5.9.4, however, this
484 will not happen unless you specifically ask for it with the two
485 import tags "hex" and "oct" - and then it will be global and cannot be
486 disabled inside a scope with "no bigint":
488 use bigint qw/hex oct/;
490 print hex("0x1234567890123456");
493 print hex("0x1234567890123456");
496 The second call to hex() will warn about a non-portable constant.
502 # will warn only under Perl older than v5.9.4
503 print hex("0x1234567890123456");
509 perl -Mbigrat -le 'print sqrt(33)'
510 perl -Mbigrat -le 'print 2*255'
511 perl -Mbigrat -le 'print 4.5+2*255'
512 perl -Mbigrat -le 'print 3/7 + 5/7 + 8/3'
513 perl -Mbigrat -le 'print 12->is_odd()';
514 perl -Mbignum=l,GMP -le 'print 7 ** 7777'
518 This program is free software; you may redistribute it and/or modify it under
519 the same terms as Perl itself.
523 Especially L<bignum>.
525 L<Math::BigFloat>, L<Math::BigInt>, L<Math::BigRat> and L<Math::Big> as well
526 as L<Math::BigInt::BitVect>, L<Math::BigInt::Pari> and L<Math::BigInt::GMP>.
530 (C) by Tels L<http://bloodgate.com/> in early 2002 - 2007.