boost-react-native-bundle

<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template shuffle_order_engine</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../boost_random/reference.html#header.boost.random.shuffle_order_hpp" title="Header <boost/random/shuffle_order.hpp>"> <link rel="prev" href="seed_seq.html" title="Class seed_seq"> <link rel="next" href="kreutzer1986.html" title="Type definition kreutzer1986"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> <td align="center"><a href="../../../../index.html">Home</a></td> <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> <td align="center"><a href="../../../../more/index.htm">More</a></td> </tr></table> <hr> <div class="spirit-nav"> <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> </div> <div class="refentry"> <a name="boost.random.shuffle_order_engine"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Class template shuffle_order_engine</h2> boost::random::shuffle_order_engine </div> <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis">// 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>> template<typename UniformRandomNumberGenerator, std::size_t k> class <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> { public: // types typedef UniformRandomNumberGenerator <a name="boost.random.shuffle_order_engine.base_type"></a>base_type; typedef base_type::result_type <a name="boost.random.shuffle_order_engine.result_type"></a>result_type; // <a class="link" href="shuffle_order_engine.html#boost.random.shuffle_order_engineconstruct-copy-destruct">construct/copy/destruct</a> <a class="link" href="shuffle_order_engine.html#idp206170544-bb">shuffle_order_engine</a>(); explicit <a class="link" href="shuffle_order_engine.html#idp207818464-bb">shuffle_order_engine</a>(result_type); template<typename SeedSeq> explicit <a class="link" href="shuffle_order_engine.html#idp207820656-bb">shuffle_order_engine</a>(SeedSeq &); explicit <a class="link" href="shuffle_order_engine.html#idp207822416-bb">shuffle_order_engine</a>(const base_type &); explicit <a class="link" href="shuffle_order_engine.html#idp207824928-bb">shuffle_order_engine</a>(base_type &&); template<typename It> <a class="link" href="shuffle_order_engine.html#idp207825952-bb">shuffle_order_engine</a>(It &, It); // <a class="link" href="shuffle_order_engine.html#idp145951840-bb">public member functions</a> void <a class="link" href="shuffle_order_engine.html#idp145952288-bb">seed</a>(); void <a class="link" href="shuffle_order_engine.html#idp206156336-bb">seed</a>(result_type); template<typename SeedSeq> void <a class="link" href="shuffle_order_engine.html#idp206158512-bb">seed</a>(SeedSeq &); template<typename It> void <a class="link" href="shuffle_order_engine.html#idp206161424-bb">seed</a>(It &, It); const base_type & <a class="link" href="shuffle_order_engine.html#idp206164048-bb">base</a>() const; result_type <a class="link" href="shuffle_order_engine.html#idp206164944-bb">operator()</a>(); void <a class="link" href="shuffle_order_engine.html#idp206165680-bb">discard</a>(boost::uintmax_t); template<typename Iter> void <a class="link" href="shuffle_order_engine.html#idp206167376-bb">generate</a>(Iter, Iter); // <a class="link" href="shuffle_order_engine.html#idp207828128-bb">public static functions</a> static result_type <a class="link" href="shuffle_order_engine.html#idp207828576-bb">min</a>(); static result_type <a class="link" href="shuffle_order_engine.html#idp207829936-bb">max</a>(); // <a class="link" href="shuffle_order_engine.html#idp207831456-bb">friend functions</a> template<typename CharT, typename Traits> friend std::basic_ostream< CharT, Traits > & <a class="link" href="shuffle_order_engine.html#idp107489520-bb">operator<<</a>(std::basic_ostream< CharT, Traits > &, const <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> &); template<typename CharT, typename Traits> friend std::basic_istream< CharT, Traits > & <a class="link" href="shuffle_order_engine.html#idp107494608-bb">operator>></a>(std::basic_istream< CharT, Traits > &, const <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> &); friend bool <a class="link" href="shuffle_order_engine.html#idp107499696-bb">operator==</a>(const <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> &, const <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> &); friend bool <a class="link" href="shuffle_order_engine.html#idp107502864-bb">operator!=</a>(const <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> &, const <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> &); // public data members static const bool has_fixed_range; static const std::size_t buffer_size; static const std::size_t table_size; };</pre></div> <div class="refsect1"> <a name="idp412577184"></a><h2>Description</h2> 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 <div class="blockquote"><blockquote class="blockquote"> "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> </blockquote></div> 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. Template parameters are the base generator and the array length k, which should be around 100. <div class="refsect2"> <a name="idp412584560"></a><h3> <a name="boost.random.shuffle_order_engineconstruct-copy-destruct"></a><code class="computeroutput">shuffle_order_engine</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout"><a name="idp206170544-bb"></a>shuffle_order_engine();</pre> 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. Complexity: Exactly k+1 invocations of the base generator. </li> <li class="listitem"> <pre class="literallayout">explicit <a name="idp207818464-bb"></a>shuffle_order_engine(result_type s);</pre> Constructs a <code class="computeroutput">shuffle_output_engine</code> by invoking the one-argument constructor of the base generator with the parameter seed. Complexity: Exactly k+1 invocations of the base generator. </li> <li class="listitem"><pre class="literallayout">template<typename SeedSeq> explicit <a name="idp207820656-bb"></a>shuffle_order_engine(SeedSeq & seq);</pre></li> <li class="listitem"> <pre class="literallayout">explicit <a name="idp207822416-bb"></a>shuffle_order_engine(const base_type & rng);</pre> Constructs a <code class="computeroutput">shuffle_output_engine</code> by using a copy of the provided generator. Precondition: The template argument UniformRandomNumberGenerator shall denote a CopyConstructible type. Complexity: Exactly k+1 invocations of the base generator. </li> <li class="listitem"><pre class="literallayout">explicit <a name="idp207824928-bb"></a>shuffle_order_engine(base_type && rng);</pre></li> <li class="listitem"><pre class="literallayout">template<typename It> <a name="idp207825952-bb"></a>shuffle_order_engine(It & first, It last);</pre></li> </ol></div> </div> <div class="refsect2"> <a name="idp412630144"></a><h3> <a name="idp145951840-bb"></a><code class="computeroutput">shuffle_order_engine</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"><pre class="literallayout">void <a name="idp145952288-bb"></a>seed();</pre></li> <li class="listitem"> <pre class="literallayout">void <a name="idp206156336-bb"></a>seed(result_type seed);</pre> Invokes the one-argument seed method of the base generator with the parameter seed and re-initializes the internal buffer array. Complexity: Exactly k+1 invocations of the base generator. </li> <li class="listitem"> <pre class="literallayout">template<typename SeedSeq> void <a name="idp206158512-bb"></a>seed(SeedSeq & seq);</pre> Invokes the one-argument seed method of the base generator with the parameter seq and re-initializes the internal buffer array. Complexity: Exactly k+1 invocations of the base generator. </li> <li class="listitem"><pre class="literallayout">template<typename It> void <a name="idp206161424-bb"></a>seed(It & first, It last);</pre></li> <li class="listitem"><pre class="literallayout">const base_type & <a name="idp206164048-bb"></a>base() const;</pre></li> <li class="listitem"><pre class="literallayout">result_type <a name="idp206164944-bb"></a>operator()();</pre></li> <li class="listitem"> <pre class="literallayout">void <a name="idp206165680-bb"></a>discard(boost::uintmax_t z);</pre> Advances the generator by z steps. </li> <li class="listitem"> <pre class="literallayout">template<typename Iter> void <a name="idp206167376-bb"></a>generate(Iter first, Iter last);</pre> Fills a range with pseudo-random values. </li> </ol></div> </div> <div class="refsect2"> <a name="idp412688112"></a><h3> <a name="idp207828128-bb"></a><code class="computeroutput">shuffle_order_engine</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">static result_type <a name="idp207828576-bb"></a>min();</pre> Returns the smallest value that the generator can produce. </li> <li class="listitem"> <pre class="literallayout">static result_type <a name="idp207829936-bb"></a>max();</pre> Returns the largest value that the generator can produce. </li> </ol></div> </div> <div class="refsect2"> <a name="idp412700768"></a><h3> <a name="idp207831456-bb"></a><code class="computeroutput">shuffle_order_engine</code> friend functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">template<typename CharT, typename Traits> friend std::basic_ostream< CharT, Traits > & <a name="idp107489520-bb"></a>operator<<(std::basic_ostream< CharT, Traits > & os, const <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> & s);</pre> 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>. </li> <li class="listitem"> <pre class="literallayout">template<typename CharT, typename Traits> friend std::basic_istream< CharT, Traits > & <a name="idp107494608-bb"></a>operator>>(std::basic_istream< CharT, Traits > & is, const <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> & s);</pre> 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>. </li> <li class="listitem"> <pre class="literallayout">friend bool <a name="idp107499696-bb"></a>operator==(const <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> & x, const <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> & y);</pre> Returns true if the two generators will produce identical sequences. </li> <li class="listitem"> <pre class="literallayout">friend bool <a name="idp107502864-bb"></a>operator!=(const <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> & lhs, const <a class="link" href="shuffle_order_engine.html" title="Class template shuffle_order_engine">shuffle_order_engine</a> & rhs);</pre> Returns true if the two generators will produce different sequences. </li> </ol></div> </div> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> <td align="left"></td> <td align="right"><div class="copyright-footer">Copyright © 2000-2005 Jens Maurer Copyright © 2009, 2010 Steven Watanabe Distributed under the Boost Software License, Version 1.0. (See accompanying 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>) </div></td> </tr></table> <hr> <div class="spirit-nav"> <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> </div> </body> </html>