Upgrage to bignum-0.21 and Math-BigRat-0.19
[p5sagit/p5-mst-13.2.git] / lib / bigint.pm
index 831819b..7b5f150 100644 (file)
@@ -1,7 +1,7 @@
 package bigint;
-require 5.005;
+use 5.006002;
 
-$VERSION = '0.07';
+$VERSION = '0.10';
 use Exporter;
 @ISA           = qw( Exporter );
 @EXPORT_OK     = qw( ); 
@@ -54,10 +54,23 @@ sub upgrade
 #    {
 #    $Math::BigInt::upgrade = $_[0];
 #    }
-  return $Math::BigInt::upgrade;
+  $Math::BigInt::upgrade;
   }
 
-sub _constant
+sub _binary_constant
+  {
+  # this takes a binary/hexadecimal/octal constant string and returns it
+  # as string suitable for new. Basically it converts octal to decimal, and
+  # passes every thing else unmodified back.
+  my $string = shift;
+
+  return Math::BigInt->new($string) if $string =~ /^0[bx]/;
+
+  # so it must be an octal constant
+  Math::BigInt->from_oct($string);
+  }
+
+sub _float_constant
   {
   # this takes a floating point constant string and returns it truncated to
   # integer. For instance, '4.5' => '4', '1.234e2' => '123' etc
@@ -94,7 +107,7 @@ sub _constant
     return $sign.$$miv.$$mfv.'E'.$ec;          # 123.45e+3 => 12345e1
     }
   $mfv = substr($$mfv,0,$ec);
-  return $sign.$$miv.$mfv;                     # 123.45e+1 => 1234
+  $sign.$$miv.$mfv;                            # 123.45e+1 => 1234
   }
 
 sub import 
@@ -102,7 +115,7 @@ sub import
   my $self = shift;
 
   # some defaults
-  my $lib = '';
+  my $lib = ''; my $lib_kind = 'try';
 
   my @import = ( ':constant' );                                # drive it w/ constant
   my @a = @_; my $l = scalar @_; my $j = 0;
@@ -110,9 +123,10 @@ sub import
   my ($a,$p);                                          # accuracy, precision
   for ( my $i = 0; $i < $l ; $i++,$j++ )
     {
-    if ($_[$i] =~ /^(l|lib)$/)
+    if ($_[$i] =~ /^(l|lib|try|only)$/)
       {
       # this causes a different low lib to take care...
+      $lib_kind = $1; $lib_kind = 'lib' if $lib_kind eq 'l';
       $lib = $_[$i+1] || '';
       my $s = 2; $s = 1 if @a-$j < 2;  # avoid "can not modify non-existant..."
       splice @a, $j, $s; $j -= $s; $i++;
@@ -163,7 +177,7 @@ sub import
     require Math::BigInt if $_lite == 0;       # not already loaded?
     $class = 'Math::BigInt';                   # regardless of MBIL or not
     }
-  push @import, 'lib' => $lib if $lib ne '';
+  push @import, $lib_kind => $lib if $lib ne '';
   # Math::BigInt::Trace or plain Math::BigInt
   $class->import(@import);
 
@@ -180,7 +194,9 @@ sub import
     }
   # we take care of floating point constants, since BigFloat isn't available
   # and BigInt doesn't like them:
-  overload::constant float => sub { Math::BigInt->new( _constant(shift) ); };
+  overload::constant float => sub { Math::BigInt->new( _float_constant(shift) ); };
+  # Take care of octal/hexadecimal constants
+  overload::constant binary => sub { _binary_constant(shift) };
 
   $self->export_to_level(1,$self,@a);           # export inf and NaN
   }
@@ -228,6 +244,8 @@ than or equal to zero. See Math::BigInt's bround() function for details.
 
        perl -Mbigint=a,2 -le 'print 12345+1'
 
+Note that setting precision and accurary at the same time is not possible.
+
 =item p or precision
 
 This sets the precision for all math operations. The argument can be any
