php-doc-en/reference/math/functions/abs.xml
Jakub Vrana 9e4a34a9e5 Returns number, not mixed
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@145945 c90b9560-bf6c-de11-be94-00142212c4b1
2003-12-08 09:17:26 +00:00

56 lines
1.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/math.xml, last change in rev 1.2 -->
<refentry id="function.abs">
<refnamediv>
<refname>abs</refname>
<refpurpose>Absolute value</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>number</type><methodname>abs</methodname>
<methodparam><type>mixed</type><parameter>number</parameter></methodparam>
</methodsynopsis>
<para>
Returns the absolute value of <parameter>number</parameter>. If the
argument <parameter>number</parameter> is
of type <type>float</type>, the return type is also <type>float</type>,
otherwise it is <type>integer</type> (as <type>float</type> usually has a
bigger value range than <type>integer</type>).
</para>
<example>
<title><function>abs</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$abs = abs(-4.2); // $abs = 4.2; (double/float)
$abs2 = abs(5); // $abs2 = 5; (integer)
$abs3 = abs(-5); // $abs3 = 5; (integer)
?>
]]>
</programlisting>
</example>
</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
-->