1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.22 $ -->
<reference id="ref.bc">
<title>BCMath Arbitrary Precision Mathematics Functions</title>
<titleabbrev>BC math</titleabbrev>
<partintro>
<para>
For arbitrary precision mathematics PHP offers the Binary Calculator which
supports numbers of any size and precision, represented as strings.
</para>
<para>
In PHP 4, these functions are only available if PHP was configured with
<link linkend="install.configure.enable-bcmath"><option role="configure">--enable-bcmath</option></link>.
In PHP 3, these functions are only available if PHP was not configured with
<link linkend="install.configure.disable-bcmath"><option role="configure">--disable-bcmath</option></link>.
</para>
<note>
<para>
Due to changes in the licensing, the BCMATH library is distributed
separate from the standard PHP source distribution.
You can download the tar-gzipped archive at the url:
<ulink url="&url.bcmath;">&url.bcmath;</ulink>. Read the
file <filename>README.BCMATH</filename> in the PHP distribution
for more information.
</para>
</note>
</partintro>
<refentry id="function.bcadd">
<refnamediv>
<refname>bcadd</refname>
<refpurpose>Add two arbitrary precision numbers</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>bcadd</methodname>
<methodparam><type>string</type><parameter>left_operand</parameter></methodparam>
<methodparam><type>string</type><parameter>right_operand</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam>
</methodsynopsis>
<para>
Adds the <parameter>left_operand</parameter> to the
<parameter>right_operand</parameter> and returns the sum in a
string. The optional <parameter>scale</parameter> parameter is
used to set the number of digits after the decimal place in the
result.
</para>
<para>
See also <function>bcsub</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.bccomp">
<refnamediv>
<refname>bccomp</refname>
<refpurpose>Compare two arbitrary precision numbers</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>bccomp</methodname>
<methodparam><type>string</type><parameter>left_operand</parameter></methodparam>
<methodparam><type>string</type><parameter>right_operand</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam>
</methodsynopsis>
<para>
Compares the <parameter>left_operand</parameter> to the
<parameter>right_operand</parameter> and returns the result as an
integer. The optional <parameter>scale</parameter> parameter is
used to set the number of digits after the decimal place which
will be used in the comparison. The return value is 0 if the two
operands are equal. If the <parameter>left_operand</parameter>
is larger than the <parameter>right_operand</parameter> the
return value is +1 and if the <parameter>left_operand</parameter>
is less than the <parameter>right_operand</parameter> the return
value is -1.
</para>
</refsect1>
</refentry>
<refentry id="function.bcdiv">
<refnamediv>
<refname>bcdiv</refname>
<refpurpose>Divide two arbitrary precision numbers</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>bcdiv</methodname>
<methodparam><type>string</type><parameter>left_operand</parameter></methodparam>
<methodparam><type>string</type><parameter>right_operand</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam>
</methodsynopsis>
<para>
Divides the <parameter>left_operand</parameter> by the
<parameter>right_operand</parameter> and returns the result. The
optional <parameter>scale</parameter> sets the number of digits
after the decimal place in the result.
</para>
<para>
See also <function>bcmul</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.bcmod">
<refnamediv>
<refname>bcmod</refname>
<refpurpose>
Get modulus of an arbitrary precision number
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>bcmod</methodname>
<methodparam><type>string</type><parameter>left_operand</parameter></methodparam>
<methodparam><type>string</type><parameter>modulus</parameter></methodparam>
</methodsynopsis>
<para>
Get the modulus of the <parameter>left_operand</parameter> using
<parameter>modulus</parameter>.
</para>
<para>
See also <function>bcdiv</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.bcmul">
<refnamediv>
<refname>bcmul</refname>
<refpurpose>Multiply two arbitrary precision number</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>bcmul</methodname>
<methodparam><type>string</type><parameter>left_operand</parameter></methodparam>
<methodparam><type>string</type><parameter>right_operand</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam>
</methodsynopsis>
<para>
Multiply the <parameter>left_operand</parameter> by the
<parameter>right_operand</parameter> and returns the result. The
optional <parameter>scale</parameter> sets the number of digits
after the decimal place in the result.
</para>
<para>
See also <function>bcdiv</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.bcpow">
<refnamediv>
<refname>bcpow</refname>
<refpurpose>
Raise an arbitrary precision number to another
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>bcpow</methodname>
<methodparam><type>string</type><parameter>x</parameter></methodparam>
<methodparam><type>string</type><parameter>y</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam>
</methodsynopsis>
<para>
Raise <parameter>x</parameter> to the power
<parameter>y</parameter>. The optional
<parameter>scale</parameter> can be used to set the number of
digits after the decimal place in the result.
</para>
<para>
See also <function>bcsqrt</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.bcscale">
<refnamediv>
<refname>bcscale</refname>
<refpurpose>
Set default scale parameter for all bc math functions
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>bcscale</methodname>
<methodparam><type>int</type><parameter>scale</parameter></methodparam>
</methodsynopsis>
<para>
This function sets the default scale parameter for all subsequent
bc math functions that do not explicitly specify a scale
parameter.
</para>
</refsect1>
</refentry>
<refentry id="function.bcsqrt">
<refnamediv>
<refname>bcsqrt</refname>
<refpurpose>
Get the square root of an arbitrary precision number
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>bcsqrt</methodname>
<methodparam><type>string</type><parameter>operand</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam>
</methodsynopsis>
<para>
Return the square root of the <parameter>operand</parameter>.
The optional <parameter>scale</parameter> parameter sets the
number of digits after the decimal place in the result.
</para>
<para>
See also <function>bcpow</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.bcsub">
<refnamediv>
<refname>bcsub</refname>
<refpurpose>
Subtract one arbitrary precision number from another
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>bcsub</methodname>
<methodparam><type>string</type><parameter>left_operand</parameter></methodparam>
<methodparam><type>string</type><parameter>right_operand</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>scale</parameter></methodparam>
</methodsynopsis>
<para>
Subtracts the <parameter>right_operand</parameter> from the
<parameter>left_operand</parameter> and returns the result in a
string. The optional <parameter>scale</parameter> parameter is
used to set the number of digits after the decimal place in the
result.
</para>
<para>
See also <function>bcadd</function>.
</para>
</refsect1>
</refentry>
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
