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