doc/html/boost/random/random_number_generator.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template random_number_generator</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../boost_random/reference.html#header.boost.random.random_number_generator_hpp" title="Header &lt;boost/random/random_number_generator.hpp&gt;">
   9 <link rel="prev" href="random_device.html" title="Class random_device">
  10 <link rel="next" href="ranlux3.html" title="Type definition ranlux3">
  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="random_device.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.random_number_generator_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="ranlux3.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.random.random_number_generator"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template random_number_generator</span></h2>
  29 <p>boost::random::random_number_generator</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_random/reference.html#header.boost.random.random_number_generator_hpp" title="Header &lt;boost/random/random_number_generator.hpp&gt;">boost/random/random_number_generator.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> URNG<span class="special">,</span> <span class="keyword">typename</span> IntType <span class="special">=</span> <span class="keyword">long</span><span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="random_number_generator.html" title="Class template random_number_generator">random_number_generator</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">URNG</span>    <a name="boost.random.random_number_generator.base_type"></a><span class="identifier">base_type</span><span class="special">;</span>
  39   <span class="keyword">typedef</span> <span class="identifier">IntType</span> <a name="boost.random.random_number_generator.argument_type"></a><span class="identifier">argument_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">IntType</span> <a name="boost.random.random_number_generator.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
  41
  42   <span class="comment">// <a class="link" href="random_number_generator.html#boost.random.random_number_generatorconstruct-copy-destruct">construct/copy/destruct</a></span>
  43   <a class="link" href="random_number_generator.html#idp99759008-bb"><span class="identifier">random_number_generator</span></a><span class="special">(</span><span class="identifier">base_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  44
  45   <span class="comment">// <a class="link" href="random_number_generator.html#idp39672640-bb">public member functions</a></span>
  46   <span class="identifier">result_type</span> <a class="link" href="random_number_generator.html#idp40869232-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">argument_type</span><span class="special">)</span><span class="special">;</span>
  47 <span class="special">}</span><span class="special">;</span></pre></div>
  48 <div class="refsect1">
  49 <a name="idp411940096"></a><h2>Description</h2>
  50 <p>Instantiations of class template <a class="link" href="random_number_generator.html" title="Class template random_number_generator">random_number_generator</a> model a RandomNumberGenerator (std:25.2.11 [lib.alg.random.shuffle]). On each invocation, it returns a uniformly distributed integer in the range [0..n).</p>
  51 <p>The template parameter IntType shall denote some integer-like value type. </p>
  52 <div class="refsect2">
  53 <a name="idp411942224"></a><h3>
  54 <a name="boost.random.random_number_generatorconstruct-copy-destruct"></a><code class="computeroutput">random_number_generator</code>
  55         public
  56        construct/copy/destruct</h3>
  57 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  58 <pre class="literallayout"><a name="idp99759008-bb"></a><span class="identifier">random_number_generator</span><span class="special">(</span><span class="identifier">base_type</span> <span class="special">&amp;</span> rng<span class="special">)</span><span class="special">;</span></pre>
  59 <p>Constructs a <code class="computeroutput"><a class="link" href="random_number_generator.html" title="Class template random_number_generator">random_number_generator</a></code> functor with the given  <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>  as the underlying source of random numbers. </p>
  60 </li></ol></div>
  61 </div>
  62 <div class="refsect2">
  63 <a name="idp411952096"></a><h3>
  64 <a name="idp39672640-bb"></a><code class="computeroutput">random_number_generator</code> public member functions</h3>
  65 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  66 <pre class="literallayout"><span class="identifier">result_type</span> <a name="idp40869232-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">argument_type</span> n<span class="special">)</span><span class="special">;</span></pre>
  67 <p>Returns a value in the range [0, n) </p>
  68 </li></ol></div>
  69 </div>
  70 </div>
  71 </div>
  72 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  73 <td align="left"></td>
  74 <td align="right"><div class="copyright-footer">Copyright &#169; 2000-2005 Jens Maurer<br>Copyright &#169; 2009, 2010 Steven Watanabe<p>
  75         Distributed under the Boost Software License, Version 1.0. (See accompanying
  76         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>)
  77       </p>
  78 </div></td>
  79 </tr></table>
  80 <hr>
  81 <div class="spirit-nav">
  82 <a accesskey="p" href="random_device.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.random_number_generator_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="ranlux3.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  83 </div>
  84 </body>
  85 </html>