php-doc-en/reference/math/functions/round.xml
Philip Olson c79b43a897 Fixed incorrect examples.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@84364 c90b9560-bf6c-de11-be94-00142212c4b1
2002-06-02 01:54:25 +00:00

77 lines
2.2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/math.xml, last change in rev 1.2 -->
<refentry id="function.round">
<refnamediv>
<refname>round</refname>
<refpurpose>Rounds a float</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>float</type><methodname>round</methodname>
<methodparam><type>float</type><parameter>val</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>precision</parameter></methodparam>
</methodsynopsis>
<para>
Returns the rounded value of <parameter>val</parameter> to
specified <parameter>precision</parameter>
(number of digits after the decimal point).
<parameter>precision</parameter> can also be negative or zero (default).
</para>
<para>
<caution>
<simpara>
PHP doesn't handle strings like <literal>"12,300.2"</literal> correctly
by default. See <link linkend="language.types.string.conversion"
>converting from strings</link>.
</simpara>
</caution>
</para>
<para>
<informalexample>
<programlisting role="php">
<![CDATA[
echo round(3.4); // 3
echo round(3.5); // 4
echo round(3.6); // 4
echo round(3.6, 0); // 4
echo round(1.95583, 2); // 1.96
echo round(1241757, -3); // 1242000
]]>
</programlisting>
</informalexample>
</para>
<note>
<simpara>
The <parameter>precision</parameter> parameter is only
available in PHP 4.
</simpara>
</note>
<simpara>
See also <function>ceil</function> and
<function>floor</function>.
</simpara>
</refsect1>
</refentry>
<!-- 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:"../../../../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
-->