File: Random.html

package info (click to toggle)
ocaml-doc 3.10-1
  • links: PTS, VCS
  • area: non-free
  • in suites: lenny
  • size: 7,476 kB
  • ctags: 2,644
  • sloc: ml: 325; sh: 64; makefile: 34; ansic: 15
file content (145 lines) | stat: -rw-r--r-- 9,601 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Queue.html">
<link rel="next" href="Scanf.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Arg" rel="Chapter" href="Arg.html">
<link title="Arith_status" rel="Chapter" href="Arith_status.html">
<link title="Array" rel="Chapter" href="Array.html">
<link title="ArrayLabels" rel="Chapter" href="ArrayLabels.html">
<link title="Big_int" rel="Chapter" href="Big_int.html">
<link title="Bigarray" rel="Chapter" href="Bigarray.html">
<link title="Buffer" rel="Chapter" href="Buffer.html">
<link title="Callback" rel="Chapter" href="Callback.html">
<link title="CamlinternalMod" rel="Chapter" href="CamlinternalMod.html">
<link title="CamlinternalOO" rel="Chapter" href="CamlinternalOO.html">
<link title="Char" rel="Chapter" href="Char.html">
<link title="Complex" rel="Chapter" href="Complex.html">
<link title="Condition" rel="Chapter" href="Condition.html">
<link title="Dbm" rel="Chapter" href="Dbm.html">
<link title="Digest" rel="Chapter" href="Digest.html">
<link title="Dynlink" rel="Chapter" href="Dynlink.html">
<link title="Event" rel="Chapter" href="Event.html">
<link title="Filename" rel="Chapter" href="Filename.html">
<link title="Format" rel="Chapter" href="Format.html">
<link title="Gc" rel="Chapter" href="Gc.html">
<link title="Genlex" rel="Chapter" href="Genlex.html">
<link title="Graphics" rel="Chapter" href="Graphics.html">
<link title="GraphicsX11" rel="Chapter" href="GraphicsX11.html">
<link title="Hashtbl" rel="Chapter" href="Hashtbl.html">
<link title="Int32" rel="Chapter" href="Int32.html">
<link title="Int64" rel="Chapter" href="Int64.html">
<link title="Lazy" rel="Chapter" href="Lazy.html">
<link title="Lexing" rel="Chapter" href="Lexing.html">
<link title="List" rel="Chapter" href="List.html">
<link title="ListLabels" rel="Chapter" href="ListLabels.html">
<link title="Map" rel="Chapter" href="Map.html">
<link title="Marshal" rel="Chapter" href="Marshal.html">
<link title="MoreLabels" rel="Chapter" href="MoreLabels.html">
<link title="Mutex" rel="Chapter" href="Mutex.html">
<link title="Nativeint" rel="Chapter" href="Nativeint.html">
<link title="Num" rel="Chapter" href="Num.html">
<link title="Obj" rel="Chapter" href="Obj.html">
<link title="Oo" rel="Chapter" href="Oo.html">
<link title="Parsing" rel="Chapter" href="Parsing.html">
<link title="Pervasives" rel="Chapter" href="Pervasives.html">
<link title="Printexc" rel="Chapter" href="Printexc.html">
<link title="Printf" rel="Chapter" href="Printf.html">
<link title="Queue" rel="Chapter" href="Queue.html">
<link title="Random" rel="Chapter" href="Random.html">
<link title="Scanf" rel="Chapter" href="Scanf.html">
<link title="Set" rel="Chapter" href="Set.html">
<link title="Sort" rel="Chapter" href="Sort.html">
<link title="Stack" rel="Chapter" href="Stack.html">
<link title="StdLabels" rel="Chapter" href="StdLabels.html">
<link title="Str" rel="Chapter" href="Str.html">
<link title="Stream" rel="Chapter" href="Stream.html">
<link title="String" rel="Chapter" href="String.html">
<link title="StringLabels" rel="Chapter" href="StringLabels.html">
<link title="Sys" rel="Chapter" href="Sys.html">
<link title="Thread" rel="Chapter" href="Thread.html">
<link title="ThreadUnix" rel="Chapter" href="ThreadUnix.html">
<link title="Tk" rel="Chapter" href="Tk.html">
<link title="Unix" rel="Chapter" href="Unix.html">
<link title="UnixLabels" rel="Chapter" href="UnixLabels.html">
<link title="Weak" rel="Chapter" href="Weak.html"><link title="Basic functions" rel="Section" href="#6_Basicfunctions">
<link title="Advanced functions" rel="Section" href="#6_Advancedfunctions">
<title>Random</title>
</head>
<body>
<div class="navbar"><a href="Queue.html">Previous</a>
&nbsp;<a href="index.html">Up</a>
&nbsp;<a href="Scanf.html">Next</a>
</div>
<center><h1>Module <a href="type_Random.html">Random</a></h1></center>
<br>
<pre><span class="keyword">module</span> Random: <code class="code"><span class="keyword">sig</span></code> <a href="Random.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>Pseudo-random number generators (PRNG).<br>
<hr width="100%">
<br>
<a name="6_Basicfunctions"></a>
<h6>Basic functions</h6><br>
<pre><span class="keyword">val</span> <a name="VALinit"></a>init : <code class="type">int -> unit</code></pre><div class="info">
Initialize the generator, using the argument as a seed.
     The same seed will always yield the same sequence of numbers.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALfull_init"></a>full_init : <code class="type">int array -> unit</code></pre><div class="info">
