libs/compute/doc/html/boost/compute/linear_congruential_engine.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template linear_congruential_engine</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Compute">
   8 <link rel="up" href="../../boost_compute/reference.html#header.boost.compute.random.linear_congruential_engine_hpp" title="Header &lt;boost/compute/random/linear_congruential_engine.hpp&gt;">
   9 <link rel="prev" href="discrete_distribution.html" title="Class template discrete_distribution">
  10 <link rel="next" href="mersenne_twister_engine.html" title="Class template mersenne_twister_engine">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="discrete_distribution.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.random.linear_congruential_engine_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="mersenne_twister_engine.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.compute.linear_congruential_engine"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template linear_congruential_engine</span></h2>
  29 <p>boost::compute::linear_congruential_engine &#8212; 'Quick and Dirty' linear congruential engine </p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <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_compute/reference.html#header.boost.compute.random.linear_congruential_engine_hpp" title="Header &lt;boost/compute/random/linear_congruential_engine.hpp&gt;">boost/compute/random/linear_congruential_engine.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T <span class="special">=</span> <span class="identifier">uint_</span><span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="linear_congruential_engine.html" title="Class template linear_congruential_engine">linear_congruential_engine</a> <span class="special">{</span>
  36 <span class="keyword">public</span><span class="special">:</span>
  37   <span class="comment">// types</span>
  38   <span class="keyword">typedef</span> <span class="identifier">T</span> <a name="boost.compute.linear_congruential_engine.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
  39
  40   <span class="comment">// <a class="link" href="linear_congruential_engine.html#boost.compute.linear_congruential_engineconstruct-copy-destruct">construct/copy/destruct</a></span>
  41   <span class="keyword">explicit</span> <a class="link" href="linear_congruential_engine.html#idm46009691876176-bb"><span class="identifier">linear_congruential_engine</span></a><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">,</span>
  42                                       <span class="identifier">result_type</span> <span class="special">=</span> <span class="identifier">default_seed</span><span class="special">)</span><span class="special">;</span>
  43   <a class="link" href="linear_congruential_engine.html#idm46009691872448-bb"><span class="identifier">linear_congruential_engine</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="linear_congruential_engine.html" title="Class template linear_congruential_engine">linear_congruential_engine</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  44   <a class="link" href="linear_congruential_engine.html" title="Class template linear_congruential_engine">linear_congruential_engine</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
  45   <a class="link" href="linear_congruential_engine.html#idm46009691869504-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="linear_congruential_engine.html" title="Class template linear_congruential_engine">linear_congruential_engine</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  46   <a class="link" href="linear_congruential_engine.html#idm46009691866288-bb"><span class="special">~</span><span class="identifier">linear_congruential_engine</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  47
  48   <span class="comment">// <a class="link" href="linear_congruential_engine.html#idm46009691898480-bb">public member functions</a></span>
  49   <span class="keyword">void</span> <a class="link" href="linear_congruential_engine.html#idm46009691897920-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="identifier">result_type</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  50   <span class="keyword">void</span> <a class="link" href="linear_congruential_engine.html#idm46009691893184-bb"><span class="identifier">seed</span></a><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  51   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> OutputIterator<span class="special">&gt;</span>
  52     <span class="keyword">void</span> <a class="link" href="linear_congruential_engine.html#idm46009691891104-bb"><span class="identifier">generate</span></a><span class="special">(</span><span class="identifier">OutputIterator</span><span class="special">,</span> <span class="identifier">OutputIterator</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  53   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> OutputIterator<span class="special">,</span> <span class="keyword">typename</span> Function<span class="special">&gt;</span>
  54     <span class="keyword">void</span> <a class="link" href="linear_congruential_engine.html#idm46009691886128-bb"><span class="identifier">generate</span></a><span class="special">(</span><span class="identifier">OutputIterator</span><span class="special">,</span> <span class="identifier">OutputIterator</span><span class="special">,</span> <span class="identifier">Function</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  55   <span class="keyword">void</span> <a class="link" href="linear_congruential_engine.html#idm46009691879312-bb"><span class="identifier">discard</span></a><span class="special">(</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  56
  57   <span class="comment">// public data members</span>
  58   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="identifier">default_seed</span><span class="special">;</span>
  59   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="identifier">a</span><span class="special">;</span>
  60   <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">size_t</span> <span class="identifier">threads</span><span class="special">;</span>
  61 <span class="special">}</span><span class="special">;</span></pre></div>
  62 <div class="refsect1">
  63 <a name="idm46113316969488"></a><h2>Description</h2>
  64 <p>Quick and dirty linear congruential engine to generate low quality random numbers very quickly. For uses in which good quality of random numbers is required(Monte-Carlo Simulations), use other engines like Mersenne Twister instead. </p>
  65 <div class="refsect2">
  66 <a name="idm46113316968592"></a><h3>
  67 <a name="boost.compute.linear_congruential_engineconstruct-copy-destruct"></a><code class="computeroutput">linear_congruential_engine</code>
  68         public
  69        construct/copy/destruct</h3>
  70 <div class="orderedlist"><ol class="orderedlist" type="1">
  71 <li class="listitem">
  72 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm46009691876176-bb"></a><span class="identifier">linear_congruential_engine</span><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">,</span>
  73                                     <span class="identifier">result_type</span> value <span class="special">=</span> <span class="identifier">default_seed</span><span class="special">)</span><span class="special">;</span></pre>Creates a new <code class="computeroutput"><a class="link" href="linear_congruential_engine.html" title="Class template linear_congruential_engine">linear_congruential_engine</a></code> and seeds it with <code class="computeroutput">value</code>. </li>
  74 <li class="listitem">
  75 <pre class="literallayout"><a name="idm46009691872448-bb"></a><span class="identifier">linear_congruential_engine</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="linear_congruential_engine.html" title="Class template linear_congruential_engine">linear_congruential_engine</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Creates a new <code class="computeroutput"><a class="link" href="linear_congruential_engine.html" title="Class template linear_congruential_engine">linear_congruential_engine</a></code> object as a copy of <code class="computeroutput">other</code>. </li>
  76 <li class="listitem">
  77 <pre class="literallayout"><a class="link" href="linear_congruential_engine.html" title="Class template linear_congruential_engine">linear_congruential_engine</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
  78 <a name="idm46009691869504-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="linear_congruential_engine.html" title="Class template linear_congruential_engine">linear_congruential_engine</a><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>Copies <code class="computeroutput">other</code> to <code class="computeroutput">*this</code>. </li>
  79 <li class="listitem">
  80 <pre class="literallayout"><a name="idm46009691866288-bb"></a><span class="special">~</span><span class="identifier">linear_congruential_engine</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the <code class="computeroutput"><a class="link" href="linear_congruential_engine.html" title="Class template linear_congruential_engine">linear_congruential_engine</a></code> object. </li>
  81 </ol></div>
  82 </div>
  83 <div class="refsect2">
  84 <a name="idm46113316932352"></a><h3>
  85 <a name="idm46009691898480-bb"></a><code class="computeroutput">linear_congruential_engine</code> public member functions</h3>
  86 <div class="orderedlist"><ol class="orderedlist" type="1">
  87 <li class="listitem">
  88 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46009691897920-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="identifier">result_type</span> value<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre>
  89 <p>Seeds the random number generator with <code class="computeroutput">value</code>.</p>
  90 <p>
  91 If no seed value is provided, <code class="computeroutput">default_seed</code> is used. </p>
  92 <div class="variablelist"><table border="0" class="variablelist compact">
  93 <colgroup>
  94 <col align="left" valign="top">
  95 <col>
  96 </colgroup>
  97 <tbody><tr>
  98 <td><p><span class="term">Parameters:</span></p></td>
  99 <td><div class="variablelist"><table border="0" class="variablelist compact">
 100 <colgroup>
 101 <col align="left" valign="top">
 102 <col>
 103 </colgroup>
 104 <tbody>
 105 <tr>
 106 <td><p><span class="term"><code class="computeroutput">queue</code></span></p></td>
 107 <td><p>command queue to perform the operation</p></td>
 108 </tr>
 109 <tr>
 110 <td><p><span class="term"><code class="computeroutput">value</code></span></p></td>
 111 <td><p>seed value for the random-number generator </p></td>
 112 </tr>
 113 </tbody>
 114 </table></div></td>
 115 </tr></tbody>
 116 </table></div>
 117 </li>
 118 <li class="listitem">
 119 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46009691893184-bb"></a><span class="identifier">seed</span><span class="special">(</span><span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre>
 120 <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p>
 121 </li>
 122 <li class="listitem">
 123 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> OutputIterator<span class="special">&gt;</span>
 124   <span class="keyword">void</span> <a name="idm46009691891104-bb"></a><span class="identifier">generate</span><span class="special">(</span><span class="identifier">OutputIterator</span> first<span class="special">,</span> <span class="identifier">OutputIterator</span> last<span class="special">,</span>
 125                 <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre>Generates random numbers and stores them to the range [<code class="computeroutput">first</code>, <code class="computeroutput">last</code>). </li>
 126 <li class="listitem">
 127 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> OutputIterator<span class="special">,</span> <span class="keyword">typename</span> Function<span class="special">&gt;</span>
 128   <span class="keyword">void</span> <a name="idm46009691886128-bb"></a><span class="identifier">generate</span><span class="special">(</span><span class="identifier">OutputIterator</span> first<span class="special">,</span> <span class="identifier">OutputIterator</span> last<span class="special">,</span> <span class="identifier">Function</span> op<span class="special">,</span>
 129                 <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre>
 130 <p>Generates random numbers, transforms them with <code class="computeroutput">op</code>, and then stores them to the range [<code class="computeroutput">first</code>, <code class="computeroutput">last</code>). </p>
 131 </li>
 132 <li class="listitem">
 133 <pre class="literallayout"><span class="keyword">void</span> <a name="idm46009691879312-bb"></a><span class="identifier">discard</span><span class="special">(</span><span class="identifier">size_t</span> z<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre>Generates <code class="computeroutput">z</code> random numbers and discards them. </li>
 134 </ol></div>
 135 </div>
 136 </div>
 137 </div>
 138 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 139 <td align="left"></td>
 140 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
 141         Distributed under the Boost Software License, Version 1.0. (See accompanying
 142         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>)
 143       </p>
 144 </div></td>
 145 </tr></table>
 146 <hr>
 147 <div class="spirit-nav">
 148 <a accesskey="p" href="discrete_distribution.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.random.linear_congruential_engine_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="mersenne_twister_engine.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 149 </div>
 150 </body>
 151 </html>