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 random_number_generator</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.random_number_generator_hpp" title="Header <boost/random/random_number_generator.hpp>"> 10<link rel="prev" href="random_device.html" title="Class random_device"> 11<link rel="next" href="ranlux3.html" title="Type definition ranlux3"> 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="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> 25</div> 26<div class="refentry"> 27<a name="boost.random.random_number_generator"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template random_number_generator</span></h2> 30<p>boost::random::random_number_generator</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.random_number_generator_hpp" title="Header <boost/random/random_number_generator.hpp>">boost/random/random_number_generator.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</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">></span> 36<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> 37<span class="keyword">public</span><span class="special">:</span> 38 <span class="comment">// types</span> 39 <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> 40 <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> 41 <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> 42 43 <span class="comment">// <a class="link" href="random_number_generator.html#boost.random.random_number_generatorconstruct-copy-destruct">construct/copy/destruct</a></span> 44 <a class="link" href="random_number_generator.html#id-1_3_34_5_6_35_1_1_1_7-bb"><span class="identifier">random_number_generator</span></a><span class="special">(</span><span class="identifier">base_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 45 46 <span class="comment">// <a class="link" href="random_number_generator.html#id-1_3_34_5_6_35_1_1_1_6-bb">public member functions</a></span> 47 <span class="identifier">result_type</span> <a class="link" href="random_number_generator.html#id-1_3_34_5_6_35_1_1_1_6_1-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> 48<span class="special">}</span><span class="special">;</span></pre></div> 49<div class="refsect1"> 50<a name="id-1.3.34.5.6.34.3.4"></a><h2>Description</h2> 51<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> 52<p>The template parameter IntType shall denote some integer-like value type. </p> 53<div class="refsect2"> 54<a name="id-1.3.34.5.6.34.3.4.4"></a><h3> 55<a name="boost.random.random_number_generatorconstruct-copy-destruct"></a><code class="computeroutput">random_number_generator</code> 56 public 57 construct/copy/destruct</h3> 58<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 59<pre class="literallayout"><a name="id-1_3_34_5_6_35_1_1_1_7-bb"></a><span class="identifier">random_number_generator</span><span class="special">(</span><span class="identifier">base_type</span> <span class="special">&</span> rng<span class="special">)</span><span class="special">;</span></pre> 60<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> 61</li></ol></div> 62</div> 63<div class="refsect2"> 64<a name="id-1.3.34.5.6.34.3.4.5"></a><h3> 65<a name="id-1_3_34_5_6_35_1_1_1_6-bb"></a><code class="computeroutput">random_number_generator</code> public member functions</h3> 66<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 67<pre class="literallayout"><span class="identifier">result_type</span> <a name="id-1_3_34_5_6_35_1_1_1_6_1-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> 68<p>Returns a value in the range [0, n) </p> 69</li></ol></div> 70</div> 71</div> 72</div> 73<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 74<td align="left"></td> 75<td align="right"><div class="copyright-footer">Copyright © 2000-2005 Jens Maurer<br>Copyright © 2009, 2010 Steven Watanabe<p> 76 Distributed under the Boost Software License, Version 1.0. (See accompanying 77 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>) 78 </p> 79</div></td> 80</tr></table> 81<hr> 82<div class="spirit-nav"> 83<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> 84</div> 85</body> 86</html> 87
