Debian Codegraph @

upstream/debian-unstable/man3/Math::BigInt::Calc.3perl

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