| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "Math::BigInt::FastCalc 3perl" |
| 58 |
.TH Math::BigInt::FastCalc 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide" |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
Math::BigInt::FastCalc \- Math::BigInt::Calc with some XS for more speed |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
.Vb 2 |
| 68 |
\& # to use it with Math::BigInt |
| 69 |
\& use Math::BigInt lib => \*(AqFastCalc\*(Aq; |
| 70 |
\& |
| 71 |
\& # to use it with Math::BigFloat |
| 72 |
\& use Math::BigFloat lib => \*(AqFastCalc\*(Aq; |
| 73 |
\& |
| 74 |
\& # to use it with Math::BigRat |
| 75 |
\& use Math::BigRat lib => \*(AqFastCalc\*(Aq; |
| 76 |
.Ve |
| 77 |
.SH DESCRIPTION |
| 78 |
.IX Header "DESCRIPTION" |
| 79 |
Math::BigInt::FastCalc inherits from Math::BigInt::Calc. |
| 80 |
.PP |
| 81 |
Provides support for big integer calculations. Not intended to be used by |
| 82 |
other modules. Other modules which sport the same functions can also be used |
| 83 |
to support Math::BigInt, like Math::BigInt::GMP or Math::BigInt::Pari. |
| 84 |
.PP |
| 85 |
In order to allow for multiple big integer libraries, Math::BigInt was |
| 86 |
rewritten to use library modules for core math routines. Any module which |
| 87 |
follows the same API as this can be used instead by using the following: |
| 88 |
.PP |
| 89 |
.Vb 1 |
| 90 |
\& use Math::BigInt lib => \*(Aqlibname\*(Aq; |
| 91 |
.Ve |
| 92 |
.PP |
| 93 |
\&'libname' is either the long name ('Math::BigInt::Pari'), or only the short |
| 94 |
version like 'Pari'. To use this library: |
| 95 |
.PP |
| 96 |
.Vb 1 |
| 97 |
\& use Math::BigInt lib => \*(AqFastCalc\*(Aq; |
| 98 |
.Ve |
| 99 |
.PP |
| 100 |
The default behaviour is to chose the best internal representation of big |
| 101 |
integers, but the base length used in the internal representation can be |
| 102 |
specified explicitly. Note that this must be done before Math::BigInt is loaded. |
| 103 |
For example, |
| 104 |
.PP |
| 105 |
.Vb 2 |
| 106 |
\& use Math::BigInt::FastCalc base_len => 3; |
| 107 |
\& use Math::BigInt lib => \*(AqFastCalc\*(Aq; |
| 108 |
.Ve |
| 109 |
.SH STORAGE |
| 110 |
.IX Header "STORAGE" |
| 111 |
Math::BigInt::FastCalc works exactly like Math::BigInt::Calc. Numbers are |
| 112 |
stored in decimal form chopped into parts. |
| 113 |
.SH METHODS |
| 114 |
.IX Header "METHODS" |
| 115 |
The following functions are now implemented in FastCalc.xs: |
| 116 |
.PP |
| 117 |
.Vb 6 |
| 118 |
\& _is_odd _is_even _is_one _is_zero |
| 119 |
\& _is_two _is_ten |
| 120 |
\& _zero _one _two _ten |
| 121 |
\& _acmp _len |
| 122 |
\& _inc _dec |
| 123 |
\& _\|_strip_zeros _copy |
| 124 |
.Ve |
| 125 |
.SH BUGS |
| 126 |
.IX Header "BUGS" |
| 127 |
Please report any bugs or feature requests to |
| 128 |
\&\f(CW\*(C`bug\-math\-bigint\-fastcalc at rt.cpan.org\*(C'\fR, or through the web interface at |
| 129 |
<https://rt.cpan.org/Ticket/Create.html?Queue=Math\-BigInt\-FastCalc> |
| 130 |
(requires login). We will be notified, and then you'll automatically be |
| 131 |
notified of progress on your bug as I make changes. |
| 132 |
.SH SUPPORT |
| 133 |
.IX Header "SUPPORT" |
| 134 |
After installing, you can find documentation for this module with the perldoc |
| 135 |
command. |
| 136 |
.PP |
| 137 |
.Vb 1 |
| 138 |
\& perldoc Math::BigInt::FastCalc |
| 139 |
.Ve |
| 140 |
.PP |
| 141 |
You can also look for information at: |
| 142 |
.IP GitHub 4 |
| 143 |
.IX Item "GitHub" |
| 144 |
<https://github.com/pjacklam/p5\-Math\-BigInt\-FastCalc> |
| 145 |
.IP "RT: CPAN's request tracker" 4 |
| 146 |
.IX Item "RT: CPAN's request tracker" |
| 147 |
<https://rt.cpan.org/Dist/Display.html?Name=Math\-BigInt\-FastCalc> |
| 148 |
.IP MetaCPAN 4 |
| 149 |
.IX Item "MetaCPAN" |
| 150 |
<https://metacpan.org/release/Math\-BigInt\-FastCalc> |
| 151 |
.IP "CPAN Testers Matrix" 4 |
| 152 |
.IX Item "CPAN Testers Matrix" |
| 153 |
<http://matrix.cpantesters.org/?dist=Math\-BigInt\-FastCalc> |
| 154 |
.SH LICENSE |
| 155 |
.IX Header "LICENSE" |
| 156 |
This program is free software; you may redistribute it and/or modify it under |
| 157 |
the same terms as Perl itself. |
| 158 |
.SH AUTHORS |
| 159 |
.IX Header "AUTHORS" |
| 160 |
Original math code by Mark Biggar, rewritten by Tels <http://bloodgate.com/> |
| 161 |
in late 2000. |
| 162 |
.PP |
| 163 |
Separated from Math::BigInt and shaped API with the help of John Peacock. |
| 164 |
.PP |
| 165 |
Fixed, sped-up and enhanced by Tels http://bloodgate.com 2001\-2003. |
| 166 |
Further streamlining (api_version 1 etc.) by Tels 2004\-2007. |
| 167 |
.PP |
| 168 |
Maintained by Peter John Acklam <[email protected]> 2010\-2021. |
| 169 |
.SH "SEE ALSO" |
| 170 |
.IX Header "SEE ALSO" |
| 171 |
Math::BigInt::Lib for a description of the API. |
| 172 |
.PP |
| 173 |
Alternative libraries Math::BigInt::Calc, Math::BigInt::GMP, and |
| 174 |
Math::BigInt::Pari. |
| 175 |
.PP |
| 176 |
Some of the modules that use these libraries Math::BigInt, |
| 177 |
Math::BigFloat, and Math::BigRat. |