doc/guide/localhost/MLtonRandom

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <meta name="generator" content="AsciiDoc 8.6.9">
   6 <title>MLtonRandom</title>
   7 <link rel="stylesheet" href="./asciidoc.css" type="text/css">
   8 <link rel="stylesheet" href="./pygments.css" type="text/css">
   9
  10
  11 <script type="text/javascript" src="./asciidoc.js"></script>
  12 <script type="text/javascript">
  13 /*<![CDATA[*/
  14 asciidoc.install();
  15 /*]]>*/
  16 </script>
  17 <link rel="stylesheet" href="./mlton.css" type="text/css">
  18 </head>
  19 <body class="article">
  20 <div id="banner">
  21 <div id="banner-home">
  22 <a href="./Home">MLton 20180207</a>
  23 </div>
  24 </div>
  25 <div id="header">
  26 <h1>MLtonRandom</h1>
  27 </div>
  28 <div id="content">
  29 <div id="preamble">
  30 <div class="sectionbody">
  31 <div class="listingblock">
  32 <div class="content"><div class="highlight"><pre><span class="k">signature</span><span class="w"> </span><span class="n">MLTON_RANDOM</span><span class="w"> </span><span class="p">=</span><span class="w"></span>
  33 <span class="w">   </span><span class="k">sig</span><span class="w"></span>
  34 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">alphaNumChar</span><span class="p">:</span><span class="w"> </span><span class="n">unit</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">char</span><span class="w"></span>
  35 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">alphaNumString</span><span class="p">:</span><span class="w"> </span><span class="n">int</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">string</span><span class="w"></span>
  36 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">rand</span><span class="p">:</span><span class="w"> </span><span class="n">unit</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">word</span><span class="w"></span>
  37 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">seed</span><span class="p">:</span><span class="w"> </span><span class="n">unit</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">word</span><span class="w"> </span><span class="n">option</span><span class="w"></span>
  38 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">srand</span><span class="p">:</span><span class="w"> </span><span class="n">word</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="w"></span>
  39 <span class="w">      </span><span class="k">val</span><span class="w"> </span><span class="n">useed</span><span class="p">:</span><span class="w"> </span><span class="n">unit</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">word</span><span class="w"> </span><span class="n">option</span><span class="w"></span>
  40 <span class="w">   </span><span class="k">end</span><span class="w"></span>
  41 </pre></div></div></div>
  42 <div class="ulist"><ul>
  43 <li>
  44 <p>
  45 <span class="monospaced">alphaNumChar ()</span>
  46 </p>
  47 <div class="paragraph"><p>returns a random alphanumeric character.</p></div>
  48 </li>
  49 <li>
  50 <p>
  51 <span class="monospaced">alphaNumString n</span>
  52 </p>
  53 <div class="paragraph"><p>returns a string of length <span class="monospaced">n</span> of random alphanumeric characters.</p></div>
  54 </li>
  55 <li>
  56 <p>
  57 <span class="monospaced">rand ()</span>
  58 </p>
  59 <div class="paragraph"><p>returns the next pseudo-random number.</p></div>
  60 </li>
  61 <li>
  62 <p>
  63 <span class="monospaced">seed ()</span>
  64 </p>
  65 <div class="paragraph"><p>returns a random word from <span class="monospaced">/dev/random</span>.  Useful as an arg to
  66 <span class="monospaced">srand</span>.  If <span class="monospaced">/dev/random</span> can not be read from, <span class="monospaced">seed ()</span> returns
  67 <span class="monospaced">NONE</span>.  A call to <span class="monospaced">seed</span> may block until enough random bits are
  68 available.</p></div>
  69 </li>
  70 <li>
  71 <p>
  72 <span class="monospaced">srand w</span>
  73 </p>
  74 <div class="paragraph"><p>sets the seed used by <span class="monospaced">rand</span> to <span class="monospaced">w</span>.</p></div>
  75 </li>
  76 <li>
  77 <p>
  78 <span class="monospaced">useed ()</span>
  79 </p>
  80 <div class="paragraph"><p>returns a random word from <span class="monospaced">/dev/urandom</span>.  Useful as an arg to
  81 <span class="monospaced">srand</span>.  If <span class="monospaced">/dev/urandom</span> can not be read from, <span class="monospaced">useed ()</span> returns
  82 <span class="monospaced">NONE</span>.  A call to <span class="monospaced">useed</span> will never block&#8201;&#8212;&#8201;it will instead return
  83 lower quality random bits.</p></div>
  84 </li>
  85 </ul></div>
  86 </div>
  87 </div>
  88 </div>
  89 <div id="footnotes"><hr></div>
  90 <div id="footer">
  91 <div id="footer-text">
  92 </div>
  93 <div id="footer-badges">
  94 </div>
  95 </div>
  96 </body>
  97 </html>