X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2Finteger.pm;h=f6be58a0eb78be4a8727c77abee35a896854ccf0;hb=767440f46f463f51b4463f7f2470eafa206b1367;hp=74039bb9626b2d1709c7019c032d3ae4f6bda9c9;hpb=a0d0e21ea6ea90a22318550944fe6cb09ae10cda;p=p5sagit%2Fp5-mst-13.2.git

diff --git a/lib/integer.pm b/lib/integer.pm
index 74039bb..f6be58a 100644
--- a/lib/integer.pm
+++ b/lib/integer.pm
@@ -1,5 +1,48 @@
 package integer;
 
+=head1 NAME
+
+integer - Perl pragma to compute arithmetic in integer instead of double
+
+=head1 SYNOPSIS
+
+    use integer;
+    $x = 10/3;
+    # $x is now 3, not 3.33333333333333333
+
+=head1 DESCRIPTION
+
+This tells the compiler to use integer operations
+from here to the end of the enclosing BLOCK.  On many machines, 
+this doesn't matter a great deal for most computations, but on those 
+without floating point hardware, it can make a big difference.
+
+Note that this affects the operations, not the numbers.  If you run this
+code
+
+    use integer;
+    $x = 1.5;
+    $y = $x + 1;
+    $z = -1.5;
+
+you'll be left with C<$x == 1.5>, C<$y == 2> and C<$z == -1>.  The $z
+case happens because unary C<-> counts as an operation.
+
+Native integer arithmetic (as provided by your C compiler) is used.
+This means that Perl's own semantics for arithmetic operations may
+not be preserved.  One common source of trouble is the modulus of
+negative numbers, which Perl does one way, but your hardware may do
+another.
+
+  % perl -le 'print (4 % -3)'
+  -2
+  % perl -Minteger -le 'print (4 % -3)'
+  1
+
+See L<perlmod/Pragmatic Modules>.
+
+=cut
+
 sub import {
     $^H |= 1;
 }