ext/bcmath: BcMath\Number class
#4187
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
a75b307 to
f50378d
Compare
f50378d to
3a9547b
Compare
Girgias
requested changes
Nov 29, 2024
Co-authored-by: Gina Peter Banyard <girgias@php.net>
Co-authored-by: Gina Peter Banyard <girgias@php.net>
Co-authored-by: Gina Peter Banyard <girgias@php.net>
Co-authored-by: Gina Peter Banyard <girgias@php.net>
Co-authored-by: Gina Peter Banyard <girgias@php.net>
Co-authored-by: Gina Peter Banyard <girgias@php.net>
Co-authored-by: Gina Peter Banyard <girgias@php.net>
|
@Girgias |
|
Hmm. I don't understand why CI turns red... edit: |
c919793 to
6899586
Compare
Girgias
reviewed
Dec 10, 2024
Comment on lines
+2158
to
+2161
| <!ENTITY bc.number.scale.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term> | ||
| <parameter>scale</parameter></term><listitem><simpara><parameter>scale</parameter> explicitly | ||
| specified for calculation results. If &null;, the <parameter>scale</parameter> of the calculation | ||
| result will be set automatically.</simpara></listitem></varlistentry>'> |
There was a problem hiding this comment.
No need to put this on a single line.
Suggested change
| <!ENTITY bc.number.scale.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term> | |
| <parameter>scale</parameter></term><listitem><simpara><parameter>scale</parameter> explicitly | |
| specified for calculation results. If &null;, the <parameter>scale</parameter> of the calculation | |
| result will be set automatically.</simpara></listitem></varlistentry>'> | |
| <!ENTITY bc.number.scale.description '<varlistentry xmlns="http://docbook.org/ns/docbook"> | |
| <term> | |
| <parameter>scale</parameter> | |
| </term> | |
| <listitem> | |
| <simpara> | |
| <parameter>scale</parameter> explicitly specified for calculation results. | |
| If &null;, the <parameter>scale</parameter> of the calculation result will be set automatically. | |
| </simpara> | |
| </listitem> | |
| </varlistentry>'> |
Comment on lines
+20
to
+21
| This class is not affected by <link linkend="ini.bcmath.scale">bcmath.scale</link> | ||
| in &php.ini;. |
There was a problem hiding this comment.
Suggested change
| This class is not affected by <link linkend="ini.bcmath.scale">bcmath.scale</link> | |
| in &php.ini;. | |
| This class is not affected by the | |
| <link linkend="ini.bcmath.scale">bcmath.scale</link> | |
| INI directive set in &php.ini;. |
| <note> | ||
| <simpara> | ||
| The behavior of an overloaded operator is the same as specifying &null; for the | ||
| <parameter>scale</parameter> parameter in the corresponding method. |
There was a problem hiding this comment.
Suggested change
| <parameter>scale</parameter> parameter in the corresponding method. | |
| <parameter>scale</parameter> parameter on the corresponding method. |
Comment on lines
+86
to
+87
| For objects resulting from calculations, this value is set automatically unless explicitly | ||
| specify the <parameter>scale</parameter> parameter in the calculation method. |
There was a problem hiding this comment.
Suggested change
| For objects resulting from calculations, this value is set automatically unless explicitly | |
| specify the <parameter>scale</parameter> parameter in the calculation method. | |
| For objects resulting from calculations, this value is automatically computed and set, | |
| unless the <parameter>scale</parameter> parameter was set in the calculation method. |
| </methodsynopsis> | ||
| <simpara> | ||
| Compare two arbitrary precision numbers. | ||
| This method behaves similar to the spaceship operator. |
Comment on lines
+56
to
+57
| The <property>BcMath\Number::scale</property> will never be less than the <property>BcMath\Number::scale | ||
| </property> before expansion. |
There was a problem hiding this comment.
Suggested change
| The <property>BcMath\Number::scale</property> will never be less than the <property>BcMath\Number::scale | |
| </property> before expansion. | |
| The <property>BcMath\Number::scale</property> will never be less than the | |
| <property>BcMath\Number::scale</property> before expansion. |
Comment on lines
+58
to
+61
| </simpara> | ||
| <example> | ||
| <title>Example of <property>BcMath\Number::scale</property> of result object</title> | ||
| <programlisting role="php"> |
There was a problem hiding this comment.
Move the example to the corresponding section, if you want to point it out in the return value you can add an xml:id and link tag
Comment on lines
+40
to
+43
| <!-- ValueError cases --> | ||
| <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('bcmath-number.add')/db:refsect1[@role='errors']/db:para[1])" /> | ||
| <!-- The DivisionByZeroError case --> | ||
| <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('bcmath-number.div')/db:refsect1[@role='errors']/db:simpara[1])" /> |
There was a problem hiding this comment.
It might be better to wait for php/doc-base#198 to be merged than using XIncludes with indices
| <simpara> | ||
| The exponent. Must be a value with no fractional part. | ||
| The valid range of the <parameter>exponent</parameter> is platform specific, | ||
| but is at least <literal>-2147483648</literal> to <literal>2147483647</literal>. |
There was a problem hiding this comment.
Suggested change
| but is at least <literal>-2147483648</literal> to <literal>2147483647</literal>. | |
| but it is at least <literal>-2147483648</literal> to <literal>2147483647</literal>. |
| <term><parameter>exponent</parameter></term> | ||
| <listitem> | ||
| <simpara> | ||
| The exponent, as an non-negative and integral (i.e. the scale has to be zero). |
There was a problem hiding this comment.
Use the same wording as in the pow method?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
RFCs:
https://wiki.php.net/rfc/support_object_type_in_bcmath
https://wiki.php.net/rfc/fix_up_bcmath_number_class
stub:
https://github.com/php/php-src/blob/master/ext/bcmath/bcmath.stub.php