Same as <a href="Random.html#VALinit"><code class="code"><span class="constructor">Random</span>.init</code></a> but takes more data as seed.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALself_init"></a>self_init : <code class="type">unit -> unit</code></pre><div class="info">
Initialize the generator with a more-or-less random seed chosen
   in a system-dependent way.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALbits"></a>bits : <code class="type">unit -> int</code></pre><div class="info">
Return 30 random bits in a nonnegative integer.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALint"></a>int : <code class="type">int -> int</code></pre><div class="info">
<code class="code"><span class="constructor">Random</span>.int bound</code> returns a random integer between 0 (inclusive)
     and <code class="code">bound</code> (exclusive).  <code class="code">bound</code> must be greater than 0 and less
     than 2<sup class="superscript">30</sup>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALint32"></a>int32 : <code class="type"><a href="Int32.html#TYPEt">Int32.t</a> -> <a href="Int32.html#TYPEt">Int32.t</a></code></pre><div class="info">
<code class="code"><span class="constructor">Random</span>.int32 bound</code> returns a random integer between 0 (inclusive)
     and <code class="code">bound</code> (exclusive).  <code class="code">bound</code> must be greater than 0.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALnativeint"></a>nativeint : <code class="type"><a href="Nativeint.html#TYPEt">Nativeint.t</a> -> <a href="Nativeint.html#TYPEt">Nativeint.t</a></code></pre><div class="info">
<code class="code"><span class="constructor">Random</span>.nativeint bound</code> returns a random integer between 0 (inclusive)
     and <code class="code">bound</code> (exclusive).  <code class="code">bound</code> must be greater than 0.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALint64"></a>int64 : <code class="type"><a href="Int64.html#TYPEt">Int64.t</a> -> <a href="Int64.html#TYPEt">Int64.t</a></code></pre><div class="info">
<code class="code"><span class="constructor">Random</span>.int64 bound</code> returns a random integer between 0 (inclusive)
     and <code class="code">bound</code> (exclusive).  <code class="code">bound</code> must be greater than 0.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALfloat"></a>float : <code class="type">float -> float</code></pre><div class="info">
<code class="code"><span class="constructor">Random</span>.float bound</code> returns a random floating-point number
   between 0 (inclusive) and <code class="code">bound</code> (exclusive).  If <code class="code">bound</code> is
   negative, the result is negative or zero.  If <code class="code">bound</code> is 0,
   the result is 0.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALbool"></a>bool : <code class="type">unit -> bool</code></pre><div class="info">
<code class="code"><span class="constructor">Random</span>.bool ()</code> returns <code class="code"><span class="keyword">true</span></code> or <code class="code"><span class="keyword">false</span></code> with probability 0.5 each.<br>
</div>
<br>
<a name="6_Advancedfunctions"></a>
<h6>Advanced functions</h6><br>
<br>
The functions from module <code class="code"><span class="constructor">State</span></code> manipulate the current state
    of the random generator explicitely.
    This allows using one or several deterministic PRNGs,
    even in a multi-threaded program, without interference from
    other parts of the program.<br>
<pre><span class="keyword">module</span> <a href="Random.State.html">State</a>: <code class="code"><span class="keyword">sig</span></code> <a href="Random.State.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><pre><span class="keyword">val</span> <a name="VALget_state"></a>get_state : <code class="type">unit -> <a href="Random.State.html#TYPEt">State.t</a></code></pre><div class="info">
Return the current state of the generator used by the basic functions.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALset_state"></a>set_state : <code class="type"><a href="Random.State.html#TYPEt">State.t</a> -> unit</code></pre><div class="info">
Set the state of the generator used by the basic functions.<br>
</div>
</body></html>