php-doc-en/reference/math/functions/mt-getrandmax.xml
Jean-Sebastien Hedde 247d016f43 Wrong markup for parameter.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@336046 c90b9560-bf6c-de11-be94-00142212c4b1
2015-03-06 13:01:41 +00:00

85 lines
2.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mt-getrandmax" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mt_getrandmax</refname>
<refpurpose>Show largest possible random value</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>mt_getrandmax</methodname>
<void/>
</methodsynopsis>
<simpara>
Returns the maximum value that can be returned by a call to
<function>mt_rand</function>.
</simpara>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the maximum random value returned by a call to
<function>mt_rand</function> without arguments, which is the maximum value
that can be used for its <parameter>max</parameter> parameter without the
result being scaled up (and therefore less random).
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example><title>Calculate a random floating-point number</title>
<programlisting role="php">
<![CDATA[
<?php
function randomFloat($min = 0, $max = 1) {
return $min + mt_rand() / mt_getrandmax() * ($max - $min);
}
var_dump(randomFloat());
var_dump(randomFloat(2, 20));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
float(0.91601131712832)
float(16.511210331931)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>mt_rand</function></member>
<member><function>mt_srand</function></member>
<member><function>getrandmax</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
-->