Debian Codegraph @

upstream/mageia-cauldron/man3pm/Math::BigInt::FastCalc.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Math::BigInt::FastCalc 3pm"
61 .TH Math::BigInt::FastCalc 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Math::BigInt::FastCalc \- Math::BigInt::Calc with some XS for more speed
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 2
71 \& # to use it with Math::BigInt
72 \& use Math::BigInt lib => \*(AqFastCalc\*(Aq;
73 \&
74 \& # to use it with Math::BigFloat
75 \& use Math::BigFloat lib => \*(AqFastCalc\*(Aq;
76 \&
77 \& # to use it with Math::BigRat
78 \& use Math::BigRat lib => \*(AqFastCalc\*(Aq;
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 Math::BigInt::FastCalc inherits from Math::BigInt::Calc.
83 .PP
84 Provides support for big integer calculations. Not intended to be used by
85 other modules. Other modules which sport the same functions can also be used
86 to support Math::BigInt, like Math::BigInt::GMP or Math::BigInt::Pari.
87 .PP
88 In order to allow for multiple big integer libraries, Math::BigInt was
89 rewritten to use library modules for core math routines. Any module which
90 follows the same API as this can be used instead by using the following:
91 .PP
92 .Vb 1
93 \& use Math::BigInt lib => \*(Aqlibname\*(Aq;
94 .Ve
95 .PP
96 \&\*(Aqlibname\*(Aq is either the long name (\*(AqMath::BigInt::Pari\*(Aq), or only the short
97 version like \*(AqPari\*(Aq. To use this library:
98 .PP
99 .Vb 1
100 \& use Math::BigInt lib => \*(AqFastCalc\*(Aq;
101 .Ve
102 .PP
103 The default behaviour is to chose the best internal representation of big
104 integers, but the base length used in the internal representation can be
105 specified explicitly. Note that this must be done before Math::BigInt is loaded.
106 For example,
107 .PP
108 .Vb 2
109 \& use Math::BigInt::FastCalc base_len => 3;
110 \& use Math::BigInt lib => \*(AqFastCalc\*(Aq;
111 .Ve
112 .SH STORAGE
113 .IX Header "STORAGE"
114 Math::BigInt::FastCalc works exactly like Math::BigInt::Calc. Numbers are
115 stored in decimal form chopped into parts.
116 .SH METHODS
117 .IX Header "METHODS"
118 The following functions are now implemented in FastCalc.xs:
119 .PP
120 .Vb 6
121 \& _is_odd _is_even _is_one _is_zero
122 \& _is_two _is_ten
123 \& _zero _one _two _ten
124 \& _acmp _len
125 \& _inc _dec
126 \& _\|_strip_zeros _copy
127 .Ve
128 .SH BUGS
129 .IX Header "BUGS"
130 Please report any bugs or feature requests to
131 \&\f(CW\*(C`bug\-math\-bigint\-fastcalc at rt.cpan.org\*(C'\fR, or through the web interface at
132 <https://rt.cpan.org/Ticket/Create.html?Queue=Math\-BigInt\-FastCalc>
133 (requires login). We will be notified, and then you\*(Aqll automatically be
134 notified of progress on your bug as I make changes.
135 .SH SUPPORT
136 .IX Header "SUPPORT"
137 After installing, you can find documentation for this module with the perldoc
138 command.
139 .PP
140 .Vb 1
141 \& perldoc Math::BigInt::FastCalc
142 .Ve
143 .PP
144 You can also look for information at:
145 .IP GitHub 4
146 .IX Item "GitHub"
147 <https://github.com/pjacklam/p5\-Math\-BigInt\-FastCalc>
148 .IP "RT: CPAN\*(Aqs request tracker" 4
149 .IX Item "RT: CPAN's request tracker"
150 <https://rt.cpan.org/Dist/Display.html?Name=Math\-BigInt\-FastCalc>
151 .IP MetaCPAN 4
152 .IX Item "MetaCPAN"
153 <https://metacpan.org/release/Math\-BigInt\-FastCalc>
154 .IP "CPAN Testers Matrix" 4
155 .IX Item "CPAN Testers Matrix"
156 <http://matrix.cpantesters.org/?dist=Math\-BigInt\-FastCalc>
157 .SH LICENSE
158 .IX Header "LICENSE"
159 This program is free software; you may redistribute it and/or modify it under
160 the same terms as Perl itself.
161 .SH AUTHORS
162 .IX Header "AUTHORS"
163 Original math code by Mark Biggar, rewritten by Tels <http://bloodgate.com/>
164 in late 2000.
165 .PP
166 Separated from Math::BigInt and shaped API with the help of John Peacock.
167 .PP
168 Fixed, sped\-up and enhanced by Tels http://bloodgate.com 2001\-2003.
169 Further streamlining (api_version 1 etc.) by Tels 2004\-2007.
170 .PP
171 Maintained by Peter John Acklam <[email protected]> 2010\-2021.
172 .SH "SEE ALSO"
173 .IX Header "SEE ALSO"
174 Math::BigInt::Lib for a description of the API.
175 .PP
176 Alternative libraries Math::BigInt::Calc, Math::BigInt::GMP, and
177 Math::BigInt::Pari.
178 .PP
179 Some of the modules that use these libraries Math::BigInt,
180 Math::BigFloat, and Math::BigRat.