1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class template uniform_int_distribution</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 1. Boost.Compute"> 8<link rel="up" href="../../boost_compute/reference.html#header.boost.compute.random.uniform_int_distribution_hpp" title="Header <boost/compute/random/uniform_int_distribution.hpp>"> 9<link rel="prev" href="threefry_engine.html" title="Class template threefry_engine"> 10<link rel="next" href="uniform_real_distribution.html" title="Class template uniform_real_distribution"> 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="threefry_engine.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.random.uniform_int_distribution_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="uniform_real_distribution.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.compute.uniform_int_distribution"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Class template uniform_int_distribution</span></h2> 29<p>boost::compute::uniform_int_distribution — Produces uniformily distributed random integers. </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: <<a class="link" href="../../boost_compute/reference.html#header.boost.compute.random.uniform_int_distribution_hpp" title="Header <boost/compute/random/uniform_int_distribution.hpp>">boost/compute/random/uniform_int_distribution.hpp</a>> 33 34</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntType <span class="special">=</span> <span class="identifier">uint_</span><span class="special">></span> 35<span class="keyword">class</span> <a class="link" href="uniform_int_distribution.html" title="Class template uniform_int_distribution">uniform_int_distribution</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">IntType</span> <a name="boost.compute.uniform_int_distribution.result_type"></a><span class="identifier">result_type</span><span class="special">;</span> 39 40 <span class="comment">// <a class="link" href="uniform_int_distribution.html#boost.compute.uniform_int_distributionconstruct-copy-destruct">construct/copy/destruct</a></span> 41 <span class="keyword">explicit</span> <a class="link" href="uniform_int_distribution.html#idm45549384258432-bb"><span class="identifier">uniform_int_distribution</span></a><span class="special">(</span><span class="identifier">IntType</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> 42 <span class="identifier">IntType</span> <span class="special">=</span> <span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">numeric_limits</span><span class="special"><</span> <span class="identifier">IntType</span> <span class="special">></span><span class="special">::</span><span class="identifier">max</span><span class="special">)</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> 43 <a class="link" href="uniform_int_distribution.html#idm45549384254544-bb"><span class="special">~</span><span class="identifier">uniform_int_distribution</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 44 45 <span class="comment">// <a class="link" href="uniform_int_distribution.html#idm45549384268416-bb">public member functions</a></span> 46 <span class="identifier">result_type</span> <a class="link" href="uniform_int_distribution.html#idm45549384267856-bb"><span class="identifier">a</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 47 <span class="identifier">result_type</span> <a class="link" href="uniform_int_distribution.html#idm45549384266416-bb"><span class="identifier">b</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 48 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> OutputIterator<span class="special">,</span> <span class="keyword">typename</span> Generator<span class="special">></span> 49 <span class="keyword">void</span> <a class="link" href="uniform_int_distribution.html#idm45549384264976-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">Generator</span> <span class="special">&</span><span class="special">,</span> 50 <span class="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 51 52 <span class="comment">// <a class="link" href="uniform_int_distribution.html#idm45549384253200-bb">private member functions</a></span> 53 <a class="link" href="uniform_int_distribution.html#idm45549384252624-bb"><span class="identifier">BOOST_STATIC_ASSERT_MSG</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_integral</span><span class="special"><</span> <span class="identifier">IntType</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">,</span> 54 <span class="string">"Template argument must be integral"</span><span class="special">)</span><span class="special">;</span> 55<span class="special">}</span><span class="special">;</span></pre></div> 56<div class="refsect1"> 57<a name="idm45849504334000"></a><h2>Description</h2> 58<p>The following example shows how to setup a uniform int distribution to produce random integers 0 and 1.</p> 59<pre class="programlisting"></pre> 60<div class="refsect2"> 61<a name="idm45849504332688"></a><h3> 62<a name="boost.compute.uniform_int_distributionconstruct-copy-destruct"></a><code class="computeroutput">uniform_int_distribution</code> 63 public 64 construct/copy/destruct</h3> 65<div class="orderedlist"><ol class="orderedlist" type="1"> 66<li class="listitem"> 67<pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45549384258432-bb"></a><span class="identifier">uniform_int_distribution</span><span class="special">(</span><span class="identifier">IntType</span> a <span class="special">=</span> <span class="number">0</span><span class="special">,</span> 68 <span class="identifier">IntType</span> b <span class="special">=</span> <span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">numeric_limits</span><span class="special"><</span> <span class="identifier">IntType</span> <span class="special">></span><span class="special">::</span><span class="identifier">max</span><span class="special">)</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> 69<p>Creates a new uniform distribution producing numbers in the range [<code class="computeroutput">a</code>, <code class="computeroutput">b</code>]. </p> 70</li> 71<li class="listitem"> 72<pre class="literallayout"><a name="idm45549384254544-bb"></a><span class="special">~</span><span class="identifier">uniform_int_distribution</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the <code class="computeroutput"><a class="link" href="uniform_int_distribution.html" title="Class template uniform_int_distribution">uniform_int_distribution</a></code> object. </li> 73</ol></div> 74</div> 75<div class="refsect2"> 76<a name="idm45849504308320"></a><h3> 77<a name="idm45549384268416-bb"></a><code class="computeroutput">uniform_int_distribution</code> public member functions</h3> 78<div class="orderedlist"><ol class="orderedlist" type="1"> 79<li class="listitem"> 80<pre class="literallayout"><span class="identifier">result_type</span> <a name="idm45549384267856-bb"></a><span class="identifier">a</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the minimum value of the distribution. </li> 81<li class="listitem"> 82<pre class="literallayout"><span class="identifier">result_type</span> <a name="idm45549384266416-bb"></a><span class="identifier">b</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the maximum value of the distribution. </li> 83<li class="listitem"> 84<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> OutputIterator<span class="special">,</span> <span class="keyword">typename</span> Generator<span class="special">></span> 85 <span class="keyword">void</span> <a name="idm45549384264976-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> 86 <span class="identifier">Generator</span> <span class="special">&</span> generator<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&</span> queue<span class="special">)</span><span class="special">;</span></pre> 87<p>Generates uniformily distributed integers and stores them to the range [<code class="computeroutput">first</code>, <code class="computeroutput">last</code>). </p> 88</li> 89</ol></div> 90</div> 91<div class="refsect2"> 92<a name="idm45849504279696"></a><h3> 93<a name="idm45549384253200-bb"></a><code class="computeroutput">uniform_int_distribution</code> private member functions</h3> 94<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"> <a name="idm45549384252624-bb"></a><span class="identifier">BOOST_STATIC_ASSERT_MSG</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_integral</span><span class="special"><</span> <span class="identifier">IntType</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">,</span> 95 <span class="string">"Template argument must be integral"</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> 96</div> 97</div> 98</div> 99<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 100<td align="left"></td> 101<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p> 102 Distributed under the Boost Software License, Version 1.0. (See accompanying 103 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>) 104 </p> 105</div></td> 106</tr></table> 107<hr> 108<div class="spirit-nav"> 109<a accesskey="p" href="threefry_engine.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.random.uniform_int_distribution_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="uniform_real_distribution.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 110</div> 111</body> 112</html> 113
