Google Git
Sign in
nest-open-source / nest-learning-thermostat / 5.0 / boost / 317601cb979f96545d0e892ce7cfdf59f676ee0a / . / boost_1_45_0 / doc / html / boost / random / xor_combine.html
blob: 8cd430cf611f38139b0e1a743e8e57b63364f23b [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template xor_combine</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<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 &lt;boost/random/xor_combine.hpp&gt;">
<link rel="prev" href="../variate_generator.html" title="Class template variate_generator">
<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="../variate_generator.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"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template xor_combine</span></h2>
<p>boost::random::xor_combine</p>
</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"><span class="comment">// In header: &lt;<a class="link" href="../../boost_random/reference.html#header.boost.random.xor_combine_hpp" title="Header &lt;boost/random/xor_combine.hpp&gt;">boost/random/xor_combine.hpp</a>&gt;
</span><span class="keyword">template</span><span class="special">&lt;</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">&gt;</span>
<span class="keyword">class</span> <a class="link" href="xor_combine.html" title="Class template xor_combine">xor_combine</a> <span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
<span class="comment">// types</span>
<span class="keyword">typedef</span> <span class="identifier">URNG1</span> <a name="boost.random.xor_combine.base1_type"></a><span class="identifier">base1_type</span><span class="special">;</span>
<span class="keyword">typedef</span> <span class="identifier">URNG2</span> <a name="boost.random.xor_combine.base2_type"></a><span class="identifier">base2_type</span><span class="special">;</span>
<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.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
<span class="comment">// <a class="link" href="xor_combine.html#boost.random.xor_combineconstruct-copy-destruct">construct/copy/destruct</a></span>
<a class="link" href="xor_combine.html#id1150427-bb"><span class="identifier">xor_combine</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="xor_combine.html#id1150436-bb"><span class="identifier">xor_combine</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">base1_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">base2_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<a class="link" href="xor_combine.html#id1150457-bb"><span class="identifier">xor_combine</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">result_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> It<span class="special">&gt;</span> <a class="link" href="xor_combine.html#id1150475-bb"><span class="identifier">xor_combine</span></a><span class="special">(</span><span class="identifier">It</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">It</span><span class="special">)</span><span class="special">;</span>
<span class="comment">// <a class="link" href="xor_combine.html#id1150289-bb">public member functions</a></span>
<span class="keyword">void</span> <a class="link" href="xor_combine.html#id1150292-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">void</span> <a class="link" href="xor_combine.html#id1150307-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">result_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> It<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="xor_combine.html#id1150331-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="identifier">It</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">It</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">const</span> <span class="identifier">base1_type</span> <span class="special">&amp;</span> <a class="link" href="xor_combine.html#id1150368-bb"><span class="identifier">base1</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">const</span> <span class="identifier">base2_type</span> <span class="special">&amp;</span> <a class="link" href="xor_combine.html#id1150380-bb"><span class="identifier">base2</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
<span class="identifier">result_type</span> <a class="link" href="xor_combine.html#id1150392-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>
<span class="identifier">result_type</span> <a class="link" href="xor_combine.html#id1150403-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="identifier">result_type</span> <a class="link" href="xor_combine.html#id1150415-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="comment">// <a class="link" href="xor_combine.html#id1150509-bb">public static functions</a></span>
<span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="xor_combine.html#id1150513-bb"><span class="identifier">validation</span></a><span class="special">(</span><span class="identifier">result_type</span><span class="special">)</span><span class="special">;</span>
<span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">bool</span> has_fixed_range<span class="special">;</span>
<span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">int</span> shift1<span class="special">;</span>
<span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">int</span> shift2<span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id2518336"></a><h2>Description</h2>
<p>Instantiations of <code class="computeroutput">xor_combine</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>
<div class="refsect2">
<a name="id2518358"></a><h3>
<a name="boost.random.xor_combineconstruct-copy-destruct"></a><code class="computeroutput">xor_combine</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="id1150427-bb"></a><span class="identifier">xor_combine</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Constructors a <code class="computeroutput">xor_combine</code> by default constructing both base generators. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="id1150436-bb"></a><span class="identifier">xor_combine</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">base1_type</span> <span class="special">&amp;</span> rng1<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">base2_type</span> <span class="special">&amp;</span> rng2<span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a <code class="computeroutput">xor_combine</code> by copying two base generators. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="id1150457-bb"></a><span class="identifier">xor_combine</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">result_type</span> <span class="special">&amp;</span> v<span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a <code class="computeroutput">xor_combine</code>, seeding both base generators with <code class="computeroutput">v</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> It<span class="special">&gt;</span> <a name="id1150475-bb"></a><span class="identifier">xor_combine</span><span class="special">(</span><span class="identifier">It</span> <span class="special">&amp;</span> first<span class="special">,</span> <span class="identifier">It</span> last<span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a <code class="computeroutput">xor_combine</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>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="id2518641"></a><h3>
<a name="id1150289-bb"></a><code class="computeroutput">xor_combine</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id1150292-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Calls <code class="computeroutput">seed()</code> for both base generators. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="id1150307-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">result_type</span> <span class="special">&amp;</span> v<span class="special">)</span><span class="special">;</span></pre>
<p><code class="computeroutput">seeds</code> both base generators with <code class="computeroutput">v</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> It<span class="special">&gt;</span> <span class="keyword">void</span> <a name="id1150331-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="identifier">It</span> <span class="special">&amp;</span> first<span class="special">,</span> <span class="identifier">It</span> last<span class="special">)</span><span class="special">;</span></pre>
<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>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">base1_type</span> <span class="special">&amp;</span> <a name="id1150368-bb"></a><span class="identifier">base1</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Returns the first base generator. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">base2_type</span> <span class="special">&amp;</span> <a name="id1150380-bb"></a><span class="identifier">base2</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Returns the second base generator. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">result_type</span> <a name="id1150392-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>
<p>Returns the next value of the generator. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">result_type</span> <a name="id1150403-bb"></a><span class="identifier">min</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the smallest value that the generator can produce. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">result_type</span> <a name="id1150415-bb"></a><span class="identifier">max</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns the largest value that the generator can produce. </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="id2519085"></a><h3>
<a name="id1150509-bb"></a><code class="computeroutput">xor_combine</code> public static functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="id1150513-bb"></a><span class="identifier">validation</span><span class="special">(</span><span class="identifier">result_type</span> x<span class="special">)</span><span class="special">;</span></pre></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 &#169; 2000 -2005 Jens Maurer, 2009 Steven Watanabe<p>
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../variate_generator.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>