php-doc-en/reference/gmp/functions/gmp-prob-prime.xml
2004-02-26 11:14:11 +00:00

77 lines
2.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/gmp.xml, last change in rev 1.1 -->
<refentry id="function.gmp-prob-prime">
<refnamediv>
<refname>gmp_prob_prime</refname>
<refpurpose>Check if number is "probably prime"</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>gmp_prob_prime</methodname>
<methodparam><type>resource</type><parameter>a</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>reps</parameter></methodparam>
</methodsynopsis>
<para>
If this function returns 0, <parameter>a</parameter> is
definitely not prime. If it returns 1, then
<parameter>a</parameter> is "probably" prime. If it returns 2,
then <parameter>a</parameter> is surely prime. Reasonable values
of <parameter>reps</parameter> vary from 5 to 10 (default being
10); a higher value lowers the probability for a non-prime to
pass as a "probable" prime.
</para>
<para>
The function uses Miller-Rabin's probabilistic test.
</para>
<example>
<title><function>gmp_prob_prime</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// definitely not a prime
echo gmp_prob_prime("6") . "\n";
// probably a prime
echo gmp_prob_prime("1111111111111111111") . "\n";
// definitely a prime
echo gmp_prob_prime("11") . "\n";
?>
]]>
</programlisting>
<para>
The printout of the above program will be:
</para>
<screen>
<![CDATA[
0
1
2
]]>
</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:"../../../../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
-->