archived-doc-ja/reference/random/functions/mt-rand.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d6dc2be3c5c70e4a1c3d13f788643ea232747c19 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.mt-rand" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mt_rand</refname>
  <refpurpose>メルセンヌ・ツイスター乱数生成器を介して乱数値を生成する</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>mt_rand</methodname>
   <void/>
  </methodsynopsis>
  <methodsynopsis>
   <type>int</type><methodname>mt_rand</methodname>
   <methodparam><type>int</type><parameter>min</parameter></methodparam>
   <methodparam><type>int</type><parameter>max</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   古い libc の多くの乱数発生器は、怪しげであるか特性が不明であったりし、
   また低速でした。
   <function>mt_rand</function> 関数は、古い <function>rand</function> の代替品となるものです。
   この関数は、その特性が既知の乱数生成器 <link xlink:href="&url.mersenne;">
   メルセンヌ・ツイスター</link> を使用し、
   平均的な libc の rand()よりも 4 倍以上高速に乱数を生成します。
  </simpara>
  <simpara>
   オプションの引数
   <parameter>min</parameter>,<parameter>max</parameter> を付けずに
   コールした場合、<function>mt_rand</function> は 0 から
   <function>mt_getrandmax</function> の間の擬似乱数値を返します。
   例えば、5 から 15 まで(端点を含む)の間の乱数値を得たい場合には
   <literal>mt_rand(5, 15)</literal> としてください。
  </simpara>
  &caution.cryptographically-insecure;
  &caution.mt19937-global-state;
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>min</parameter></term>
     <listitem>
      <para>
       オプションで指定する、返される値の最小値 (デフォルトは 0)。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>max</parameter></term>
     <listitem>
      <para>
       オプションで指定する、返される値の最大値 (デフォルトは <function>mt_getrandmax</function>)。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>min</parameter> (あるいは 0)
   から <parameter>max</parameter> (あるいは <function>mt_getrandmax</function>、それぞれ端点を含む)
   までの間のランダムな整数値を返します。
  </para>
 </refsect1>
 <refsect1 role="errors">
  &reftitle.errors;
  <itemizedlist>
   <listitem>
    <simpara>
     <parameter>max</parameter> が <parameter>min</parameter> より小さい場合
     <classname>ValueError</classname> がスローされます。
    </simpara>
   </listitem>
  </itemizedlist>
 </refsect1>
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.0.0</entry>
       <entry>
        <parameter>max</parameter> が <parameter>min</parameter> より小さい場合は
        <classname>ValueError</classname> がスローされます。
        以前は <constant>E_WARNING</constant> が発生し、関数は &false; を返していました。
       </entry>
      </row>
      <row>
       <entry>7.2.0</entry>
       <entry>
        <function>mt_rand</function> 関数の
        モジュロバイアスに関するバグが <link linkend="migration72.incompatible.rand-mt_rand-output">修正されました</link>。
        これは、特定のシードを用いて生成したシーケンスは、64bit マシン上での PHP 7.1 と出力が異なる可能性があることを意味します。
       </entry>
      </row>
      <row>
       <entry>7.1.0</entry>
       <entry>
        <function>rand</function> は、<function>mt_rand</function> の
        <link linkend="migration71.incompatible.rand-srand-aliases">エイリアスになりました。</link>
       </entry>
      </row>
      <row>
       <entry>7.1.0</entry>
       <entry>
        <function>mt_rand</function> は、固定の、正しいバージョンのメルセンヌツイスタ の アルゴリズム を使うように
        <link linkend="migration71.incompatible.fixes-to-mt_rand-algorithm">更新されました</link>。
        古い振る舞いに戻すには、
        <function>mt_srand</function> 関数の第二引数に
        <constant>MT_RAND_PHP</constant> を指定して使ってください。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mt_rand</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
echo mt_rand(), "\n";
echo mt_rand(), "\n";

echo mt_rand(5, 15), "\n";
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
1604716014
1478613278
6
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 <refsect1 role="notes">
  &reftitle.notes;
  <warning>
   <para>
    <parameter>min</parameter> から <parameter>max</parameter>
    までの幅を <function>mt_getrandmax</function> の範囲内におさめる必要があります。
    つまり、(<parameter>max</parameter> -
    <parameter>min</parameter>) &lt;= <function>mt_getrandmax</function>
    でなければいけないということです。この範囲をこえてしまうと、
    <function>mt_rand</function> が返す値のランダム性が、
    本来あるべき姿よりも低くなってしまいます。
   </para>
  </warning>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mt_srand</function></member>
    <member><function>mt_getrandmax</function></member>
    <member><function>random_int</function></member>
    <member><function>random_bytes</function></member>
   </simplelist>
  </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
-->