• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>Class template lagged_fibonacci_01_engine</title>
6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9<link rel="up" href="../../boost_random/reference.html#header.boost.random.lagged_fibonacci_hpp" title="Header &lt;boost/random/lagged_fibonacci.hpp&gt;">
10<link rel="prev" href="hellekalek1995.html" title="Type definition hellekalek1995">
11<link rel="next" href="lagged_fibonacci_engine.html" title="Class template lagged_fibonacci_engine">
12</head>
13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14<table cellpadding="2" width="100%"><tr>
15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
16<td align="center"><a href="../../../../index.html">Home</a></td>
17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20<td align="center"><a href="../../../../more/index.htm">More</a></td>
21</tr></table>
22<hr>
23<div class="spirit-nav">
24<a accesskey="p" href="hellekalek1995.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.lagged_fibonacci_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="lagged_fibonacci_engine.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.random.lagged_fibonacci_01_engine"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Class template lagged_fibonacci_01_engine</span></h2>
30<p>boost::random::lagged_fibonacci_01_engine</p>
31</div>
32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
33<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_random/reference.html#header.boost.random.lagged_fibonacci_hpp" title="Header &lt;boost/random/lagged_fibonacci.hpp&gt;">boost/random/lagged_fibonacci.hpp</a>&gt;
34
35</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RealType<span class="special">,</span> <span class="keyword">int</span> w<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> p<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> q<span class="special">&gt;</span>
36<span class="keyword">class</span> <a class="link" href="lagged_fibonacci_01_engine.html" title="Class template lagged_fibonacci_01_engine">lagged_fibonacci_01_engine</a> <span class="special">{</span>
37<span class="keyword">public</span><span class="special">:</span>
38  <span class="comment">// types</span>
39  <span class="keyword">typedef</span> <span class="identifier">RealType</span> <a name="boost.random.lagged_fibonacci_01_engine.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
40
41  <span class="comment">// <a class="link" href="lagged_fibonacci_01_engine.html#boost.random.lagged_fibonacci_01_engineconstruct-copy-destruct">construct/copy/destruct</a></span>
42  <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_10-bb"><span class="identifier">lagged_fibonacci_01_engine</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
43  <span class="keyword">explicit</span> <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_11-bb"><span class="identifier">lagged_fibonacci_01_engine</span></a><span class="special">(</span><span class="identifier">uint32_t</span><span class="special">)</span><span class="special">;</span>
44  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SeedSeq<span class="special">&gt;</span> <span class="keyword">explicit</span> <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_12-bb"><span class="identifier">lagged_fibonacci_01_engine</span></a><span class="special">(</span><span class="identifier">SeedSeq</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
45  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> It<span class="special">&gt;</span> <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_13-bb"><span class="identifier">lagged_fibonacci_01_engine</span></a><span class="special">(</span><span class="identifier">It</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">It</span><span class="special">)</span><span class="special">;</span>
46
47  <span class="comment">// <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_9-bb">public member functions</a></span>
48  <span class="keyword">void</span> <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_9_1-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
49  <span class="keyword">void</span> <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_9_2-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint32_t</span><span class="special">)</span><span class="special">;</span>
50  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SeedSeq<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_9_3-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="identifier">SeedSeq</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
51  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> It<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_9_4-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="identifier">It</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">It</span><span class="special">)</span><span class="special">;</span>
52  <span class="identifier">result_type</span> <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_9_5-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>
53  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Iter<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_9_6-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>
54  <span class="keyword">void</span> <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_9_7-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>
55
56  <span class="comment">// <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_14-bb">public static functions</a></span>
57  <span class="keyword">static</span> <span class="identifier">result_type</span> <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_14_1-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
58  <span class="keyword">static</span> <span class="identifier">result_type</span> <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_14_2-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
59
60  <span class="comment">// <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_15-bb">friend functions</a></span>
61  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span>
62    <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
63    <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_15_1-bb"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span>
64               <span class="keyword">const</span> <a class="link" href="lagged_fibonacci_01_engine.html" title="Class template lagged_fibonacci_01_engine">lagged_fibonacci_01_engine</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
65  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span>
66    <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
67    <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_15_2-bb"><span class="keyword">operator</span><span class="special">&gt;&gt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span>
68               <span class="keyword">const</span> <a class="link" href="lagged_fibonacci_01_engine.html" title="Class template lagged_fibonacci_01_engine">lagged_fibonacci_01_engine</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
69  <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_15_3-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="lagged_fibonacci_01_engine.html" title="Class template lagged_fibonacci_01_engine">lagged_fibonacci_01_engine</a> <span class="special">&amp;</span><span class="special">,</span>
70                         <span class="keyword">const</span> <a class="link" href="lagged_fibonacci_01_engine.html" title="Class template lagged_fibonacci_01_engine">lagged_fibonacci_01_engine</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
71  <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="lagged_fibonacci_01_engine.html#id-1_3_34_5_6_21_1_1_1_15_4-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="lagged_fibonacci_01_engine.html" title="Class template lagged_fibonacci_01_engine">lagged_fibonacci_01_engine</a> <span class="special">&amp;</span><span class="special">,</span>
72                         <span class="keyword">const</span> <a class="link" href="lagged_fibonacci_01_engine.html" title="Class template lagged_fibonacci_01_engine">lagged_fibonacci_01_engine</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
73
74  <span class="comment">// public data members</span>
75  <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>
76  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">int</span> <span class="identifier">word_size</span><span class="special">;</span>
77  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">long_lag</span><span class="special">;</span>
78  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="identifier">short_lag</span><span class="special">;</span>
79  <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint32_t</span> <span class="identifier">default_seed</span><span class="special">;</span>
80<span class="special">}</span><span class="special">;</span></pre></div>
81<div class="refsect1">
82<a name="id-1.3.34.5.6.20.3.4"></a><h2>Description</h2>
83<p>Instantiations of class template <code class="computeroutput">lagged_fibonacci_01</code> model 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 a lagged Fibonacci algorithm with two lags <code class="computeroutput">p</code> and <code class="computeroutput">q</code>, evaluated in floating-point arithmetic: x(i) = x(i-p) + x(i-q) (mod 1) with p &gt; q. See</p>
84<p> </p>
85<div class="blockquote"><blockquote class="blockquote"><p>  "Uniform random number generators for supercomputers", Richard Brent, Proc. of Fifth Australian Supercomputer Conference, Melbourne, Dec. 1992, pp. 704-706.  </p></blockquote></div>
86<p> </p>
87<p> </p>
88<div class="note"><table border="0" summary="Note">
89<tr>
90<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
91<th align="left">Note</th>
92</tr>
93<tr><td align="left" valign="top"><p>  The quality of the generator crucially depends on the choice of the parameters. User code should employ one of the sensibly parameterized generators such as <a class="link" href="lagged_fibonacci607.html" title="Type definition lagged_fibonacci607">lagged_fibonacci607</a>  instead.  </p></td></tr>
94</table></div>
95<p> </p>
96<p>The generator requires considerable amounts of memory for the storage of its state array. For example, <a class="link" href="lagged_fibonacci607.html" title="Type definition lagged_fibonacci607">lagged_fibonacci607</a>  requires about 4856 bytes and <a class="link" href="lagged_fibonacci44497.html" title="Type definition lagged_fibonacci44497">lagged_fibonacci44497</a>  requires about 350 KBytes. </p>
97<div class="refsect2">
98<a name="id-1.3.34.5.6.20.3.4.6"></a><h3>
99<a name="boost.random.lagged_fibonacci_01_engineconstruct-copy-destruct"></a><code class="computeroutput">lagged_fibonacci_01_engine</code>
100        public
101       construct/copy/destruct</h3>
102<div class="orderedlist"><ol class="orderedlist" type="1">
103<li class="listitem">
104<pre class="literallayout"><a name="id-1_3_34_5_6_21_1_1_1_10-bb"></a><span class="identifier">lagged_fibonacci_01_engine</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
105<p>Constructs a <code class="computeroutput">lagged_fibonacci_01</code> generator and calls <code class="computeroutput">seed()</code>. </p>
106</li>
107<li class="listitem">
108<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_34_5_6_21_1_1_1_11-bb"></a><span class="identifier">lagged_fibonacci_01_engine</span><span class="special">(</span><span class="identifier">uint32_t</span> value<span class="special">)</span><span class="special">;</span></pre>
109<p>Constructs a <code class="computeroutput">lagged_fibonacci_01</code> generator and calls <code class="computeroutput">seed(value)</code>. </p>
110</li>
111<li class="listitem">
112<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SeedSeq<span class="special">&gt;</span> <span class="keyword">explicit</span> <a name="id-1_3_34_5_6_21_1_1_1_12-bb"></a><span class="identifier">lagged_fibonacci_01_engine</span><span class="special">(</span><span class="identifier">SeedSeq</span> <span class="special">&amp;</span> seq<span class="special">)</span><span class="special">;</span></pre>
113<p>Constructs a <code class="computeroutput">lagged_fibonacci_01</code> generator and calls <code class="computeroutput">seed(gen)</code>. </p>
114</li>
115<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> It<span class="special">&gt;</span> <a name="id-1_3_34_5_6_21_1_1_1_13-bb"></a><span class="identifier">lagged_fibonacci_01_engine</span><span class="special">(</span><span class="identifier">It</span> <span class="special">&amp;</span> first<span class="special">,</span> <span class="identifier">It</span> last<span class="special">)</span><span class="special">;</span></pre></li>
116</ol></div>
117</div>
118<div class="refsect2">
119<a name="id-1.3.34.5.6.20.3.4.7"></a><h3>
120<a name="id-1_3_34_5_6_21_1_1_1_9-bb"></a><code class="computeroutput">lagged_fibonacci_01_engine</code> public member functions</h3>
121<div class="orderedlist"><ol class="orderedlist" type="1">
122<li class="listitem">
123<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_21_1_1_1_9_1-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
124<p>Calls seed(default_seed). </p>
125</li>
126<li class="listitem">
127<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_21_1_1_1_9_2-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint32_t</span> value<span class="special">)</span><span class="special">;</span></pre>
128<p>Constructs a <code class="computeroutput"><a class="link" href="minstd_rand0.html" title="Type definition minstd_rand0">minstd_rand0</a></code>  generator with the constructor parameter value and calls seed with it. Distinct seeds in the range [1, 2147483647) will produce generators with different states. Other seeds will be equivalent to some seed within this range. See  <code class="computeroutput"><a class="link" href="linear_congruential_engine.html" title="Class template linear_congruential_engine">linear_congruential_engine</a></code> for details. </p>
129</li>
130<li class="listitem">
131<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SeedSeq<span class="special">&gt;</span> <span class="keyword">void</span> <a name="id-1_3_34_5_6_21_1_1_1_9_3-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="identifier">SeedSeq</span> <span class="special">&amp;</span> seq<span class="special">)</span><span class="special">;</span></pre>
132<p>Seeds this <code class="computeroutput"><code class="computeroutput"><a class="link" href="lagged_fibonacci_01_engine.html" title="Class template lagged_fibonacci_01_engine">lagged_fibonacci_01_engine</a></code></code> using values produced by <code class="computeroutput">seq.generate</code>. </p>
133</li>
134<li class="listitem">
135<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> It<span class="special">&gt;</span> <span class="keyword">void</span> <a name="id-1_3_34_5_6_21_1_1_1_9_4-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="identifier">It</span> <span class="special">&amp;</span> first<span class="special">,</span> <span class="identifier">It</span> last<span class="special">)</span><span class="special">;</span></pre>
136<p>Seeds this <code class="computeroutput"><code class="computeroutput"><a class="link" href="lagged_fibonacci_01_engine.html" title="Class template lagged_fibonacci_01_engine">lagged_fibonacci_01_engine</a></code></code> using values from the iterator range [first, last). If there are not enough elements in the range, throws <code class="computeroutput">std::invalid_argument</code>. </p>
137</li>
138<li class="listitem">
139<pre class="literallayout"><span class="identifier">result_type</span> <a name="id-1_3_34_5_6_21_1_1_1_9_5-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>
140<p>Returns the next value of the generator. </p>
141</li>
142<li class="listitem">
143<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Iter<span class="special">&gt;</span> <span class="keyword">void</span> <a name="id-1_3_34_5_6_21_1_1_1_9_6-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>
144<p>Fills a range with random values </p>
145</li>
146<li class="listitem">
147<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_21_1_1_1_9_7-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>
148<p>Advances the state of the generator by <code class="computeroutput">z</code>. </p>
149</li>
150</ol></div>
151</div>
152<div class="refsect2">
153<a name="id-1.3.34.5.6.20.3.4.8"></a><h3>
154<a name="id-1_3_34_5_6_21_1_1_1_14-bb"></a><code class="computeroutput">lagged_fibonacci_01_engine</code> public static functions</h3>
155<div class="orderedlist"><ol class="orderedlist" type="1">
156<li class="listitem">
157<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">result_type</span> <a name="id-1_3_34_5_6_21_1_1_1_14_1-bb"></a><span class="identifier">min</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
158<p>Returns the smallest value that the generator can produce. </p>
159</li>
160<li class="listitem">
161<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">result_type</span> <a name="id-1_3_34_5_6_21_1_1_1_14_2-bb"></a><span class="identifier">max</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
162<p>Returns the upper bound of the generators outputs. </p>
163</li>
164</ol></div>
165</div>
166<div class="refsect2">
167<a name="id-1.3.34.5.6.20.3.4.9"></a><h3>
168<a name="id-1_3_34_5_6_21_1_1_1_15-bb"></a><code class="computeroutput">lagged_fibonacci_01_engine</code> friend functions</h3>
169<div class="orderedlist"><ol class="orderedlist" type="1">
170<li class="listitem">
171<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span>
172  <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
173  <a name="id-1_3_34_5_6_21_1_1_1_15_1-bb"></a><span class="keyword">operator</span><span class="special">&lt;&lt;</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> os<span class="special">,</span>
174             <span class="keyword">const</span> <a class="link" href="lagged_fibonacci_01_engine.html" title="Class template lagged_fibonacci_01_engine">lagged_fibonacci_01_engine</a> <span class="special">&amp;</span> f<span class="special">)</span><span class="special">;</span></pre>
175<p>Writes the textual representation of the generator to a <code class="computeroutput">std::ostream</code>. </p>
176</li>
177<li class="listitem">
178<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span>
179  <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
180  <a name="id-1_3_34_5_6_21_1_1_1_15_2-bb"></a><span class="keyword">operator</span><span class="special">&gt;&gt;</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> is<span class="special">,</span>
181             <span class="keyword">const</span> <a class="link" href="lagged_fibonacci_01_engine.html" title="Class template lagged_fibonacci_01_engine">lagged_fibonacci_01_engine</a> <span class="special">&amp;</span> f<span class="special">)</span><span class="special">;</span></pre>
182<p>Reads the textual representation of the generator from a <code class="computeroutput">std::istream</code>. </p>
183</li>
184<li class="listitem">
185<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_21_1_1_1_15_3-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="lagged_fibonacci_01_engine.html" title="Class template lagged_fibonacci_01_engine">lagged_fibonacci_01_engine</a> <span class="special">&amp;</span> x_<span class="special">,</span>
186                       <span class="keyword">const</span> <a class="link" href="lagged_fibonacci_01_engine.html" title="Class template lagged_fibonacci_01_engine">lagged_fibonacci_01_engine</a> <span class="special">&amp;</span> y_<span class="special">)</span><span class="special">;</span></pre>
187<p>Returns true if the two generators will produce identical sequences of outputs. </p>
188</li>
189<li class="listitem">
190<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_21_1_1_1_15_4-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="lagged_fibonacci_01_engine.html" title="Class template lagged_fibonacci_01_engine">lagged_fibonacci_01_engine</a> <span class="special">&amp;</span> lhs<span class="special">,</span>
191                       <span class="keyword">const</span> <a class="link" href="lagged_fibonacci_01_engine.html" title="Class template lagged_fibonacci_01_engine">lagged_fibonacci_01_engine</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
192<p>Returns true if the two generators will produce different sequences of outputs. </p>
193</li>
194</ol></div>
195</div>
196</div>
197</div>
198<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
199<td align="left"></td>
200<td align="right"><div class="copyright-footer">Copyright © 2000-2005 Jens Maurer<br>Copyright © 2009, 2010 Steven Watanabe<p>
201        Distributed under the Boost Software License, Version 1.0. (See accompanying
202        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>)
203      </p>
204</div></td>
205</tr></table>
206<hr>
207<div class="spirit-nav">
208<a accesskey="p" href="hellekalek1995.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.lagged_fibonacci_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="lagged_fibonacci_engine.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
209</div>
210</body>
211</html>
212