boost-react-native-bundle

<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template xor_combine_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.xor_combine_hpp" title="Header <boost/random/xor_combine.hpp>"> <link rel="prev" href="weibull_distribution/param_type.html" title="Class param_type"> <link rel="next" href="../../boost_random/performance.html" title="Performance"> </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="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> </div> <div class="refentry"> <a name="boost.random.xor_combine_engine"></a><div class="titlepage"></div> <div class="refnamediv"> <h2>Class template xor_combine_engine</h2> boost::random::xor_combine_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.xor_combine_hpp" title="Header <boost/random/xor_combine.hpp>">boost/random/xor_combine.hpp</a>> template<typename URNG1, int s1, typename URNG2, int s2> class <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> { public: // types typedef URNG1 <a name="boost.random.xor_combine_engine.base1_type"></a>base1_type; typedef URNG2 <a name="boost.random.xor_combine_engine.base2_type"></a>base2_type; typedef base1_type::result_type <a name="boost.random.xor_combine_engine.result_type"></a>result_type; // <a class="link" href="xor_combine_engine.html#boost.random.xor_combine_engineconstruct-copy-destruct">construct/copy/destruct</a> <a class="link" href="xor_combine_engine.html#idp113828336-bb">xor_combine_engine</a>(); <a class="link" href="xor_combine_engine.html#idp113829936-bb">xor_combine_engine</a>(const base1_type &, const base2_type &); explicit <a class="link" href="xor_combine_engine.html#idp113832480-bb">xor_combine_engine</a>(result_type); template<typename SeedSeq> explicit <a class="link" href="xor_combine_engine.html#idp202822864-bb">xor_combine_engine</a>(SeedSeq &); template<typename It> <a class="link" href="xor_combine_engine.html#idp202826720-bb">xor_combine_engine</a>(It &, It); // <a class="link" href="xor_combine_engine.html#idp199834304-bb">public member functions</a> void <a class="link" href="xor_combine_engine.html#idp199834864-bb">seed</a>(); void <a class="link" href="xor_combine_engine.html#idp199836592-bb">seed</a>(result_type); template<typename SeedSeq> void <a class="link" href="xor_combine_engine.html#idp199839296-bb">seed</a>(SeedSeq &); template<typename It> void <a class="link" href="xor_combine_engine.html#idp199842800-bb">seed</a>(It &, It); const base1_type & <a class="link" href="xor_combine_engine.html#idp113817856-bb">base1</a>() const; const base2_type & <a class="link" href="xor_combine_engine.html#idp113819408-bb">base2</a>() const; result_type <a class="link" href="xor_combine_engine.html#idp113820960-bb">operator()</a>(); template<typename Iter> void <a class="link" href="xor_combine_engine.html#idp113822256-bb">generate</a>(Iter, Iter); void <a class="link" href="xor_combine_engine.html#idp113825760-bb">discard</a>(boost::uintmax_t); // <a class="link" href="xor_combine_engine.html#idp202831168-bb">public static functions</a> static result_type <a class="link" href="xor_combine_engine.html#idp202831728-bb">min</a>(); static result_type <a class="link" href="xor_combine_engine.html#idp202833312-bb">max</a>(); // <a class="link" href="xor_combine_engine.html#idp105876736-bb">friend functions</a> template<typename CharT, typename Traits> friend std::basic_ostream< CharT, Traits > & <a class="link" href="xor_combine_engine.html#idp105877296-bb">operator<<</a>(std::basic_ostream< CharT, Traits > &, const <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> &); template<typename CharT, typename Traits> friend std::basic_istream< CharT, Traits > & <a class="link" href="xor_combine_engine.html#idp105882272-bb">operator>></a>(std::basic_istream< CharT, Traits > &, const <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> &); friend bool <a class="link" href="xor_combine_engine.html#idp105887312-bb">operator==</a>(const <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> &, const <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> &); friend bool <a class="link" href="xor_combine_engine.html#idp105890896-bb">operator!=</a>(const <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> &, const <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> &); // public data members static const bool has_fixed_range; static const int shift1; static const int shift2; };</pre></div> <div class="refsect1"> <a name="idp418571040"></a><h2>Description</h2> 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. <div class="refsect2"> <a name="idp418574080"></a><h3> <a name="boost.random.xor_combine_engineconstruct-copy-destruct"></a><code class="computeroutput">xor_combine_engine</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout"><a name="idp113828336-bb"></a>xor_combine_engine();</pre> 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. </li> <li class="listitem"> <pre class="literallayout"><a name="idp113829936-bb"></a>xor_combine_engine(const base1_type & rng1, const base2_type & rng2);</pre> Constructs a <code class="computeroutput">xor_combine</code> by copying two base generators. </li> <li class="listitem"> <pre class="literallayout">explicit <a name="idp113832480-bb"></a>xor_combine_engine(result_type v);</pre> 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>. <div class="warning"><table border="0" summary="Warning"> <tr> <td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../doc/src/images/warning.png"></td> <th align="left">Warning</th> </tr> <tr><td align="left" valign="top"> The exact algorithm used by this function may change in the future. </td></tr> </table></div> </li> <li class="listitem"> <pre class="literallayout">template<typename SeedSeq> explicit <a name="idp202822864-bb"></a>xor_combine_engine(SeedSeq & seq);</pre> 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>. </li> <li class="listitem"> <pre class="literallayout">template<typename It> <a name="idp202826720-bb"></a>xor_combine_engine(It & first, It last);</pre> 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>. </li> </ol></div> </div> <div class="refsect2"> <a name="idp418622224"></a><h3> <a name="idp199834304-bb"></a><code class="computeroutput">xor_combine_engine</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout">void <a name="idp199834864-bb"></a>seed();</pre> Calls <code class="computeroutput">seed()</code> for both base generators. </li> <li class="listitem"> <pre class="literallayout">void <a name="idp199836592-bb"></a>seed(result_type v);</pre> <code class="computeroutput">seeds</code> both base generators with <code class="computeroutput">v</code>. </li> <li class="listitem"> <pre class="literallayout">template<typename SeedSeq> void <a name="idp199839296-bb"></a>seed(SeedSeq & seq);</pre> <code class="computeroutput">seeds</code> both base generators with values produced by <code class="computeroutput">seq</code>. </li> <li class="listitem"> <pre class="literallayout">template<typename It> void <a name="idp199842800-bb"></a>seed(It & first, It last);</pre> 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>. </li> <li class="listitem"> <pre class="literallayout">const base1_type & <a name="idp113817856-bb"></a>base1() const;</pre> Returns the first base generator. </li> <li class="listitem"> <pre class="literallayout">const base2_type & <a name="idp113819408-bb"></a>base2() const;</pre> Returns the second base generator. </li> <li class="listitem"> <pre class="literallayout">result_type <a name="idp113820960-bb"></a>operator()();</pre> Returns the next value of the generator. </li> <li class="listitem"> <pre class="literallayout">template<typename Iter> void <a name="idp113822256-bb"></a>generate(Iter first, Iter last);</pre> Fills a range with random values </li> <li class="listitem"> <pre class="literallayout">void <a name="idp113825760-bb"></a>discard(boost::uintmax_t z);</pre> Advances the state of the generator by <code class="computeroutput">z</code>. </li> </ol></div> </div> <div class="refsect2"> <a name="idp418691968"></a><h3> <a name="idp202831168-bb"></a><code class="computeroutput">xor_combine_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="idp202831728-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="idp202833312-bb"></a>max();</pre> Returns the largest value that the generator can produce. </li> </ol></div> </div> <div class="refsect2"> <a name="idp418704816"></a><h3> <a name="idp105876736-bb"></a><code class="computeroutput">xor_combine_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="idp105877296-bb"></a>operator<<(std::basic_ostream< CharT, Traits > & os, const <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> & s);</pre> Writes the textual representation of the generator 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="idp105882272-bb"></a>operator>>(std::basic_istream< CharT, Traits > & is, const <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> & s);</pre> Reads the textual representation of the generator from a <code class="computeroutput">std::istream</code>. </li> <li class="listitem"> <pre class="literallayout">friend bool <a name="idp105887312-bb"></a>operator==(const <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> & x, const <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_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="idp105890896-bb"></a>operator!=(const <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_engine</a> & lhs, const <a class="link" href="xor_combine_engine.html" title="Class template xor_combine_engine">xor_combine_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="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> </div> </body> </html>