php-doc-en/reference/gmp/functions/gmp-cmp.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gmp-cmp">
 <refnamediv>
  <refname>gmp_cmp</refname>
  <refpurpose>Compare numbers</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>gmp_cmp</methodname>
   <methodparam><type>resource</type><parameter>a</parameter></methodparam>
   <methodparam><type>resource</type><parameter>b</parameter></methodparam>
  </methodsynopsis>
  <para>
   Compares two numbers.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>a</parameter></term>
     <listitem>
      &gmp.parameter; 
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>b</parameter></term>
     <listitem>
      &gmp.parameter; 
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a positive value if <literal>a &gt; b</literal>, zero if
   <literal>a = b</literal> and a negative value if <literal>a &lt;
   b</literal>.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>gmp_cmp</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
$cmp1 = gmp_cmp("1234", "1000"); // greater than
$cmp2 = gmp_cmp("1000", "1234"); // less than
$cmp3 = gmp_cmp("1234", "1234"); // equal to

echo "$cmp1 $cmp2 $cmp3\n";
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
1 -1 0
]]>
   </screen>
  </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:"~/.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
-->