File: bc.sgml

package info (click to toggle)
php3 1%3A3.0.5-3
  • links: PTS
  • area: main
  • in suites: slink
  • size: 8,348 kB
  • ctags: 9,086
  • sloc: ansic: 76,362; sh: 2,333; php: 1,329; yacc: 1,148; makefile: 970; perl: 763; cpp: 529; awk: 90; sql: 11
file content (233 lines) | stat: -rw-r--r-- 8,076 bytes parent folder | download
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
 <reference id="ref.bc">
  <title>BC (Arbitrary Precision) Functions</title>
  <titleabbrev>BC math</titleabbrev>

  <partintro>
  <simpara>
    These BC functions are only available if PHP was compiled with the
    --enable-bcmath configure option.
  </partintro>
  <refentry id="function.bcadd">
   <refnamediv>
    <refname>bcadd</refname>
    <refpurpose>Add two arbitrary precision numbers.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcdef>string <function>bcadd</function></funcdef>
     <paramdef>string <parameter>left operand</parameter></paramdef>
     <paramdef>string <parameter>right operand</parameter></paramdef>
     <paramdef>int <parameter><optional>scale</optional></parameter></paramdef>
    </funcsynopsis>

    <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>
    See also <function>bcsub</function>.
   </refsect1>
  </refentry>

  <refentry id="function.bccomp">
   <refnamediv>
    <refname>bccomp</refname>
    <refpurpose>Compare two arbitrary precision numbers.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcdef>int <function>bccomp</function></funcdef>
     <paramdef>string <parameter>left operand</parameter></paramdef>
     <paramdef>string <parameter>right operand</parameter></paramdef>
     <paramdef>int <parameter><optional>scale</optional></parameter></paramdef>
    </funcsynopsis>

    <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 comparion.  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.
   </refsect1>
  </refentry>

  <refentry id="function.bcdiv">
   <refnamediv>
    <refname>bcdiv</refname>
    <refpurpose>Divide two arbitrary precision numbers.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcdef>string <function>bcdiv</function></funcdef>
     <paramdef>string <parameter>left operand</parameter></paramdef>
     <paramdef>string <parameter>right operand</parameter></paramdef>
     <paramdef>int <parameter><optional>scale</optional></parameter></paramdef>
    </funcsynopsis>

    <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>
    See also <function>bcmul</function>.

   </refsect1>
  </refentry>

  <refentry id="function.bcmod">
   <refnamediv>
    <refname>bcmod</refname>
    <refpurpose>Get modulus of an arbitrary precision number.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcdef>string <function>bcmod</function></funcdef>
     <paramdef>string <parameter>left operand</parameter></paramdef>
     <paramdef>string <parameter>modulus</parameter></paramdef>
    </funcsynopsis>
    <para>
    Get the modulus of the <parameter>left operand</parameter> using
    <parameter>modulus</parameter>.  
    <para>
    See also <function>bcdiv</function>.
   </refsect1>
  </refentry>

  <refentry id="function.bcmul">
   <refnamediv>
    <refname>bcmul</refname>
    <refpurpose>Multiply two arbitrary precision number.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcdef>string <function>bcmul</function></funcdef>
     <paramdef>string <parameter>left operand</parameter></paramdef>
     <paramdef>string <parameter>right operand</parameter></paramdef>
     <paramdef>int <parameter><optional>scale</optional></parameter></paramdef>
    </funcsynopsis>
    <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>
    See also <function>bcdiv</function>.
   </refsect1>
  </refentry>

  <refentry id="function.bcpow">
   <refnamediv>
    <refname>bcpow</refname>
    <refpurpose>Raise an arbitrary precision number to another.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcdef>string <function>bcpow</function></funcdef>
     <paramdef>string <parameter>x</parameter></paramdef>
     <paramdef>string <parameter>y</parameter></paramdef>
     <paramdef>int <parameter><optional>scale</optional></parameter></paramdef>
    </funcsynopsis>
    <para>
    Raise <parameter>x</parameter> to the power <parameter>y</parameter>.
    The <parameter>scale</parameter> can be used to set the number of digits
    after the decimal place in the result.
    <para>
    See also <function>bcsqrt</function>.
   </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>
    <funcsynopsis>
     <funcdef>string <function>bcscale</function></funcdef>
     <paramdef>int <parameter>scale</parameter></paramdef>
    </funcsynopsis>
    <para>
    This function sets the default scale parameter for all subsequent bc math functions
    that do not explicitly specify a scale parameter.
   </refsect1>
  </refentry>

  <refentry id="function.bcsqrt">
   <refnamediv>
    <refname>bcsqrt</refname>
    <refpurpose>Get the square root of an arbitray precision number.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcdef>string <function>bcsqrt</function></funcdef>
     <paramdef>string <parameter>operand</parameter></paramdef>
     <paramdef>int <parameter>scale</parameter></paramdef>
    </funcsynopsis>
    <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>
    See also <function>bcpow</function>.
   </refsect1>
  </refentry>

  <refentry id="function.bcsub">
   <refnamediv>
    <refname>bcsub</refname>
    <refpurpose>Subtract one arbitrary precision number from another.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <funcsynopsis>
     <funcdef>string <function>bcsub</function></funcdef>
     <paramdef>string <parameter>left operand</parameter></paramdef>
     <paramdef>string <parameter>right operand</parameter></paramdef>
     <paramdef>int <parameter><optional>scale</optional></parameter></paramdef>
    </funcsynopsis>

    <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>
    See also <function>bcadd</function>.
   </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
sgml-parent-document:nil
sgml-default-dtd-file:"../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->