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 faure_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.faure_hpp" title="Header <boost/random/faure.hpp>"> 10<link rel="prev" href="extreme_value_distribution/param_type.html" title="Class param_type"> 11<link rel="next" href="faure.html" title="Type definition faure"> 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="extreme_value_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.faure_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="faure.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.random.faure_engine"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template faure_engine</span></h2> 30<p>boost::random::faure_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.faure_hpp" title="Header <boost/random/faure.hpp>">boost/random/faure.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> RealType<span class="special">,</span> <span class="keyword">typename</span> SeqSizeT<span class="special">,</span> 36 <span class="keyword">typename</span> PrimeTable <span class="special">=</span> <span class="identifier">default_faure_prime_table</span><span class="special">></span> 37<span class="keyword">class</span> <a class="link" href="faure_engine.html" title="Class template faure_engine">faure_engine</a> <span class="special">{</span> 38<span class="keyword">public</span><span class="special">:</span> 39 <span class="comment">// types</span> 40 <span class="keyword">typedef</span> <span class="identifier">RealType</span> <a name="boost.random.faure_engine.result_type"></a><span class="identifier">result_type</span><span class="special">;</span> 41 42 <span class="comment">// <a class="link" href="faure_engine.html#boost.random.faure_engineconstruct-copy-destruct">construct/copy/destruct</a></span> 43 <span class="keyword">explicit</span> <a class="link" href="faure_engine.html#id-1_3_34_5_6_13_1_1_1_7-bb"><span class="identifier">faure_engine</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span> 44 45 <span class="comment">// <a class="link" href="faure_engine.html#id-1_3_34_5_6_13_1_1_1_4-bb">friend functions</a></span> 46 <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="faure_engine.html#id-1_3_34_5_6_13_1_1_1_4_1-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="faure_engine.html" title="Class template faure_engine">faure_engine</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="faure_engine.html" title="Class template faure_engine">faure_engine</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 47 <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="faure_engine.html#id-1_3_34_5_6_13_1_1_1_4_2-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="faure_engine.html" title="Class template faure_engine">faure_engine</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="faure_engine.html" title="Class template faure_engine">faure_engine</a> <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> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span> 49 <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> 50 <a class="link" href="faure_engine.html#id-1_3_34_5_6_13_1_1_1_4_3-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> <span class="keyword">const</span> <a class="link" href="faure_engine.html" title="Class template faure_engine">faure_engine</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 51 <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> 52 <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> 53 <a class="link" href="faure_engine.html#id-1_3_34_5_6_13_1_1_1_4_4-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> <span class="keyword">const</span> <a class="link" href="faure_engine.html" title="Class template faure_engine">faure_engine</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 54 55 <span class="comment">// <a class="link" href="faure_engine.html#id-1_3_34_5_6_13_1_1_1_5-bb">public static functions</a></span> 56 <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="identifier">result_type</span> <a class="link" href="faure_engine.html#id-1_3_34_5_6_13_1_1_1_5_1-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 57 <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="identifier">result_type</span> <a class="link" href="faure_engine.html#id-1_3_34_5_6_13_1_1_1_5_2-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 58 59 <span class="comment">// <a class="link" href="faure_engine.html#id-1_3_34_5_6_13_1_1_1_6-bb">public member functions</a></span> 60 <span class="keyword">void</span> <a class="link" href="faure_engine.html#id-1_3_34_5_6_13_1_1_1_6_1-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="identifier">SeqSizeT</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> 61 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="faure_engine.html#id-1_3_34_5_6_13_1_1_1_6_2-bb"><span class="identifier">dimension</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 62 <span class="identifier">result_type</span> <a class="link" href="faure_engine.html#id-1_3_34_5_6_13_1_1_1_6_3-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> 63 <span class="keyword">void</span> <a class="link" href="faure_engine.html#id-1_3_34_5_6_13_1_1_1_6_4-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> 64<span class="special">}</span><span class="special">;</span></pre></div> 65<div class="refsect1"> 66<a name="id-1.3.34.5.6.12.3.4"></a><h2>Description</h2> 67<p>Instantiations of class template <a class="link" href="faure_engine.html" title="Class template faure_engine">faure_engine</a> model a <a class="link" href="../../boost_random/reference.html#boost_random.reference.concepts.quasi_random_number_generator" title="Quasi-Random Number Generator">quasi-random number generator</a> . The <a class="link" href="faure_engine.html" title="Class template faure_engine">faure_engine</a> uses the algorithm described in </p> 68<div class="blockquote"><blockquote class="blockquote"><p> Henri Faure, Discrepance de suites associees a un systeme de numeration (en dimension s), Acta Arithmetica, Volume 41, 1982, pages 337-351. </p></blockquote></div> 69<p> </p> 70<div class="blockquote"><blockquote class="blockquote"><p> Bennett Fox, Algorithm 647: Implementation and Relative Efficiency of Quasirandom Sequence Generators, ACM Transactions on Mathematical Software, Volume 12, Number 4, December 1986, pages 362-376. </p></blockquote></div> 71<p> </p> 72<p>In the following documentation <code class="computeroutput">X</code> denotes the concrete class of the template <a class="link" href="faure_engine.html" title="Class template faure_engine">faure_engine</a> returning objects of type <code class="computeroutput">RealType</code>, u and v are the values of <code class="computeroutput">X</code>.</p> 73<p>Some member functions may throw exceptions of type <code class="computeroutput">std::bad_alloc</code>. </p> 74<div class="refsect2"> 75<a name="id-1.3.34.5.6.12.3.4.5"></a><h3> 76<a name="boost.random.faure_engineconstruct-copy-destruct"></a><code class="computeroutput">faure_engine</code> 77 public 78 construct/copy/destruct</h3> 79<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 80<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_34_5_6_13_1_1_1_7-bb"></a><span class="identifier">faure_engine</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> s<span class="special">)</span><span class="special">;</span></pre> 81<p>Effects: Constructs the <code class="computeroutput">s</code>-dimensional default Faure quasi-random number generator.</p> 82<p>Throws: bad_alloc, invalid_argument. </p> 83</li></ol></div> 84</div> 85<div class="refsect2"> 86<a name="id-1.3.34.5.6.12.3.4.6"></a><h3> 87<a name="id-1_3_34_5_6_13_1_1_1_4-bb"></a><code class="computeroutput">faure_engine</code> friend functions</h3> 88<div class="orderedlist"><ol class="orderedlist" type="1"> 89<li class="listitem"> 90<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_13_1_1_1_4_1-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="faure_engine.html" title="Class template faure_engine">faure_engine</a> <span class="special">&</span> x<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="faure_engine.html" title="Class template faure_engine">faure_engine</a> <span class="special">&</span> y<span class="special">)</span><span class="special">;</span></pre> 91<p>Returns true if the two generators will produce identical sequences of outputs. </p> 92</li> 93<li class="listitem"> 94<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_13_1_1_1_4_2-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="faure_engine.html" title="Class template faure_engine">faure_engine</a> <span class="special">&</span> lhs<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="faure_engine.html" title="Class template faure_engine">faure_engine</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> 95<p>Returns true if the two generators will produce different sequences of outputs. </p> 96</li> 97<li class="listitem"> 98<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> 99 <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> 100 <a name="id-1_3_34_5_6_13_1_1_1_4_3-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> <span class="keyword">const</span> <a class="link" href="faure_engine.html" title="Class template faure_engine">faure_engine</a> <span class="special">&</span> s<span class="special">)</span><span class="special">;</span></pre> 101<p>Writes the textual representation of the generator to a <code class="computeroutput">std::ostream</code>. </p> 102</li> 103<li class="listitem"> 104<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> 105 <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> 106 <a name="id-1_3_34_5_6_13_1_1_1_4_4-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> <span class="keyword">const</span> <a class="link" href="faure_engine.html" title="Class template faure_engine">faure_engine</a> <span class="special">&</span> s<span class="special">)</span><span class="special">;</span></pre> 107<p>Reads the textual representation of the generator from a <code class="computeroutput">std::istream</code>. </p> 108</li> 109</ol></div> 110</div> 111<div class="refsect2"> 112<a name="id-1.3.34.5.6.12.3.4.7"></a><h3> 113<a name="id-1_3_34_5_6_13_1_1_1_5-bb"></a><code class="computeroutput">faure_engine</code> public static functions</h3> 114<div class="orderedlist"><ol class="orderedlist" type="1"> 115<li class="listitem"> 116<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="identifier">result_type</span> <a name="id-1_3_34_5_6_13_1_1_1_5_1-bb"></a><span class="identifier">min</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 117<p>Returns: Tight lower bound on the set of values returned by operator().</p> 118<p>Throws: nothing. </p> 119</li> 120<li class="listitem"> 121<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="identifier">result_type</span> <a name="id-1_3_34_5_6_13_1_1_1_5_2-bb"></a><span class="identifier">max</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 122<p>Returns: Tight upper bound on the set of values returned by operator().</p> 123<p>Throws: nothing. </p> 124</li> 125</ol></div> 126</div> 127<div class="refsect2"> 128<a name="id-1.3.34.5.6.12.3.4.8"></a><h3> 129<a name="id-1_3_34_5_6_13_1_1_1_6-bb"></a><code class="computeroutput">faure_engine</code> public member functions</h3> 130<div class="orderedlist"><ol class="orderedlist" type="1"> 131<li class="listitem"> 132<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_13_1_1_1_6_1-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="identifier">SeqSizeT</span> init <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> 133<p>Effects: Effectively sets the quasi-random number generator state to the <code class="computeroutput">init</code>-th vector in the <code class="computeroutput">s</code>-dimensional quasi-random domain, where <code class="computeroutput">s</code> == X::dimension(). </p> 134<pre class="programlisting"><span class="identifier">X</span> <span class="identifier">u</span><span class="special">,</span> <span class="identifier">v</span><span class="special">;</span> 135<span class="keyword">for</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">i</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> <span class="identifier">i</span> <span class="special"><</span> <span class="identifier">N</span><span class="special">;</span> <span class="special">++</span><span class="identifier">i</span><span class="special">)</span> 136 <span class="keyword">for</span><span class="special">(</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">j</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> <span class="identifier">j</span> <span class="special"><</span> <span class="identifier">u</span><span class="special">.</span><span class="identifier">dimension</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="special">++</span><span class="identifier">j</span> <span class="special">)</span> 137 <span class="identifier">u</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> 138<span class="identifier">v</span><span class="special">.</span><span class="identifier">seed</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span><span class="special">;</span> 139<span class="identifier">assert</span><span class="special">(</span><span class="identifier">u</span><span class="special">(</span><span class="special">)</span> <span class="special">==</span> <span class="identifier">v</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> 140</pre> 141<p> Throws: bad_alloc. </p> 142</li> 143<li class="listitem"> 144<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_13_1_1_1_6_2-bb"></a><span class="identifier">dimension</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 145<p>Returns: The dimension of of the quasi-random domain.</p> 146<p>Throws: nothing. </p> 147</li> 148<li class="listitem"> 149<pre class="literallayout"><span class="identifier">result_type</span> <a name="id-1_3_34_5_6_13_1_1_1_6_3-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> 150<p>Returns: Returns a successive element of an <code class="computeroutput">s</code>-dimensional (s = X::dimension()) vector at each invocation. When all elements are exhausted, X::operator() begins anew with the starting element of a subsequent <code class="computeroutput">s</code>-dimensional vector.</p> 151<p>Throws: range_error. </p> 152</li> 153<li class="listitem"> 154<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_13_1_1_1_6_4-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> 155<p>Effects: Advances *this state as if <code class="computeroutput">z</code> consecutive X::operator() invocations were executed. </p> 156<pre class="programlisting"><span class="identifier">X</span> <span class="identifier">u</span> <span class="special">=</span> <span class="identifier">v</span><span class="special">;</span> 157<span class="keyword">for</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">i</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> <span class="identifier">i</span> <span class="special"><</span> <span class="identifier">N</span><span class="special">;</span> <span class="special">++</span><span class="identifier">i</span><span class="special">)</span> 158 <span class="identifier">u</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> 159<span class="identifier">v</span><span class="special">.</span><span class="identifier">discard</span><span class="special">(</span><span class="identifier">N</span><span class="special">)</span><span class="special">;</span> 160<span class="identifier">assert</span><span class="special">(</span><span class="identifier">u</span><span class="special">(</span><span class="special">)</span> <span class="special">==</span> <span class="identifier">v</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> 161</pre> 162<p>Throws: range_error. Throws: bad_alloc. </p> 163</li> 164</ol></div> 165</div> 166</div> 167</div> 168<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 169<td align="left"></td> 170<td align="right"><div class="copyright-footer">Copyright © 2000-2005 Jens Maurer<br>Copyright © 2009, 2010 Steven Watanabe<p> 171 Distributed under the Boost Software License, Version 1.0. (See accompanying 172 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>) 173 </p> 174</div></td> 175</tr></table> 176<hr> 177<div class="spirit-nav"> 178<a accesskey="p" href="extreme_value_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.faure_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="faure.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 179</div> 180</body> 181</html> 182
