php-doc-en/reference/gmp/functions/gmp-jacobi.xml
Christoph Michael Becker db16489501 New GMP functions as of PHP 7.3.0
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346307 c90b9560-bf6c-de11-be94-00142212c4b1
2018-12-12 13:56:45 +00:00

107 lines
2.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook" xml:id="function.gmp-jacobi">
<refnamediv>
<refname>gmp_jacobi</refname>
<refpurpose>Jacobi symbol</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>gmp_jacobi</methodname>
<methodparam><type>GMP</type><parameter>a</parameter></methodparam>
<methodparam><type>GMP</type><parameter>p</parameter></methodparam>
</methodsynopsis>
<para>
Computes
<link xlink:href="&url.jacobi;">Jacobi symbol</link> of <parameter>a</parameter> and
<parameter>p</parameter>. <parameter>p</parameter> should be odd
and must be positive.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>a</parameter></term>
<listitem>
&gmp.parameter;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>p</parameter></term>
<listitem>
&gmp.parameter;
<para>
Should be odd and must be positive.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&gmp.return;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>gmp_jacobi</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo gmp_jacobi("1", "3") . "\n";
echo gmp_jacobi("2", "3") . "\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
1
0
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>gmp_kronecker</function></member>
<member><function>gmp_legendre</function></member>
</simplelist>
</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
-->