sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve documentation of bcpow() and bcpowmod()

Browse source 
We clarify the meaning of $left_operand and $right_operand,
and also document the supported values.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343026 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Christoph Michael Becker 2017-09-09 12:29:42 +00:00
parent 5d5a8ef9cb
commit f922f1a7e5
2 changed files with 20 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
reference/bc/functions/bcpow.xml
View file

@ -10,13 +10,13 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>bcpow</methodname>
<methodparam><type>string</type><parameter>left_operand</parameter></methodparam>
<methodparam><type>string</type><parameter>right_operand</parameter></methodparam>
<methodparam><type>string</type><parameter>base</parameter></methodparam>
<methodparam><type>string</type><parameter>exponent</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>scale</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Raise <parameter>left_operand</parameter> to the power
<parameter>right_operand</parameter>.
Raise <parameter>base</parameter> to the power
<parameter>exponent</parameter>.
</para>
</refsect1>
@ -25,18 +25,20 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>left_operand</parameter></term>
<term><parameter>base</parameter></term>
<listitem>
<para>
The left operand, as a string.
The base, as a string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right_operand</parameter></term>
<term><parameter>exponent</parameter></term>
<listitem>
<para>
The right operand, as a string.
The exponent, as a string. If the exponent is non-integral, it is truncated.
The valid range of the exponent is platform specific, but is at least
<literal>-2147483648</literal> to <literal>2147483647</literal>.
</para>
</listitem>
</varlistentry>

20
reference/bc/functions/bcpowmod.xml
View file

@ -10,15 +10,15 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>bcpowmod</methodname>
<methodparam><type>string</type><parameter>left_operand</parameter></methodparam>
<methodparam><type>string</type><parameter>right_operand</parameter></methodparam>
<methodparam><type>string</type><parameter>base</parameter></methodparam>
<methodparam><type>string</type><parameter>exponent</parameter></methodparam>
<methodparam><type>string</type><parameter>modulus</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>scale</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Use the fast-exponentiation method to raise
<parameter>left_operand</parameter> to the power
<parameter>right_operand</parameter> with respect to the modulus
<parameter>base</parameter> to the power
<parameter>exponent</parameter> with respect to the modulus
<parameter>modulus</parameter>.
</para>
</refsect1>
@ -28,18 +28,18 @@
<para>
<variablelist>
<varlistentry>
<term><parameter>left_operand</parameter></term>
<term><parameter>base</parameter></term>
<listitem>
<para>
The left operand, as a string.
The base, as an integral string (i.e. the scale has to be zero).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>right_operand</parameter></term>
<term><parameter>exponent</parameter></term>
<listitem>
<para>
The right operand, as a string.
The exponent, as an non-negative, integral string (i.e. the scale has to be zero).
</para>
</listitem>
</varlistentry>
@ -47,7 +47,7 @@
<term><parameter>modulus</parameter></term>
<listitem>
<para>
The modulus, as a string.
The modulus, as an integral string (i.e. the scale has to be zero).
</para>
</listitem>
</varlistentry>
@ -60,7 +60,7 @@
&reftitle.returnvalues;
<para>
Returns the result as a string, or &null; if <parameter>modulus</parameter>
is 0.
is <literal>0</literal> or <parameter>exponent</parameter> is negative.
</para>
</refsect1>