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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class rand48</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../boost_random/reference.html#header.boost.random.linear_congruential_hpp" title="Header <boost/random/linear_congruential.hpp>">
<link rel="prev" href="linear_congruential_engine.html" title="Class template linear_congruential_engine">
<link rel="next" href="minstd_rand0.html" title="Type definition minstd_rand0">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="linear_congruential_engine.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.linear_congruential_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="minstd_rand0.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.random.rand48"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class rand48</span></h2>
<p>boost::random::rand48</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../boost_random/reference.html#header.boost.random.linear_congruential_hpp" title="Header <boost/random/linear_congruential.hpp>">boost/random/linear_congruential.hpp</a>>
</span>
<span class="keyword">class</span> <a class="link" href="rand48.html" title="Class rand48">rand48</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// types</span>
<span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint32_t</span> <a name="boost.random.rand48.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
<span class="comment">// <a class="link" href="rand48.html#boost.random.rand48construct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="rand48.html#idp131901808-bb"><span class="identifier">rand48</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">explicit</span> <a class="link" href="rand48.html#idp131898640-bb"><span class="identifier">rand48</span></a><span class="special">(</span><span class="identifier">result_type</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> SeedSeq<span class="special">></span> <span class="keyword">explicit</span> <a class="link" href="rand48.html#idp131896832-bb"><span class="identifier">rand48</span></a><span class="special">(</span><span class="identifier">SeedSeq</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> It<span class="special">></span> <a class="link" href="rand48.html#idp138113280-bb"><span class="identifier">rand48</span></a><span class="special">(</span><span class="identifier">It</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">It</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="rand48.html#idp77973696-bb">public static functions</a></span>
<span class="keyword">static</span> <span class="identifier">uint32_t</span> <a class="link" href="rand48.html#idp77972048-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">static</span> <span class="identifier">uint32_t</span> <a class="link" href="rand48.html#idp177410592-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="rand48.html#idp77970080-bb">public member functions</a></span>
<span class="keyword">void</span> <a class="link" href="rand48.html#idp177413184-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="rand48.html#idp177412880-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="identifier">result_type</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> It<span class="special">></span> <span class="keyword">void</span> <a class="link" href="rand48.html#idp177410352-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="identifier">It</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">It</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> SeedSeq<span class="special">></span> <span class="keyword">void</span> <a class="link" href="rand48.html#idp177407120-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="identifier">SeedSeq</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">uint32_t</span> <a class="link" href="rand48.html#idp207159840-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="rand48.html#idp207159264-bb"><span class="identifier">discard</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uintmax_t</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Iter<span class="special">></span> <span class="keyword">void</span> <a class="link" href="rand48.html#idp207157168-bb"><span class="identifier">generate</span></a><span class="special">(</span><span class="identifier">Iter</span><span class="special">,</span> <span class="identifier">Iter</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="rand48.html#idp138109088-bb">friend functions</a></span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span>
<span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span>
<a class="link" href="rand48.html#idp138110016-bb"><span class="keyword">operator</span><span class="special"><<</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="rand48.html" title="Class rand48">rand48</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span>
<span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span>
<a class="link" href="rand48.html#idp204456112-bb"><span class="keyword">operator</span><span class="special">>></span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <a class="link" href="rand48.html" title="Class rand48">rand48</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="rand48.html#idp42789792-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="rand48.html" title="Class rand48">rand48</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="rand48.html" title="Class rand48">rand48</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="rand48.html#idp42786384-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="rand48.html" title="Class rand48">rand48</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="rand48.html" title="Class rand48">rand48</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// public data members</span>
<span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">bool</span> <span class="identifier">has_fixed_range</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="idp373320336"></a><h2>Description</h2>
<p>Class <code class="computeroutput"><a class="link" href="rand48.html" title="Class rand48">rand48</a></code> models a <a class="link" href="../../boost_random/reference.html#boost_random.reference.concepts.pseudo_random_number_generator" title="Pseudo-Random Number Generator">pseudo-random number generator</a> . It uses the linear congruential algorithm with the parameters a = 0x5DEECE66D, c = 0xB, m = 2**48. It delivers identical results to the <code class="computeroutput">lrand48()</code> function available on some systems (assuming lcong48 has not been called).</p>
<p>It is only available on systems where <code class="computeroutput">uint64_t</code> is provided as an integral type, so that for example static in-class constants and/or enum definitions with large <code class="computeroutput">uint64_t</code> numbers work. </p>
<div class="refsect2">
<a name="idp373326048"></a><h3>
<a name="boost.random.rand48construct-copy-destruct"></a><code class="computeroutput">rand48</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="idp131901808-bb"></a><span class="identifier">rand48</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Seeds the generator with the default seed. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp131898640-bb"></a><span class="identifier">rand48</span><span class="special">(</span><span class="identifier">result_type</span> x0<span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a <code class="computeroutput"><a class="link" href="rand48.html" title="Class rand48">rand48</a></code> generator with x(0) := (x0 << 16) | 0x330e. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> SeedSeq<span class="special">></span> <span class="keyword">explicit</span> <a name="idp131896832-bb"></a><span class="identifier">rand48</span><span class="special">(</span><span class="identifier">SeedSeq</span> <span class="special">&</span> seq<span class="special">)</span><span class="special">;</span></pre>
<p>Seeds the generator with values produced by <code class="computeroutput">seq.generate()</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> It<span class="special">></span> <a name="idp138113280-bb"></a><span class="identifier">rand48</span><span class="special">(</span><span class="identifier">It</span> <span class="special">&</span> first<span class="special">,</span> <span class="identifier">It</span> last<span class="special">)</span><span class="special">;</span></pre>
<p>Seeds the generator using values from an iterator range, and updates first to point one past the last value consumed. </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp373357120"></a><h3>
<a name="idp77973696-bb"></a><code class="computeroutput">rand48</code> public static functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">uint32_t</span> <a name="idp77972048-bb"></a><span class="identifier">min</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Returns the smallest value that the generator can produce </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">uint32_t</span> <a name="idp177410592-bb"></a><span class="identifier">max</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Returns the largest value that the generator can produce </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp373369824"></a><h3>
<a name="idp77970080-bb"></a><code class="computeroutput">rand48</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp177413184-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Seeds the generator with the default seed. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp177412880-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="identifier">result_type</span> x0<span class="special">)</span><span class="special">;</span></pre>
<p>Changes the current value x(n) of the generator to (x0 << 16) | 0x330e. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> It<span class="special">></span> <span class="keyword">void</span> <a name="idp177410352-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="identifier">It</span> <span class="special">&</span> first<span class="special">,</span> <span class="identifier">It</span> last<span class="special">)</span><span class="special">;</span></pre>
<p>Seeds the generator using values from an iterator range, and updates first to point one past the last value consumed. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> SeedSeq<span class="special">></span> <span class="keyword">void</span> <a name="idp177407120-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="identifier">SeedSeq</span> <span class="special">&</span> seq<span class="special">)</span><span class="special">;</span></pre>
<p>Seeds the generator with values produced by <code class="computeroutput">seq.generate()</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">uint32_t</span> <a name="idp207159840-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Returns the next value of the generator. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp207159264-bb"></a><span class="identifier">discard</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uintmax_t</span> z<span class="special">)</span><span class="special">;</span></pre>
<p>Advances the state of the generator by <code class="computeroutput">z</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Iter<span class="special">></span> <span class="keyword">void</span> <a name="idp207157168-bb"></a><span class="identifier">generate</span><span class="special">(</span><span class="identifier">Iter</span> first<span class="special">,</span> <span class="identifier">Iter</span> last<span class="special">)</span><span class="special">;</span></pre>
<p>Fills a range with random values </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="idp373423200"></a><h3>
<a name="idp138109088-bb"></a><code class="computeroutput">rand48</code> friend functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span>
<span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span>
<a name="idp138110016-bb"></a><span class="keyword">operator</span><span class="special"><<</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> os<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="rand48.html" title="Class rand48">rand48</a> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre>
<p>Writes a <code class="computeroutput"><code class="computeroutput"><a class="link" href="rand48.html" title="Class rand48">rand48</a></code></code> to a <code class="computeroutput">std::ostream</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span>
<span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span>
<a name="idp204456112-bb"></a><span class="keyword">operator</span><span class="special">>></span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> is<span class="special">,</span> <a class="link" href="rand48.html" title="Class rand48">rand48</a> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre>
<p>Reads a <code class="computeroutput"><code class="computeroutput"><a class="link" href="rand48.html" title="Class rand48">rand48</a></code></code> from a <code class="computeroutput">std::istream</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp42789792-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="rand48.html" title="Class rand48">rand48</a> <span class="special">&</span> x<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="rand48.html" title="Class rand48">rand48</a> <span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre>
<p>Returns true if the two generators will produce identical sequences of values. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp42786384-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="rand48.html" title="Class rand48">rand48</a> <span class="special">&</span> x<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="rand48.html" title="Class rand48">rand48</a> <span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre>
<p>Returns true if the two generators will produce different sequences of values. </p>
</li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2000-2005 Jens Maurer<br>Copyright © 2009, 2010 Steven Watanabe<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="linear_congruential_engine.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.linear_congruential_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="minstd_rand0.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
