php-doc-en/reference/gmp/functions/gmp-random.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/gmp.xml, last change in rev 1.1 -->
  <refentry id="function.gmp-random">
   <refnamediv>
    <refname>gmp_random</refname>
    <refpurpose>Random number</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>resource</type><methodname>gmp_random</methodname>
      <methodparam><type>int</type><parameter>limiter</parameter></methodparam>
     </methodsynopsis>
    <para>
     Generate a random number. The number will be between
     zero and the number of bits per limb multiplied by
     <parameter>limiter</parameter>. If <parameter>limiter</parameter>
     is negative, negative numbers are generated.
    </para>
    <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 16 or 32, but this is not guaranteed.
    </para>
    <example>
     <title><function>gmp_random</function> example</title>
     <programlisting role="php">
<![CDATA[
<?php
    $rand1 = gmp_random(1); // random number from 0 to 1 * bits per limb
    $rand2 = gmp_random(2); // random number from 0 to 2 * bits per limb

    echo gmp_strval($rand1) . "\n";
    echo gmp_strval($rand2) . "\n";
?>
]]>
     </programlisting>
     <para>
      The printout of the above program might be:
     </para>
     <screen>
<![CDATA[
1915834968
8642564075890328087
]]>
     </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
-->