mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
112 lines
2.7 KiB
XML
112 lines
2.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gmp-prob-prime">
|
|
<refnamediv>
|
|
<refname>gmp_prob_prime</refname>
|
|
<refpurpose>Check if number is "probably prime"</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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><initializer>10</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
The function uses Miller-Rabin's probabilistic test to check if a number is a prime.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>a</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The number being checked as a prime.
|
|
</para>
|
|
&gmp.parameter;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>reps</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
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>
|
|
&gmp.parameter;
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<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.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<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>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
0
|
|
1
|
|
2
|
|
]]>
|
|
</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
|
|
-->
|