<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Random number</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gmp-random-seed.html">gmp_random_seed</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gmp-root.html">gmp_root</a></div>
<div class="up"><a href="ref.gmp.html">GMP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.gmp-random" class="refentry">
<div class="refnamediv">
<h1 class="refname">gmp_random</h1>
<p class="verinfo">(PHP 4 >= 4.0.4, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">gmp_random</span> — <span class="dc-title">Random number</span></p>
</div>
<div id="function.gmp-random-refsynopsisdiv">
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function has been
<em class="emphasis">DEPRECATED</em> as of PHP 7.2.0. Relying on this function
is highly discouraged.</p></div>
</div>
<div class="refsect1 description" id="refsect1-function.gmp-random-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="class.gmp.html" class="type GMP">GMP</a></span> <span class="methodname"><strong>gmp_random</strong></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$limiter</code><span class="initializer"> = 20</span></span>
] )</div>
<p class="para rdfs-comment">
Generate a random number. The number will be between 0 and (2 ** n) - 1,
where n is the number of bits per limb multiplied by <code class="parameter">limiter</code>.
If <code class="parameter">limiter</code> is negative, negative numbers are generated.
</p>
<p class="para">
A limb is an internal GMP mechanism. The number of bits in a limb is
not static, and can vary from system to system. Generally, the number
of bits in a limb is either 32 or 64, but this is not guaranteed.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.gmp-random-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">limiter</code></dt>
<dd>
<p class="para">
The limiter.
</p>
<p class="para">Either a GMP number <span class="type"><a href="language.types.resource.html" class="type resource">resource</a></span> in PHP 5.5 and earlier, a <a href="class.gmp.html" class="classname">GMP</a> object in PHP 5.6 and later, or a numeric string provided that it is possible to convert the latter to a number.</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.gmp-random-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A random GMP number.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.gmp-random-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4224">
<p><strong>Example #1 <span class="function"><strong>gmp_random()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$rand1 </span><span style="color: #007700">= </span><span style="color: #0000BB">gmp_random</span><span style="color: #007700">(</span><span style="color: #0000BB">1</span><span style="color: #007700">); </span><span style="color: #FF8000">// random number from 0 to 1 * bits per limb<br /></span><span style="color: #0000BB">$rand2 </span><span style="color: #007700">= </span><span style="color: #0000BB">gmp_random</span><span style="color: #007700">(</span><span style="color: #0000BB">2</span><span style="color: #007700">); </span><span style="color: #FF8000">// random number from 0 to 2 * bits per limb<br /><br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">gmp_strval</span><span style="color: #007700">(</span><span style="color: #0000BB">$rand1</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">gmp_strval</span><span style="color: #007700">(</span><span style="color: #0000BB">$rand2</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
1915834968
8642564075890328087
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gmp-random-seed.html">gmp_random_seed</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gmp-root.html">gmp_root</a></div>
<div class="up"><a href="ref.gmp.html">GMP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
