Skip to content

gmp: document the ValueErrors for negative and out of range arguments #6006

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lacatoire merged 4 commits into from
Oct 24, 2026
Merged

gmp: document the ValueErrors for negative and out of range arguments #6006

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4dc4d31
gmp: document the ValueErrors for negative and out of range arguments
qodelicious Oct 22, 2026
5b39c28
Say the too large case is new in PHP 8.5.0
qodelicious Oct 23, 2026
eee4b56
Apply suggestion from @lacatoire
lacatoire Oct 24, 2026
dce1037
gmp_powm(): use simpara and fix the description sentence
lacatoire Oct 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions reference/gmp/functions/gmp-clrbit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,16 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Throws a <exceptionname>ValueError</exceptionname> if <parameter>index</parameter> is negative or, as of PHP 8.5.0, too large.
</simpara>
<simpara>
Prior to PHP 8.0.0, an <constant>E_WARNING</constant> was raised instead.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
Expand Down
10 changes: 10 additions & 0 deletions reference/gmp/functions/gmp-fact.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,16 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Throws a <exceptionname>ValueError</exceptionname> if <parameter>num</parameter> is negative.
</simpara>
<simpara>
Prior to PHP 8.0.0, an <constant>E_WARNING</constant> was raised instead.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<para>
Expand Down
12 changes: 10 additions & 2 deletions reference/gmp/functions/gmp-pow.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,16 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Throws a <exceptionname>ValueError</exceptionname> if <parameter>exponent</parameter> is negative.
</simpara>
<simpara>
Prior to PHP 8.0.0, an <constant>E_WARNING</constant> was raised instead.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<para>
Expand All @@ -63,8 +73,6 @@ $pow1 = gmp_pow("2", 31);
echo gmp_strval($pow1) . "\n";
$pow2 = gmp_pow("0", 0);
echo gmp_strval($pow2) . "\n";
$pow3 = gmp_pow("2", -1); // Negative exp, generates warning
echo gmp_strval($pow3) . "\n";
?>
]]>
</programlisting>
Expand Down
21 changes: 17 additions & 4 deletions reference/gmp/functions/gmp-powm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,10 @@
<methodparam><type class="union"><type>GMP</type><type>int</type><type>string</type></type><parameter>exponent</parameter></methodparam>
<methodparam><type class="union"><type>GMP</type><type>int</type><type>string</type></type><parameter>modulus</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
Calculate (<parameter>num</parameter> raised into power
<parameter>exponent</parameter>) modulo <parameter>modulus</parameter>. If
<parameter>exponent</parameter> is negative, result is undefined.
</para>
<parameter>exponent</parameter>) modulo <parameter>modulus</parameter>.
</simpara>
</refsect1>


Expand Down Expand Up @@ -64,6 +63,20 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Throws a <exceptionname>ValueError</exceptionname> if <parameter>exponent</parameter> is negative.
</simpara>
<simpara>
Throws a <exceptionname>DivisionByZeroError</exceptionname> if <parameter>modulus</parameter>
is <literal>0</literal>.
</simpara>
<simpara>
Prior to PHP 8.0.0, an <constant>E_WARNING</constant> was raised instead.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<para>
Expand Down
11 changes: 11 additions & 0 deletions reference/gmp/functions/gmp-root.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,17 @@
The integer component of the resultant root, as a GMP number.
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Throws a <exceptionname>ValueError</exceptionname> if <parameter>nth</parameter> is less than <literal>1</literal>,
or if <parameter>nth</parameter> is even and <parameter>num</parameter> is negative.
</simpara>
<simpara>
Prior to PHP 8.0.0, an <constant>E_WARNING</constant> was raised instead.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down
11 changes: 11 additions & 0 deletions reference/gmp/functions/gmp-rootrem.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,17 @@
numbers.
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Throws a <exceptionname>ValueError</exceptionname> if <parameter>nth</parameter> is less than <literal>1</literal>,
or if <parameter>nth</parameter> is even and <parameter>num</parameter> is negative.
</simpara>
<simpara>
Prior to PHP 8.0.0, an <constant>E_WARNING</constant> was raised instead.
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down
10 changes: 10 additions & 0 deletions reference/gmp/functions/gmp-scan0.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,16 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Throws a <exceptionname>ValueError</exceptionname> if <parameter>start</parameter> is negative or, as of PHP 8.5.0, too large.
</simpara>
<simpara>
Prior to PHP 8.0.0, an <constant>E_WARNING</constant> was raised instead.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<para>
Expand Down
10 changes: 10 additions & 0 deletions reference/gmp/functions/gmp-scan1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,16 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Throws a <exceptionname>ValueError</exceptionname> if <parameter>start</parameter> is negative or, as of PHP 8.5.0, too large.
</simpara>
<simpara>
Prior to PHP 8.0.0, an <constant>E_WARNING</constant> was raised instead.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<para>
Expand Down
10 changes: 10 additions & 0 deletions reference/gmp/functions/gmp-setbit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,16 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Throws a <exceptionname>ValueError</exceptionname> if <parameter>index</parameter> is negative or too large.
</simpara>
<simpara>
Prior to PHP 8.0.0, an <constant>E_WARNING</constant> was raised instead.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<para>
Expand Down
10 changes: 10 additions & 0 deletions reference/gmp/functions/gmp-sqrt.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,16 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Throws a <exceptionname>ValueError</exceptionname> if <parameter>num</parameter> is negative.
</simpara>
<simpara>
Prior to PHP 8.0.0, an <constant>E_WARNING</constant> was raised instead.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<para>
Expand Down
10 changes: 10 additions & 0 deletions reference/gmp/functions/gmp-sqrtrem.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,16 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Throws a <exceptionname>ValueError</exceptionname> if <parameter>num</parameter> is negative.
</simpara>
<simpara>
Prior to PHP 8.0.0, an <constant>E_WARNING</constant> was raised instead.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<para>
Expand Down
11 changes: 11 additions & 0 deletions reference/gmp/functions/gmp-strval.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,17 @@
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simpara>
Throws a <exceptionname>ValueError</exceptionname> if <parameter>base</parameter> is not between
<literal>2</literal> and <literal>62</literal>, or <literal>-2</literal> and <literal>-36</literal>.
</simpara>
<simpara>
Prior to PHP 8.0.0, an <constant>E_WARNING</constant> was raised instead.
</simpara>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<para>
Expand Down
11 changes: 6 additions & 5 deletions reference/gmp/functions/gmp-testbit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,12 @@

<refsect1 role="errors">
&reftitle.errors;
<para>
An <constant>E_WARNING</constant> level error is issued when
<parameter>index</parameter> is less than zero, and &false;
is returned.
</para>
<simpara>
Throws a <exceptionname>ValueError</exceptionname> if <parameter>index</parameter> is negative or, as of PHP 8.5.0, too large.
</simpara>
<simpara>
Prior to PHP 8.0.0, an <constant>E_WARNING</constant> was raised and &false; was returned instead.
</simpara>
</refsect1>

<refsect1 role="examples">
Expand Down
Loading