summaryrefslogtreecommitdiff
path: root/lib/integer.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/integer.pm')
-rw-r--r--lib/integer.pm21
1 files changed, 21 insertions, 0 deletions
diff --git a/lib/integer.pm b/lib/integer.pm
index 74039bb962..a88ce6a77c 100644
--- a/lib/integer.pm
+++ b/lib/integer.pm
@@ -1,5 +1,26 @@
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 that it's okay 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.
+
+See L<perlmod/Pragmatic Modules>.
+
+=cut
+
sub import {
$^H |= 1;
}