php-doc-en/reference/gmp/functions/gmp-gcd.xml
2014-06-01 21:58:38 +00:00

95 lines
2.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gmp-gcd">
<refnamediv>
<refname>gmp_gcd</refname>
<refpurpose>Calculate GCD</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>GMP</type><methodname>gmp_gcd</methodname>
<methodparam><type>GMP</type><parameter>a</parameter></methodparam>
<methodparam><type>GMP</type><parameter>b</parameter></methodparam>
</methodsynopsis>
<para>
Calculate greatest common divisor of <parameter>a</parameter> and
<parameter>b</parameter>. The result is always positive even if
either of, or both, input operands are negative.
</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>
A positive GMP number that divides into both
<parameter>a</parameter> and <parameter>b</parameter>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>gmp_gcd</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$gcd = gmp_gcd("12", "21");
echo gmp_strval($gcd) . "\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
3
]]>
</screen>
</example>
</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
-->