php-doc-en/reference/gmp/functions/gmp-sign.xml
Philip Olson 0e1e984293 Added see also links
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297596 c90b9560-bf6c-de11-be94-00142212c4b1
2010-04-06 22:50:21 +00:00

105 lines
2.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gmp-sign">
<refnamediv>
<refname>gmp_sign</refname>
<refpurpose>Sign of number</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>gmp_sign</methodname>
<methodparam><type>resource</type><parameter>a</parameter></methodparam>
</methodsynopsis>
<para>
Checks the sign of a number.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>a</parameter></term>
<listitem>
&gmp.parameter;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns 1 if <parameter>a</parameter> is positive,
-1 if <parameter>a</parameter> is negative,
and 0 if <parameter>a</parameter> is zero.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>gmp_sign</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// positive
echo gmp_sign("500") . "\n";
// negative
echo gmp_sign("-500") . "\n";
// zero
echo gmp_sign("0") . "\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
1
-1
0
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>gmp_abs</function></member>
<member><function>abs</function></member>
</simplelist>
</para>
</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:"~/.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
-->