Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Math::BigInt::Calc.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::Calc 3pm"
61 .TH Math::BigInt::Calc 3pm 2026-03-09 "perl v5.42.1" "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::Calc \- pure Perl module to support Math::BigInt
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 2
71 \& # to use it with Math::BigInt
72 \& use Math::BigInt lib => \*(AqCalc\*(Aq;
73 \&
74 \& # to use it with Math::BigFloat
75 \& use Math::BigFloat lib => \*(AqCalc\*(Aq;
76 \&
77 \& # to use it with Math::BigRat
78 \& use Math::BigRat lib => \*(AqCalc\*(Aq;
79 \&
80 \& # explicitly set base length and whether to "use integer"
81 \& use Math::BigInt::Calc base_len => 4, use_int => 1;
82 \& use Math::BigInt lib => \*(AqCalc\*(Aq;
83 .Ve
84 .SH DESCRIPTION
85 .IX Header "DESCRIPTION"
86 Math::BigInt::Calc inherits from Math::BigInt::Lib.
87 .PP
88 In this library, the numbers are represented interenally in base B = 10**N,
89 where N is the largest possible integer that does not cause overflow in the
90 intermediate computations. The base B elements are stored in an array, with the
91 least significant element stored in array element zero. There are no leading
92 zero elements, except a single zero element when the number is zero. For
93 instance, if B = 10000, the number 1234567890 is represented internally as
94 [7890, 3456, 12].
95 .SH OPTIONS
96 .IX Header "OPTIONS"
97 When the module is loaded, it computes the maximum exponent, i.e., power of 10,
98 that can be used with and without "use integer" in the computations. The default
99 is to use this maximum exponent. If the combination of the \*(Aqbase_len\*(Aq value and
100 the \*(Aquse_int\*(Aq value exceeds the maximum value, an error is thrown.
101 .IP base_len 4
102 .IX Item "base_len"
103 The base length can be specified explicitly with the \*(Aqbase_len\*(Aq option. The
104 value must be a positive integer.
105 .Sp
106 .Vb 1
107 \& use Math::BigInt::Calc base_len => 4; # use 10000 as internal base
108 .Ve
109 .IP use_int 4
110 .IX Item "use_int"
111 This option is used to specify whether "use integer" should be used in the
112 internal computations. The value is interpreted as a boolean value, so use 0 or
113 "" for false and anything else for true. If the \*(Aqbase_len\*(Aq is not specified
114 together with \*(Aquse_int\*(Aq, the current value for the base length is used.
115 .Sp
116 .Vb 1
117 \& use Math::BigInt::Calc use_int => 1; # use "use integer" internally
118 .Ve
119 .SH METHODS
120 .IX Header "METHODS"
121 This overview constains only the methods that are specific to
122 \&\f(CW\*(C`Math::BigInt::Calc\*(C'\fR. For the other methods, see Math::BigInt::Lib.
123 .IP \fB_base_len()\fR 4
124 .IX Item "_base_len()"
125 Specify the desired base length and whether to enable "use integer" in the
126 computations.
127 .Sp
128 .Vb 1
129 \& Math::BigInt::Calc \-> _base_len($base_len, $use_int);
130 .Ve
131 .Sp
132 Note that it is better to specify the base length and whether to use integers as
133 options when the module is loaded, for example like this
134 .Sp
135 .Vb 1
136 \& use Math::BigInt::Calc base_len => 6, use_int => 1;
137 .Ve
138 .SH "SEE ALSO"
139 .IX Header "SEE ALSO"
140 Math::BigInt::Lib for a description of the API.
141 .PP
142 Alternative libraries Math::BigInt::FastCalc, Math::BigInt::GMP,
143 Math::BigInt::Pari, Math::BigInt::GMPz, and Math::BigInt::BitVect.
144 .PP
145 Some of the modules that use these libraries Math::BigInt,
146 Math::BigFloat, and Math::BigRat.