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 seed_seq</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.seed_seq_hpp" title="Header <boost/random/seed_seq.hpp>"> 10<link rel="prev" href="ranlux64_4.html" title="Type definition ranlux64_4"> 11<link rel="next" href="shuffle_order_engine.html" title="Class template shuffle_order_engine"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="ranlux64_4.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.seed_seq_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="shuffle_order_engine.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.random.seed_seq"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class seed_seq</span></h2> 30<p>boost::random::seed_seq</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.seed_seq_hpp" title="Header <boost/random/seed_seq.hpp>">boost/random/seed_seq.hpp</a>> 34 35</span> 36<span class="keyword">class</span> <a class="link" href="seed_seq.html" title="Class seed_seq">seed_seq</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">boost</span><span class="special">::</span><span class="identifier">uint_least32_t</span> <a name="boost.random.seed_seq.result_type"></a><span class="identifier">result_type</span><span class="special">;</span> 40 41 <span class="comment">// <a class="link" href="seed_seq.html#boost.random.seed_seqconstruct-copy-destruct">construct/copy/destruct</a></span> 42 <a class="link" href="seed_seq.html#id-1_3_34_5_6_37_1_1_1_4-bb"><span class="identifier">seed_seq</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 43 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="seed_seq.html#id-1_3_34_5_6_37_1_1_1_5-bb"><span class="identifier">seed_seq</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 44 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Iter<span class="special">></span> <a class="link" href="seed_seq.html#id-1_3_34_5_6_37_1_1_1_6-bb"><span class="identifier">seed_seq</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> 45 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Range<span class="special">></span> <span class="keyword">explicit</span> <a class="link" href="seed_seq.html#id-1_3_34_5_6_37_1_1_1_7-bb"><span class="identifier">seed_seq</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 46 47 <span class="comment">// <a class="link" href="seed_seq.html#id-1_3_34_5_6_37_1_1_1_3-bb">public member functions</a></span> 48 <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="seed_seq.html#id-1_3_34_5_6_37_1_1_1_3_1-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="keyword">const</span><span class="special">;</span> 49 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="seed_seq.html#id-1_3_34_5_6_37_1_1_1_3_2-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 50 <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="seed_seq.html#id-1_3_34_5_6_37_1_1_1_3_3-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="identifier">Iter</span><span class="special">)</span><span class="special">;</span> 51<span class="special">}</span><span class="special">;</span></pre></div> 52<div class="refsect1"> 53<a name="id-1.3.34.5.6.36.3.4"></a><h2>Description</h2> 54<p>The class <code class="computeroutput"><a class="link" href="seed_seq.html" title="Class seed_seq">seed_seq</a></code> stores a sequence of 32-bit words for seeding 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> . These words will be combined to fill the entire state of the generator. </p> 55<div class="refsect2"> 56<a name="id-1.3.34.5.6.36.3.4.3"></a><h3> 57<a name="boost.random.seed_seqconstruct-copy-destruct"></a><code class="computeroutput">seed_seq</code> 58 public 59 construct/copy/destruct</h3> 60<div class="orderedlist"><ol class="orderedlist" type="1"> 61<li class="listitem"> 62<pre class="literallayout"><a name="id-1_3_34_5_6_37_1_1_1_4-bb"></a><span class="identifier">seed_seq</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 63<p>Initializes a <code class="computeroutput"><a class="link" href="seed_seq.html" title="Class seed_seq">seed_seq</a></code> to hold an empty sequence. </p> 64</li> 65<li class="listitem"> 66<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a name="id-1_3_34_5_6_37_1_1_1_5-bb"></a><span class="identifier">seed_seq</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span> il<span class="special">)</span><span class="special">;</span></pre> 67<p>Initializes the sequence from an initializer_list. </p> 68</li> 69<li class="listitem"> 70<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Iter<span class="special">></span> <a name="id-1_3_34_5_6_37_1_1_1_6-bb"></a><span class="identifier">seed_seq</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> 71<p>Initializes the sequence from an iterator range. </p> 72</li> 73<li class="listitem"> 74<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Range<span class="special">></span> <span class="keyword">explicit</span> <a name="id-1_3_34_5_6_37_1_1_1_7-bb"></a><span class="identifier">seed_seq</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">Range</span> <span class="special">&</span> range<span class="special">)</span><span class="special">;</span></pre> 75<p>Initializes the sequence from Boost.Range range. </p> 76</li> 77</ol></div> 78</div> 79<div class="refsect2"> 80<a name="id-1.3.34.5.6.36.3.4.4"></a><h3> 81<a name="id-1_3_34_5_6_37_1_1_1_3-bb"></a><code class="computeroutput">seed_seq</code> public member functions</h3> 82<div class="orderedlist"><ol class="orderedlist" type="1"> 83<li class="listitem"> 84<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_37_1_1_1_3_1-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="keyword">const</span><span class="special">;</span></pre> 85<p>Fills a range with 32-bit values based on the stored sequence.</p> 86<p>Requires: Iter must be a Random Access Iterator whose value type is an unsigned integral type at least 32 bits wide. </p> 87</li> 88<li class="listitem"> 89<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="id-1_3_34_5_6_37_1_1_1_3_2-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 90<p>Returns the size of the sequence. </p> 91</li> 92<li class="listitem"> 93<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_37_1_1_1_3_3-bb"></a><span class="identifier">param</span><span class="special">(</span><span class="identifier">Iter</span> out<span class="special">)</span><span class="special">;</span></pre> 94<p>Writes the stored sequence to iter. </p> 95</li> 96</ol></div> 97</div> 98</div> 99</div> 100<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 101<td align="left"></td> 102<td align="right"><div class="copyright-footer">Copyright © 2000-2005 Jens Maurer<br>Copyright © 2009, 2010 Steven Watanabe<p> 103 Distributed under the Boost Software License, Version 1.0. (See accompanying 104 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>) 105 </p> 106</div></td> 107</tr></table> 108<hr> 109<div class="spirit-nav"> 110<a accesskey="p" href="ranlux64_4.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.seed_seq_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="shuffle_order_engine.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 111</div> 112</body> 113</html> 114