@@ -240,19 +258,27 @@ See Math::BigInt's bfround() function for details.
 
        perl -Mbignum=p,5 -le 'print 123456789+123'
 
+Note that setting precision and accurary at the same time is not possible.
+
 =item t or trace
 
 This enables a trace mode and is primarily for debugging bigint or
 Math::BigInt.
 
-=item l or lib
+=item l, lib, try or only
 
-Load a different math lib, see L<MATH LIBRARY>.
+Load a different math lib, see L<Math Library>.
 
-       perl -Mbigint=l,GMP -e 'print 2 ** 512'
+       perl -Mbigint=lib,GMP -e 'print 2 ** 512'
+       perl -Mbigint=try,GMP -e 'print 2 ** 512'
+       perl -Mbigint=only,GMP -e 'print 2 ** 512'
 
 Currently there is no way to specify more than one library on the command
-line. This will be hopefully fixed soon ;)
+line. This means the following does not work:
+
+       perl -Mbignum=l,GMP,Pari -e 'print 2 ** 512'
+
+This will be hopefully fixed soon ;)
 
 =item v or version
 
@@ -260,6 +286,8 @@ This prints out the name and version of all modules used and then exits.
 
        perl -Mbigint=v
 
+=back
+
 =head2 Math Library
 
 Math with the numbers is done (by default) by a module called
@@ -269,13 +297,23 @@ Math::BigInt::Calc. This is equivalent to saying:
 
 You can change this by using:
 
-       use bigint lib => 'BitVect';
+       use bignum lib => 'GMP';
 
 The following would first try to find Math::BigInt::Foo, then
 Math::BigInt::Bar, and when this also fails, revert to Math::BigInt::Calc:
 
        use bigint lib => 'Foo,Math::BigInt::Bar';
 
+Using C<lib> warns if none of the specified libraries can be found and
+L<Math::BigInt> did fall back to one of the default libraries.
+To supress this warning, use C<try> instead:
+
+        use bignum try => 'GMP';
+
+If you want the code to die instead of falling back, use C<only> instead:
+
+        use bignum only => 'GMP';
+
 Please see respective module documentation for further details.
 
 =head2 Internal Format
@@ -306,6 +344,29 @@ Since all numbers are now objects, you can use all functions that are part of
 the BigInt API. You can only use the bxxx() notation, and not the fxxx()
 notation, though. 
 
+=over 2
+
+=item inf()
+
+A shortcut to return Math::BigInt->binf(). Useful because Perl does not always
+handle bareword C<inf> properly.
+
+=item NaN()
+
+A shortcut to return Math::BigInt->bnan(). Useful because Perl does not always
+handle bareword C<NaN> properly.
+
+=item upgrade()
+
+Return the class that numbers are upgraded to, is in fact returning
+C<$Math::BigInt::upgrade>.
+
+=back
+
+=head2 MATH LIBRARY
+
+Math with the numbers is done (by default) by a module called
+
 =head2 Caveat
 
 But a warning is in order. When using the following to make a copy of a number,
@@ -364,6 +425,7 @@ to compare them to the results under -Mbignum or -Mbigrat:
        perl -Mbigint -le 'print log(2)'
        perl -Mbigint -le 'print 2 ** 0.5'
        perl -Mbigint=a,65 -le 'print 2 ** 0.2'
+       perl -Mbignum=a,65,l,GMP -le 'print 7 ** 7777'
 
 =head1 LICENSE
 
@@ -380,6 +442,6 @@ as L<Math::BigInt::BitVect>, L<Math::BigInt::Pari> and  L<Math::BigInt::GMP>.
 
 =head1 AUTHORS
 
-(C) by Tels L<http://bloodgate.com/> in early 2002 - 2005.
+(C) by Tels L<http://bloodgate.com/> in early 2002 - 2007.
 
 =cut