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 additive_combine_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.additive_combine_hpp" title="Header <boost/random/additive_combine.hpp>"> 10<link rel="prev" href="../../boost_random/reference.html" title="Reference"> 11<link rel="next" href="ecuyer1988.html" title="Type definition ecuyer1988"> 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="../../boost_random/reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.additive_combine_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="ecuyer1988.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.random.additive_combine_engine"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template additive_combine_engine</span></h2> 30<p>boost::random::additive_combine_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: <<a class="link" href="../../boost_random/reference.html#header.boost.random.additive_combine_hpp" title="Header <boost/random/additive_combine.hpp>">boost/random/additive_combine.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> MLCG1<span class="special">,</span> <span class="keyword">typename</span> MLCG2<span class="special">></span> 36<span class="keyword">class</span> <a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_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">MLCG1</span> <a name="boost.random.additive_combine_engine.first_base"></a><span class="identifier">first_base</span><span class="special">;</span> 40 <span class="keyword">typedef</span> <span class="identifier">MLCG2</span> <a name="boost.random.additive_combine_engine.second_base"></a><span class="identifier">second_base</span><span class="special">;</span> 41 <span class="keyword">typedef</span> <span class="identifier">MLCG1</span><span class="special">::</span><span class="identifier">result_type</span> <a name="boost.random.additive_combine_engine.result_type"></a><span class="identifier">result_type</span><span class="special">;</span> 42 43 <span class="comment">// <a class="link" href="additive_combine_engine.html#boost.random.additive_combine_engineconstruct-copy-destruct">construct/copy/destruct</a></span> 44 <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_9-bb"><span class="identifier">additive_combine_engine</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 45 <span class="keyword">explicit</span> <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_10-bb"><span class="identifier">additive_combine_engine</span></a><span class="special">(</span><span class="identifier">result_type</span><span class="special">)</span><span class="special">;</span> 46 <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="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_11-bb"><span class="identifier">additive_combine_engine</span></a><span class="special">(</span><span class="identifier">SeedSeq</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 47 <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_12-bb"><span class="identifier">additive_combine_engine</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">MLCG1</span><span class="special">::</span><span class="identifier">result_type</span><span class="special">,</span> 48 <span class="keyword">typename</span> <span class="identifier">MLCG2</span><span class="special">::</span><span class="identifier">result_type</span><span class="special">)</span><span class="special">;</span> 49 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> It<span class="special">></span> <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_13-bb"><span class="identifier">additive_combine_engine</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> 50 51 <span class="comment">// <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_7-bb">public static functions</a></span> 52 <span class="keyword">static</span> <span class="identifier">result_type</span> <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_7_1-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 53 <span class="keyword">static</span> <span class="identifier">result_type</span> <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_7_2-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 54 55 <span class="comment">// <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_8-bb">public member functions</a></span> 56 <span class="keyword">void</span> <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_8_1-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 57 <span class="keyword">void</span> <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_8_2-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> 58 <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="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_8_3-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> 59 <span class="keyword">void</span> <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_8_4-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">MLCG1</span><span class="special">::</span><span class="identifier">result_type</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">MLCG2</span><span class="special">::</span><span class="identifier">result_type</span><span class="special">)</span><span class="special">;</span> 60 <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="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_8_5-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> 61 <span class="identifier">result_type</span> <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_8_6-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> 62 <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="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_8_7-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> 63 <span class="keyword">void</span> <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_8_8-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> 64 65 <span class="comment">// <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_14-bb">friend functions</a></span> 66 <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> 67 <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> 68 <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_14_1-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> 69 <span class="keyword">const</span> <a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 70 <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> 71 <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> 72 <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_14_2-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> 73 <span class="keyword">const</span> <a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 74 <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_14_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="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a> <span class="special">&</span><span class="special">,</span> 75 <span class="keyword">const</span> <a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 76 <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="additive_combine_engine.html#id-1_3_34_5_6_3_1_1_1_14_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="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a> <span class="special">&</span><span class="special">,</span> 77 <span class="keyword">const</span> <a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 78 79 <span class="comment">// public data members</span> 80 <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> 81<span class="special">}</span><span class="special">;</span></pre></div> 82<div class="refsect1"> 83<a name="id-1.3.34.5.6.2.3.4"></a><h2>Description</h2> 84<p>An instantiation of class template <code class="computeroutput"><a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</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 combines two multiplicative <a class="link" href="linear_congruential_engine.html" title="Class template linear_congruential_engine">linear_congruential_engine</a> number generators, i.e. those with <code class="computeroutput">c</code> = 0. It is described in</p> 85<p> </p> 86<div class="blockquote"><blockquote class="blockquote"><p> "Efficient and Portable Combined Random Number Generators", Pierre L'Ecuyer, Communications of the ACM, Vol. 31, No. 6, June 1988, pp. 742-749, 774 </p></blockquote></div> 87<p> </p> 88<p>The template parameters MLCG1 and MLCG2 shall denote two different <a class="link" href="linear_congruential_engine.html" title="Class template linear_congruential_engine">linear_congruential_engine</a> number generators, each with c = 0. Each invocation returns a random number X(n) := (MLCG1(n) - MLCG2(n)) mod (m1 - 1), where m1 denotes the modulus of MLCG1. </p> 89<div class="refsect2"> 90<a name="id-1.3.34.5.6.2.3.4.5"></a><h3> 91<a name="boost.random.additive_combine_engineconstruct-copy-destruct"></a><code class="computeroutput">additive_combine_engine</code> 92 public 93 construct/copy/destruct</h3> 94<div class="orderedlist"><ol class="orderedlist" type="1"> 95<li class="listitem"> 96<pre class="literallayout"><a name="id-1_3_34_5_6_3_1_1_1_9-bb"></a><span class="identifier">additive_combine_engine</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 97<p>Constructs an <code class="computeroutput"><code class="computeroutput"><a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a></code></code> using the default constructors of the two base generators. </p> 98</li> 99<li class="listitem"> 100<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_34_5_6_3_1_1_1_10-bb"></a><span class="identifier">additive_combine_engine</span><span class="special">(</span><span class="identifier">result_type</span> seed<span class="special">)</span><span class="special">;</span></pre> 101<p>Constructs an <code class="computeroutput"><code class="computeroutput"><a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a></code></code>, using seed as the constructor argument for both base generators. </p> 102</li> 103<li class="listitem"> 104<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="id-1_3_34_5_6_3_1_1_1_11-bb"></a><span class="identifier">additive_combine_engine</span><span class="special">(</span><span class="identifier">SeedSeq</span> <span class="special">&</span> seq<span class="special">)</span><span class="special">;</span></pre> 105<p>Constructs an <code class="computeroutput"><code class="computeroutput"><a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a></code></code>, using seq as the constructor argument for both base generators.</p> 106<p> </p> 107<div class="warning"><table border="0" summary="Warning"> 108<tr> 109<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../doc/src/images/warning.png"></td> 110<th align="left">Warning</th> 111</tr> 112<tr><td align="left" valign="top"><p> The semantics of this function are liable to change. A <code class="computeroutput"><code class="computeroutput"><a class="link" href="seed_seq.html" title="Class seed_seq">seed_seq</a></code></code> is designed to generate all the seeds in one shot, but this seeds the two base engines independantly and probably ends up giving the same sequence to both. </p></td></tr> 113</table></div> 114<p> </p> 115</li> 116<li class="listitem"> 117<pre class="literallayout"><a name="id-1_3_34_5_6_3_1_1_1_12-bb"></a><span class="identifier">additive_combine_engine</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">MLCG1</span><span class="special">::</span><span class="identifier">result_type</span> seed1<span class="special">,</span> 118 <span class="keyword">typename</span> <span class="identifier">MLCG2</span><span class="special">::</span><span class="identifier">result_type</span> seed2<span class="special">)</span><span class="special">;</span></pre> 119<p>Constructs an <code class="computeroutput"><code class="computeroutput"><a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a></code></code>, using <code class="computeroutput">seed1</code> and <code class="computeroutput">seed2</code> as the constructor argument to the first and second base generators, respectively. </p> 120</li> 121<li class="listitem"> 122<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> It<span class="special">></span> <a name="id-1_3_34_5_6_3_1_1_1_13-bb"></a><span class="identifier">additive_combine_engine</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> 123<p>Contructs an <code class="computeroutput"><code class="computeroutput"><a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a></code></code> with values from the range defined by the input iterators first and last. first will be modified to point to the element after the last one used.</p> 124<p>Throws: <code class="computeroutput">std::invalid_argument</code> if the input range is too small.</p> 125<p>Exception Safety: Basic </p> 126</li> 127</ol></div> 128</div> 129<div class="refsect2"> 130<a name="id-1.3.34.5.6.2.3.4.6"></a><h3> 131<a name="id-1_3_34_5_6_3_1_1_1_7-bb"></a><code class="computeroutput">additive_combine_engine</code> public static functions</h3> 132<div class="orderedlist"><ol class="orderedlist" type="1"> 133<li class="listitem"> 134<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">result_type</span> <a name="id-1_3_34_5_6_3_1_1_1_7_1-bb"></a><span class="identifier">min</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 135<p>Returns the smallest value that the generator can produce </p> 136</li> 137<li class="listitem"> 138<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">result_type</span> <a name="id-1_3_34_5_6_3_1_1_1_7_2-bb"></a><span class="identifier">max</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 139<p>Returns the largest value that the generator can produce </p> 140</li> 141</ol></div> 142</div> 143<div class="refsect2"> 144<a name="id-1.3.34.5.6.2.3.4.7"></a><h3> 145<a name="id-1_3_34_5_6_3_1_1_1_8-bb"></a><code class="computeroutput">additive_combine_engine</code> public member functions</h3> 146<div class="orderedlist"><ol class="orderedlist" type="1"> 147<li class="listitem"> 148<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_3_1_1_1_8_1-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 149<p>Seeds an <code class="computeroutput"><code class="computeroutput"><a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a></code></code> using the default seeds of the two base generators. </p> 150</li> 151<li class="listitem"> 152<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_3_1_1_1_8_2-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="identifier">result_type</span> seed<span class="special">)</span><span class="special">;</span></pre> 153<p>Seeds an <code class="computeroutput"><code class="computeroutput"><a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a></code></code>, using <code class="computeroutput">seed</code> as the seed for both base generators. </p> 154</li> 155<li class="listitem"> 156<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="id-1_3_34_5_6_3_1_1_1_8_3-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> 157<p>Seeds an <code class="computeroutput"><code class="computeroutput"><a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a></code></code>, using <code class="computeroutput">seq</code> to seed both base generators.</p> 158<p>See the warning on the corresponding constructor. </p> 159</li> 160<li class="listitem"> 161<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_3_1_1_1_8_4-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">MLCG1</span><span class="special">::</span><span class="identifier">result_type</span> seed1<span class="special">,</span> 162 <span class="keyword">typename</span> <span class="identifier">MLCG2</span><span class="special">::</span><span class="identifier">result_type</span> seed2<span class="special">)</span><span class="special">;</span></pre> 163<p>Seeds an <code class="computeroutput">additive_combine</code> generator, using <code class="computeroutput">seed1</code> and <code class="computeroutput">seed2</code> as the seeds to the first and second base generators, respectively. </p> 164</li> 165<li class="listitem"> 166<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="id-1_3_34_5_6_3_1_1_1_8_5-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> 167<p>Seeds an <code class="computeroutput"><code class="computeroutput"><a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a></code></code> with values from the range defined by the input iterators first and last. first will be modified to point to the element after the last one used.</p> 168<p>Throws: <code class="computeroutput">std::invalid_argument</code> if the input range is too small.</p> 169<p>Exception Safety: Basic </p> 170</li> 171<li class="listitem"> 172<pre class="literallayout"><span class="identifier">result_type</span> <a name="id-1_3_34_5_6_3_1_1_1_8_6-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> 173<p>Returns the next value of the generator. </p> 174</li> 175<li class="listitem"> 176<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="id-1_3_34_5_6_3_1_1_1_8_7-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> 177<p>Fills a range with random values </p> 178</li> 179<li class="listitem"> 180<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_3_1_1_1_8_8-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> 181<p>Advances the state of the generator by <code class="computeroutput">z</code>. </p> 182</li> 183</ol></div> 184</div> 185<div class="refsect2"> 186<a name="id-1.3.34.5.6.2.3.4.8"></a><h3> 187<a name="id-1_3_34_5_6_3_1_1_1_14-bb"></a><code class="computeroutput">additive_combine_engine</code> friend functions</h3> 188<div class="orderedlist"><ol class="orderedlist" type="1"> 189<li class="listitem"> 190<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> 191 <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> 192 <a name="id-1_3_34_5_6_3_1_1_1_14_1-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> 193 <span class="keyword">const</span> <a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> 194<p>Writes the state of an <code class="computeroutput"><code class="computeroutput"><a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a></code></code> to a <code class="computeroutput">std::ostream</code>. The textual representation of an <code class="computeroutput"><code class="computeroutput"><a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a></code></code> is the textual representation of the first base generator followed by the textual representation of the second base generator. </p> 195</li> 196<li class="listitem"> 197<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> 198 <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> 199 <a name="id-1_3_34_5_6_3_1_1_1_14_2-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> 200 <span class="keyword">const</span> <a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> 201<p>Reads the state of an <code class="computeroutput"><code class="computeroutput"><a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a></code></code> from a <code class="computeroutput">std::istream</code>. </p> 202</li> 203<li class="listitem"> 204<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_3_1_1_1_14_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="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a> <span class="special">&</span> x<span class="special">,</span> 205 <span class="keyword">const</span> <a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a> <span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre> 206<p>Returns: true iff the two <code class="computeroutput">additive_combine_engines</code> will produce the same sequence of values. </p> 207</li> 208<li class="listitem"> 209<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_3_1_1_1_14_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="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a> <span class="special">&</span> lhs<span class="special">,</span> 210 <span class="keyword">const</span> <a class="link" href="additive_combine_engine.html" title="Class template additive_combine_engine">additive_combine_engine</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> 211<p>Returns: true iff the two <code class="computeroutput">additive_combine_engines</code> will produce different sequences of values. </p> 212</li> 213</ol></div> 214</div> 215</div> 216</div> 217<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 218<td align="left"></td> 219<td align="right"><div class="copyright-footer">Copyright © 2000-2005 Jens Maurer<br>Copyright © 2009, 2010 Steven Watanabe<p> 220 Distributed under the Boost Software License, Version 1.0. (See accompanying 221 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>) 222 </p> 223</div></td> 224</tr></table> 225<hr> 226<div class="spirit-nav"> 227<a accesskey="p" href="../../boost_random/reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.additive_combine_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="ecuyer1988.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 228</div> 229</body> 230</html> 231
