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 xor_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.xor_combine_hpp" title="Header <boost/random/xor_combine.hpp>"> 10<link rel="prev" href="weibull_distribution/param_type.html" title="Class param_type"> 11<link rel="next" href="../../boost_random/performance.html" title="Performance"> 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="weibull_distribution/param_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.xor_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="../../boost_random/performance.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.random.xor_combine_engine"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template xor_combine_engine</span></h2> 30<p>boost::random::xor_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.xor_combine_hpp" title="Header <boost/random/xor_combine.hpp>">boost/random/xor_combine.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> URNG1<span class="special">,</span> <span class="keyword">int</span> s1<span class="special">,</span> <span class="keyword">typename</span> URNG2<span class="special">,</span> <span class="keyword">int</span> s2<span class="special">></span> 36<span class="keyword">class</span> <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_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">URNG1</span> <a name="boost.random.xor_combine_engine.base1_type"></a><span class="identifier">base1_type</span><span class="special">;</span> 40 <span class="keyword">typedef</span> <span class="identifier">URNG2</span> <a name="boost.random.xor_combine_engine.base2_type"></a><span class="identifier">base2_type</span><span class="special">;</span> 41 <span class="keyword">typedef</span> <span class="identifier">base1_type</span><span class="special">::</span><span class="identifier">result_type</span> <a name="boost.random.xor_combine_engine.result_type"></a><span class="identifier">result_type</span><span class="special">;</span> 42 43 <span class="comment">// <a class="link" href="xor_combine_engine.html#boost.random.xor_combine_engineconstruct-copy-destruct">construct/copy/destruct</a></span> 44 <a class="link" href="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_10-bb"><span class="identifier">xor_combine_engine</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 45 <a class="link" href="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_11-bb"><span class="identifier">xor_combine_engine</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">base1_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">base2_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 46 <span class="keyword">explicit</span> <a class="link" href="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_12-bb"><span class="identifier">xor_combine_engine</span></a><span class="special">(</span><span class="identifier">result_type</span><span class="special">)</span><span class="special">;</span> 47 <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="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_13-bb"><span class="identifier">xor_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> 48 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> It<span class="special">></span> <a class="link" href="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_14-bb"><span class="identifier">xor_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> 49 50 <span class="comment">// <a class="link" href="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_9-bb">public member functions</a></span> 51 <span class="keyword">void</span> <a class="link" href="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_9_1-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 52 <span class="keyword">void</span> <a class="link" href="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_9_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> 53 <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="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_9_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> 54 <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="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_9_4-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> 55 <span class="keyword">const</span> <span class="identifier">base1_type</span> <span class="special">&</span> <a class="link" href="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_9_5-bb"><span class="identifier">base1</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 56 <span class="keyword">const</span> <span class="identifier">base2_type</span> <span class="special">&</span> <a class="link" href="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_9_6-bb"><span class="identifier">base2</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 57 <span class="identifier">result_type</span> <a class="link" href="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_9_7-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> 58 <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="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_9_8-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> 59 <span class="keyword">void</span> <a class="link" href="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_9_9-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> 60 61 <span class="comment">// <a class="link" href="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_15-bb">public static functions</a></span> 62 <span class="keyword">static</span> <span class="identifier">result_type</span> <a class="link" href="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_15_1-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 63 <span class="keyword">static</span> <span class="identifier">result_type</span> <a class="link" href="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_15_2-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 64 65 <span class="comment">// <a class="link" href="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_16-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="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_16_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="xor_combine_engine.html" title="Class template xor_combine_engine">xor_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="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_16_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="xor_combine_engine.html" title="Class template xor_combine_engine">xor_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="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_16_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="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> <span class="special">&</span><span class="special">,</span> 75 <span class="keyword">const</span> <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_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="xor_combine_engine.html#id-1_3_34_5_6_52_1_1_1_16_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="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> <span class="special">&</span><span class="special">,</span> 77 <span class="keyword">const</span> <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_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="keyword">static</span> <span class="keyword">const</span> <span class="keyword">int</span> <span class="identifier">shift1</span><span class="special">;</span> 82 <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">int</span> <span class="identifier">shift2</span><span class="special">;</span> 83<span class="special">}</span><span class="special">;</span></pre></div> 84<div class="refsect1"> 85<a name="id-1.3.34.5.6.51.3.4"></a><h2>Description</h2> 86<p>Instantiations of <code class="computeroutput"><a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a></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> . To produce its output it invokes each of the base generators, shifts their results and xors them together. </p> 87<div class="refsect2"> 88<a name="id-1.3.34.5.6.51.3.4.3"></a><h3> 89<a name="boost.random.xor_combine_engineconstruct-copy-destruct"></a><code class="computeroutput">xor_combine_engine</code> 90 public 91 construct/copy/destruct</h3> 92<div class="orderedlist"><ol class="orderedlist" type="1"> 93<li class="listitem"> 94<pre class="literallayout"><a name="id-1_3_34_5_6_52_1_1_1_10-bb"></a><span class="identifier">xor_combine_engine</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 95<p>Constructors a <code class="computeroutput"><code class="computeroutput"><a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a></code></code> by default constructing both base generators. </p> 96</li> 97<li class="listitem"> 98<pre class="literallayout"><a name="id-1_3_34_5_6_52_1_1_1_11-bb"></a><span class="identifier">xor_combine_engine</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">base1_type</span> <span class="special">&</span> rng1<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">base2_type</span> <span class="special">&</span> rng2<span class="special">)</span><span class="special">;</span></pre> 99<p>Constructs a <code class="computeroutput">xor_combine</code> by copying two base generators. </p> 100</li> 101<li class="listitem"> 102<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_34_5_6_52_1_1_1_12-bb"></a><span class="identifier">xor_combine_engine</span><span class="special">(</span><span class="identifier">result_type</span> v<span class="special">)</span><span class="special">;</span></pre> 103<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a></code></code>, seeding both base generators with <code class="computeroutput">v</code>.</p> 104<p> </p> 105<div class="warning"><table border="0" summary="Warning"> 106<tr> 107<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../doc/src/images/warning.png"></td> 108<th align="left">Warning</th> 109</tr> 110<tr><td align="left" valign="top"><p> The exact algorithm used by this function may change in the future. </p></td></tr> 111</table></div> 112<p> </p> 113</li> 114<li class="listitem"> 115<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_52_1_1_1_13-bb"></a><span class="identifier">xor_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> 116<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a></code></code>, seeding both base generators with values produced by <code class="computeroutput">seq</code>. </p> 117</li> 118<li class="listitem"> 119<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_52_1_1_1_14-bb"></a><span class="identifier">xor_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> 120<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a></code></code>, seeding both base generators with values from the iterator range [first, last) and changes first to point to the element after the last one used. If there are not enough elements in the range to seed both generators, throws <code class="computeroutput">std::invalid_argument</code>. </p> 121</li> 122</ol></div> 123</div> 124<div class="refsect2"> 125<a name="id-1.3.34.5.6.51.3.4.4"></a><h3> 126<a name="id-1_3_34_5_6_52_1_1_1_9-bb"></a><code class="computeroutput">xor_combine_engine</code> public member functions</h3> 127<div class="orderedlist"><ol class="orderedlist" type="1"> 128<li class="listitem"> 129<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_52_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> 130<p>Calls <code class="computeroutput">seed()</code> for both base generators. </p> 131</li> 132<li class="listitem"> 133<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_52_1_1_1_9_2-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="identifier">result_type</span> v<span class="special">)</span><span class="special">;</span></pre> 134<p><code class="computeroutput">seeds</code> both base generators with <code class="computeroutput">v</code>. </p> 135</li> 136<li class="listitem"> 137<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_52_1_1_1_9_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> 138<p><code class="computeroutput">seeds</code> both base generators with values produced by <code class="computeroutput">seq</code>. </p> 139</li> 140<li class="listitem"> 141<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_52_1_1_1_9_4-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> 142<p>seeds both base generators with values from the iterator range [first, last) and changes first to point to the element after the last one used. If there are not enough elements in the range to seed both generators, throws <code class="computeroutput">std::invalid_argument</code>. </p> 143</li> 144<li class="listitem"> 145<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">base1_type</span> <span class="special">&</span> <a name="id-1_3_34_5_6_52_1_1_1_9_5-bb"></a><span class="identifier">base1</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 146<p>Returns the first base generator. </p> 147</li> 148<li class="listitem"> 149<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">base2_type</span> <span class="special">&</span> <a name="id-1_3_34_5_6_52_1_1_1_9_6-bb"></a><span class="identifier">base2</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 150<p>Returns the second base generator. </p> 151</li> 152<li class="listitem"> 153<pre class="literallayout"><span class="identifier">result_type</span> <a name="id-1_3_34_5_6_52_1_1_1_9_7-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> 154<p>Returns the next value of the generator. </p> 155</li> 156<li class="listitem"> 157<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_52_1_1_1_9_8-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> 158<p>Fills a range with random values </p> 159</li> 160<li class="listitem"> 161<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_52_1_1_1_9_9-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> 162<p>Advances the state of the generator by <code class="computeroutput">z</code>. </p> 163</li> 164</ol></div> 165</div> 166<div class="refsect2"> 167<a name="id-1.3.34.5.6.51.3.4.5"></a><h3> 168<a name="id-1_3_34_5_6_52_1_1_1_15-bb"></a><code class="computeroutput">xor_combine_engine</code> public static functions</h3> 169<div class="orderedlist"><ol class="orderedlist" type="1"> 170<li class="listitem"> 171<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">result_type</span> <a name="id-1_3_34_5_6_52_1_1_1_15_1-bb"></a><span class="identifier">min</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 172<p>Returns the smallest value that the generator can produce. </p> 173</li> 174<li class="listitem"> 175<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">result_type</span> <a name="id-1_3_34_5_6_52_1_1_1_15_2-bb"></a><span class="identifier">max</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 176<p>Returns the largest value that the generator can produce. </p> 177</li> 178</ol></div> 179</div> 180<div class="refsect2"> 181<a name="id-1.3.34.5.6.51.3.4.6"></a><h3> 182<a name="id-1_3_34_5_6_52_1_1_1_16-bb"></a><code class="computeroutput">xor_combine_engine</code> friend functions</h3> 183<div class="orderedlist"><ol class="orderedlist" type="1"> 184<li class="listitem"> 185<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> 186 <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> 187 <a name="id-1_3_34_5_6_52_1_1_1_16_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> 188 <span class="keyword">const</span> <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> <span class="special">&</span> s<span class="special">)</span><span class="special">;</span></pre> 189<p>Writes the textual representation of the generator to a <code class="computeroutput">std::ostream</code>. </p> 190</li> 191<li class="listitem"> 192<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> 193 <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> 194 <a name="id-1_3_34_5_6_52_1_1_1_16_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> 195 <span class="keyword">const</span> <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> <span class="special">&</span> s<span class="special">)</span><span class="special">;</span></pre> 196<p>Reads the textual representation of the generator from a <code class="computeroutput">std::istream</code>. </p> 197</li> 198<li class="listitem"> 199<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_52_1_1_1_16_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="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> <span class="special">&</span> x<span class="special">,</span> 200 <span class="keyword">const</span> <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> <span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre> 201<p>Returns true if the two generators will produce identical sequences. </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_52_1_1_1_16_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="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> <span class="special">&</span> lhs<span class="special">,</span> 205 <span class="keyword">const</span> <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> 206<p>Returns true if the two generators will produce different sequences. </p> 207</li> 208</ol></div> 209</div> 210</div> 211</div> 212<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 213<td align="left"></td> 214<td align="right"><div class="copyright-footer">Copyright © 2000-2005 Jens Maurer<br>Copyright © 2009, 2010 Steven Watanabe<p> 215 Distributed under the Boost Software License, Version 1.0. (See accompanying 216 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>) 217 </p> 218</div></td> 219</tr></table> 220<hr> 221<div class="spirit-nav"> 222<a accesskey="p" href="weibull_distribution/param_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.xor_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="../../boost_random/performance.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 223</div> 224</body> 225</html> 226
