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 shuffle_order_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.shuffle_order_hpp" title="Header <boost/random/shuffle_order.hpp>"> 10<link rel="prev" href="seed_seq.html" title="Class seed_seq"> 11<link rel="next" href="kreutzer1986.html" title="Type definition kreutzer1986"> 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="seed_seq.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.shuffle_order_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="kreutzer1986.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.random.shuffle_order_engine"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template shuffle_order_engine</span></h2> 30<p>boost::random::shuffle_order_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.shuffle_order_hpp" title="Header <boost/random/shuffle_order.hpp>">boost/random/shuffle_order.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> UniformRandomNumberGenerator<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> k<span class="special">></span> 36<span class="keyword">class</span> <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_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">UniformRandomNumberGenerator</span> <a name="boost.random.shuffle_order_engine.base_type"></a><span class="identifier">base_type</span><span class="special">;</span> 40 <span class="keyword">typedef</span> <span class="identifier">base_type</span><span class="special">::</span><span class="identifier">result_type</span> <a name="boost.random.shuffle_order_engine.result_type"></a><span class="identifier">result_type</span><span class="special">;</span> 41 42 <span class="comment">// <a class="link" href="shuffle_order_engine.html#boost.random.shuffle_order_engineconstruct-copy-destruct">construct/copy/destruct</a></span> 43 <a class="link" href="shuffle_order_engine.html#id-1_3_34_5_6_38_1_1_1_9-bb"><span class="identifier">shuffle_order_engine</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 44 <span class="keyword">explicit</span> <a class="link" href="shuffle_order_engine.html#id-1_3_34_5_6_38_1_1_1_10-bb"><span class="identifier">shuffle_order_engine</span></a><span class="special">(</span><span class="identifier">result_type</span><span class="special">)</span><span class="special">;</span> 45 <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="shuffle_order_engine.html#id-1_3_34_5_6_38_1_1_1_11-bb"><span class="identifier">shuffle_order_engine</span></a><span class="special">(</span><span class="identifier">SeedSeq</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 46 <span class="keyword">explicit</span> <a class="link" href="shuffle_order_engine.html#id-1_3_34_5_6_38_1_1_1_12-bb"><span class="identifier">shuffle_order_engine</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">base_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 47 <span class="keyword">explicit</span> <a class="link" href="shuffle_order_engine.html#id-1_3_34_5_6_38_1_1_1_13-bb"><span class="identifier">shuffle_order_engine</span></a><span class="special">(</span><span class="identifier">base_type</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="shuffle_order_engine.html#id-1_3_34_5_6_38_1_1_1_14-bb"><span class="identifier">shuffle_order_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="shuffle_order_engine.html#id-1_3_34_5_6_38_1_1_1_8-bb">public member functions</a></span> 51 <span class="keyword">void</span> <a class="link" href="shuffle_order_engine.html#id-1_3_34_5_6_38_1_1_1_8_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="shuffle_order_engine.html#id-1_3_34_5_6_38_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> 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="shuffle_order_engine.html#id-1_3_34_5_6_38_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> 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="shuffle_order_engine.html#id-1_3_34_5_6_38_1_1_1_8_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">base_type</span> <span class="special">&</span> <a class="link" href="shuffle_order_engine.html#id-1_3_34_5_6_38_1_1_1_8_5-bb"><span class="identifier">base</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 56 <span class="identifier">result_type</span> <a class="link" href="shuffle_order_engine.html#id-1_3_34_5_6_38_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> 57 <span class="keyword">void</span> <a class="link" href="shuffle_order_engine.html#id-1_3_34_5_6_38_1_1_1_8_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> 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="shuffle_order_engine.html#id-1_3_34_5_6_38_1_1_1_8_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 60 <span class="comment">// <a class="link" href="shuffle_order_engine.html#id-1_3_34_5_6_38_1_1_1_15-bb">public static functions</a></span> 61 <span class="keyword">static</span> <span class="identifier">result_type</span> <a class="link" href="shuffle_order_engine.html#id-1_3_34_5_6_38_1_1_1_15_1-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 62 <span class="keyword">static</span> <span class="identifier">result_type</span> <a class="link" href="shuffle_order_engine.html#id-1_3_34_5_6_38_1_1_1_15_2-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 63 64 <span class="comment">// <a class="link" href="shuffle_order_engine.html#id-1_3_34_5_6_38_1_1_1_16-bb">friend functions</a></span> 65 <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> 66 <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> 67 <a class="link" href="shuffle_order_engine.html#id-1_3_34_5_6_38_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> 68 <span class="keyword">const</span> <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 69 <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> 70 <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> 71 <a class="link" href="shuffle_order_engine.html#id-1_3_34_5_6_38_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> 72 <span class="keyword">const</span> <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 73 <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="shuffle_order_engine.html#id-1_3_34_5_6_38_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="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> <span class="special">&</span><span class="special">,</span> 74 <span class="keyword">const</span> <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 75 <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="shuffle_order_engine.html#id-1_3_34_5_6_38_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="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> <span class="special">&</span><span class="special">,</span> 76 <span class="keyword">const</span> <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 77 78 <span class="comment">// public data members</span> 79 <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> 80 <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">buffer_size</span><span class="special">;</span> 81 <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">table_size</span><span class="special">;</span> 82<span class="special">}</span><span class="special">;</span></pre></div> 83<div class="refsect1"> 84<a name="id-1.3.34.5.6.37.3.4"></a><h2>Description</h2> 85<p>Instatiations of class template <code class="computeroutput"><a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_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> . It mixes the output of some (usually <a class="link" href="linear_congruential_engine.html" title="Class template linear_congruential_engine">linear_congruential_engine</a>) <a class="link" href="../../boost_random/reference.html#boost_random.reference.concepts.uniform_random_number_generator" title="Uniform Random Number Generator">uniform random number generator</a> to get better statistical properties. The algorithm is described in</p> 86<p> </p> 87<div class="blockquote"><blockquote class="blockquote"><p> "Improving a poor random number generator", Carter Bays and S.D. Durham, ACM Transactions on Mathematical Software, Vol 2, No. 1, March 1976, pp. 59-64. <a href="http://doi.acm.org/10.1145/355666.355670" target="_top">http://doi.acm.org/10.1145/355666.355670</a> </p></blockquote></div> 88<p> </p> 89<p>The output of the base generator is buffered in an array of length k. Every output X(n) has a second role: It gives an index into the array where X(n+1) will be retrieved. Used array elements are replaced with fresh output from the base generator.</p> 90<p>Template parameters are the base generator and the array length k, which should be around 100. </p> 91<div class="refsect2"> 92<a name="id-1.3.34.5.6.37.3.4.6"></a><h3> 93<a name="boost.random.shuffle_order_engineconstruct-copy-destruct"></a><code class="computeroutput">shuffle_order_engine</code> 94 public 95 construct/copy/destruct</h3> 96<div class="orderedlist"><ol class="orderedlist" type="1"> 97<li class="listitem"> 98<pre class="literallayout"><a name="id-1_3_34_5_6_38_1_1_1_9-bb"></a><span class="identifier">shuffle_order_engine</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 99<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a></code></code> by invoking the default constructor of the base generator.</p> 100<p>Complexity: Exactly k+1 invocations of the base generator. </p> 101</li> 102<li class="listitem"> 103<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_34_5_6_38_1_1_1_10-bb"></a><span class="identifier">shuffle_order_engine</span><span class="special">(</span><span class="identifier">result_type</span> s<span class="special">)</span><span class="special">;</span></pre> 104<p>Constructs a <code class="computeroutput">shuffle_output_engine</code> by invoking the one-argument constructor of the base generator with the parameter seed.</p> 105<p>Complexity: Exactly k+1 invocations of the base generator. </p> 106</li> 107<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> SeedSeq<span class="special">></span> <span class="keyword">explicit</span> <a name="id-1_3_34_5_6_38_1_1_1_11-bb"></a><span class="identifier">shuffle_order_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></li> 108<li class="listitem"> 109<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_34_5_6_38_1_1_1_12-bb"></a><span class="identifier">shuffle_order_engine</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">base_type</span> <span class="special">&</span> rng<span class="special">)</span><span class="special">;</span></pre> 110<p>Constructs a <code class="computeroutput">shuffle_output_engine</code> by using a copy of the provided generator.</p> 111<p>Precondition: The template argument UniformRandomNumberGenerator shall denote a CopyConstructible type.</p> 112<p>Complexity: Exactly k+1 invocations of the base generator. </p> 113</li> 114<li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_34_5_6_38_1_1_1_13-bb"></a><span class="identifier">shuffle_order_engine</span><span class="special">(</span><span class="identifier">base_type</span> <span class="special">&&</span> rng<span class="special">)</span><span class="special">;</span></pre></li> 115<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> It<span class="special">></span> <a name="id-1_3_34_5_6_38_1_1_1_14-bb"></a><span class="identifier">shuffle_order_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></li> 116</ol></div> 117</div> 118<div class="refsect2"> 119<a name="id-1.3.34.5.6.37.3.4.7"></a><h3> 120<a name="id-1_3_34_5_6_38_1_1_1_8-bb"></a><code class="computeroutput">shuffle_order_engine</code> public member functions</h3> 121<div class="orderedlist"><ol class="orderedlist" type="1"> 122<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_38_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></li> 123<li class="listitem"> 124<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_38_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> 125<p>Invokes the one-argument seed method of the base generator with the parameter seed and re-initializes the internal buffer array.</p> 126<p>Complexity: Exactly k+1 invocations of the base generator. </p> 127</li> 128<li class="listitem"> 129<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_38_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> 130<p>Invokes the one-argument seed method of the base generator with the parameter seq and re-initializes the internal buffer array.</p> 131<p>Complexity: Exactly k+1 invocations of the base generator. </p> 132</li> 133<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> It<span class="special">></span> <span class="keyword">void</span> <a name="id-1_3_34_5_6_38_1_1_1_8_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></li> 134<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">base_type</span> <span class="special">&</span> <a name="id-1_3_34_5_6_38_1_1_1_8_5-bb"></a><span class="identifier">base</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> 135<li class="listitem"><pre class="literallayout"><span class="identifier">result_type</span> <a name="id-1_3_34_5_6_38_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></li> 136<li class="listitem"> 137<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_38_1_1_1_8_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> 138<p>Advances the generator by z steps. </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> Iter<span class="special">></span> <span class="keyword">void</span> <a name="id-1_3_34_5_6_38_1_1_1_8_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> 142<p>Fills a range with pseudo-random values. </p> 143</li> 144</ol></div> 145</div> 146<div class="refsect2"> 147<a name="id-1.3.34.5.6.37.3.4.8"></a><h3> 148<a name="id-1_3_34_5_6_38_1_1_1_15-bb"></a><code class="computeroutput">shuffle_order_engine</code> public static functions</h3> 149<div class="orderedlist"><ol class="orderedlist" type="1"> 150<li class="listitem"> 151<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">result_type</span> <a name="id-1_3_34_5_6_38_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> 152<p>Returns the smallest value that the generator can produce. </p> 153</li> 154<li class="listitem"> 155<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">result_type</span> <a name="id-1_3_34_5_6_38_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> 156<p>Returns the largest value that the generator can produce. </p> 157</li> 158</ol></div> 159</div> 160<div class="refsect2"> 161<a name="id-1.3.34.5.6.37.3.4.9"></a><h3> 162<a name="id-1_3_34_5_6_38_1_1_1_16-bb"></a><code class="computeroutput">shuffle_order_engine</code> friend functions</h3> 163<div class="orderedlist"><ol class="orderedlist" type="1"> 164<li class="listitem"> 165<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> 166 <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> 167 <a name="id-1_3_34_5_6_38_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> 168 <span class="keyword">const</span> <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> <span class="special">&</span> s<span class="special">)</span><span class="special">;</span></pre> 169<p>Writes a <code class="computeroutput"><code class="computeroutput"><a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a></code></code> to a <code class="computeroutput">std::ostream</code>. </p> 170</li> 171<li class="listitem"> 172<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> 173 <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> 174 <a name="id-1_3_34_5_6_38_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> 175 <span class="keyword">const</span> <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> <span class="special">&</span> s<span class="special">)</span><span class="special">;</span></pre> 176<p>Reads a <code class="computeroutput"><code class="computeroutput"><a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a></code></code> from a <code class="computeroutput">std::istream</code>. </p> 177</li> 178<li class="listitem"> 179<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_38_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="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> <span class="special">&</span> x<span class="special">,</span> 180 <span class="keyword">const</span> <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> <span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre> 181<p>Returns true if the two generators will produce identical sequences. </p> 182</li> 183<li class="listitem"> 184<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_38_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="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> <span class="special">&</span> lhs<span class="special">,</span> 185 <span class="keyword">const</span> <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> 186<p>Returns true if the two generators will produce different sequences. </p> 187</li> 188</ol></div> 189</div> 190</div> 191</div> 192<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 193<td align="left"></td> 194<td align="right"><div class="copyright-footer">Copyright © 2000-2005 Jens Maurer<br>Copyright © 2009, 2010 Steven Watanabe<p> 195 Distributed under the Boost Software License, Version 1.0. (See accompanying 196 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>) 197 </p> 198</div></td> 199</tr></table> 200<hr> 201<div class="spirit-nav"> 202<a accesskey="p" href="seed_seq.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.shuffle_order_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="kreutzer1986.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 203</div> 204</body> 205</html> 206
