File: gmp-prob-prime.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (112 lines) | stat: -rw-r--r-- 2,735 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<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
-->