Skip to content

PHP 8.4: Document RoundingMode #4080

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
merged 3 commits into from
Nov 20, 2024
Merged

PHP 8.4: Document RoundingMode #4080

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80c2801
PHP 8.4: Document RoundingMode
Girgias Nov 17, 2024
244c3b8
Update reference/math/roundingmode.xml
Girgias Nov 17, 2024
e1351f9
Include in manual
Girgias Nov 20, 2024
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
109 changes: 109 additions & 0 deletions reference/math/roundingmode.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
<?xml version="1.0" encoding="utf-8"?>
<reference xmlns="http://docbook.org/ns/docbook" xml:id="enum.roundingmode" role="enum">
<title>The RoundingMode Enum</title>
<titleabbrev>RoundingMode</titleabbrev>

<partintro>
<section xml:id="enum.roundingmode.intro">
&reftitle.intro;
<simpara>
The <enumname>RoundingMode</enumname> is used to specify how rounding
should be performed for <function>round</function>,
<function>bcround</function>, and <methodname>BCMath::round</methodname>.
</simpara>
</section>

<section xml:id="enum.roundingmode.synopsis">
&reftitle.enumsynopsis;

<enumsynopsis>
<enumname>RoundingMode</enumname>

<enumitem>
<enumidentifier>HalfAwayFromZero</enumidentifier>
<enumitemdescription>
Round to the nearest integer.
If the decimal part is <literal>5</literal>,
round to the integer with the larger absolute value.
Comment on lines +25 to +27
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume you've taken all the description from the RFC?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The bit with the decimal part might need some adjustments either in the documentation for round() or in here, because round() supports rounding to a specified precision instead of integers.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have indeed taken them from the RFC, yeah the whole round() semantics is... going to be a PITA.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I will merge as is, feel free to open an issue about the wording to keep track of it

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#4127.

</enumitemdescription>
</enumitem>

<enumitem>
<enumidentifier>HalfTowardsZero</enumidentifier>
<enumitemdescription>
Round to the nearest integer.
If the decimal part is <literal>5</literal>,
round to the integer with the smaller absolute value.
</enumitemdescription>
</enumitem>

<enumitem>
<enumidentifier>HalfEven</enumidentifier>
<enumitemdescription>
Round to the nearest integer.
If the decimal part is <literal>5</literal>,
round to the even integer.
</enumitemdescription>
</enumitem>

<enumitem>
<enumidentifier>HalfOdd</enumidentifier>
<enumitemdescription>
Round to the nearest integer.
If the decimal part is <literal>5</literal>,
round to the odd integer.
</enumitemdescription>
</enumitem>

<enumitem>
<enumidentifier>TowardsZero</enumidentifier>
<enumitemdescription>
Round to the nearest integer with a smaller or equal absolute value.
</enumitemdescription>
</enumitem>

<enumitem>
<enumidentifier>AwayFromZero</enumidentifier>
<enumitemdescription>
Round to the nearest integer with a greater or equal absolute value.
</enumitemdescription>
</enumitem>

<enumitem>
<enumidentifier>NegativeInfinity</enumidentifier>
<enumitemdescription>
Round to the largest integer that is smaller or equal.
</enumitemdescription>
</enumitem>

<enumitem>
<enumidentifier>PositiveInfinity</enumidentifier>
<enumitemdescription>
Round to the smallest integer that is greater or equal.
</enumitemdescription>
</enumitem>

</enumsynopsis>
</section>
</partintro>
</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:"~/.phpdoc/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
-->
3 changes: 3 additions & 0 deletions reference/math/versions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@
<function name="tan" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
<function name="tanh" from="PHP 4 &gt;= 4.1.0, PHP 5, PHP 7, PHP 8"/>
<function name="intdiv" from="PHP 7, PHP 8"/>

<!-- RoundingMode -->
<function name="roundingmode" from="PHP 8 &gt;= 8.4.0"/>
</versions>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down