1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class template bernoulli_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.bernoulli_distribution_hpp" title="Header <boost/compute/random/bernoulli_distribution.hpp>"> 9<link rel="prev" href="svm_ptr.html" title="Class template svm_ptr"> 10<link rel="next" href="discrete_distribution.html" title="Class template discrete_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="svm_ptr.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.random.bernoulli_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="discrete_distribution.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.compute.bernoulli_distribution"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Class template bernoulli_distribution</span></h2> 29<p>boost::compute::bernoulli_distribution — Produces random boolean values according to the following discrete probability function with parameter p : P(true/p) = p and P(false/p) = (1 - p) </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.bernoulli_distribution_hpp" title="Header <boost/compute/random/bernoulli_distribution.hpp>">boost/compute/random/bernoulli_distribution.hpp</a>> 33 34</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> RealType <span class="special">=</span> <span class="keyword">float</span><span class="special">></span> 35<span class="keyword">class</span> <a class="link" href="bernoulli_distribution.html" title="Class template bernoulli_distribution">bernoulli_distribution</a> <span class="special">{</span> 36<span class="keyword">public</span><span class="special">:</span> 37 <span class="comment">// <a class="link" href="bernoulli_distribution.html#boost.compute.bernoulli_distributionconstruct-copy-destruct">construct/copy/destruct</a></span> 38 <a class="link" href="bernoulli_distribution.html#idm45549384467552-bb"><span class="identifier">bernoulli_distribution</span></a><span class="special">(</span><span class="identifier">RealType</span> <span class="special">=</span> <span class="number">0</span><span class="special">.</span><span class="number">5f</span><span class="special">)</span><span class="special">;</span> 39 <a class="link" href="bernoulli_distribution.html#idm45549384465984-bb"><span class="special">~</span><span class="identifier">bernoulli_distribution</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 40 41 <span class="comment">// <a class="link" href="bernoulli_distribution.html#idm45549384476064-bb">public member functions</a></span> 42 <span class="identifier">RealType</span> <a class="link" href="bernoulli_distribution.html#idm45549384475504-bb"><span class="identifier">p</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 43 <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> 44 <span class="keyword">void</span> <a class="link" href="bernoulli_distribution.html#idm45549384474080-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> 45 <span class="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 46 47 <span class="comment">// <a class="link" href="bernoulli_distribution.html#idm45549384464672-bb">private member functions</a></span> 48 <a class="link" href="bernoulli_distribution.html#idm45549384464096-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_floating_point</span><span class="special"><</span> <span class="identifier">RealType</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">,</span> 49 <span class="string">"Template argument must be a floating point type"</span><span class="special">)</span><span class="special">;</span> 50<span class="special">}</span><span class="special">;</span></pre></div> 51<div class="refsect1"> 52<a name="idm45849505446656"></a><h2>Description</h2> 53<p>The following example shows how to setup a bernoulli distribution to produce random boolean values with parameter p = 0.25</p> 54<pre class="programlisting"></pre> 55<div class="refsect2"> 56<a name="idm45849505445312"></a><h3> 57<a name="boost.compute.bernoulli_distributionconstruct-copy-destruct"></a><code class="computeroutput">bernoulli_distribution</code> 58 public 59 construct/copy/destruct</h3> 60<div class="orderedlist"><ol class="orderedlist" type="1"> 61<li class="listitem"> 62<pre class="literallayout"><a name="idm45549384467552-bb"></a><span class="identifier">bernoulli_distribution</span><span class="special">(</span><span class="identifier">RealType</span> p <span class="special">=</span> <span class="number">0</span><span class="special">.</span><span class="number">5f</span><span class="special">)</span><span class="special">;</span></pre>Creates a new bernoulli distribution. </li> 63<li class="listitem"> 64<pre class="literallayout"><a name="idm45549384465984-bb"></a><span class="special">~</span><span class="identifier">bernoulli_distribution</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the <code class="computeroutput"><a class="link" href="bernoulli_distribution.html" title="Class template bernoulli_distribution">bernoulli_distribution</a></code> object. </li> 65</ol></div> 66</div> 67<div class="refsect2"> 68<a name="idm45849505430688"></a><h3> 69<a name="idm45549384476064-bb"></a><code class="computeroutput">bernoulli_distribution</code> public member functions</h3> 70<div class="orderedlist"><ol class="orderedlist" type="1"> 71<li class="listitem"> 72<pre class="literallayout"><span class="identifier">RealType</span> <a name="idm45549384475504-bb"></a><span class="identifier">p</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the value of the parameter p. </li> 73<li class="listitem"> 74<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> 75 <span class="keyword">void</span> <a name="idm45549384474080-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> 76 <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> 77<p>Generates bernoulli distributed booleans and stores them in the range [<code class="computeroutput">first</code>, <code class="computeroutput">last</code>). </p> 78</li> 79</ol></div> 80</div> 81<div class="refsect2"> 82<a name="idm45849505407504"></a><h3> 83<a name="idm45549384464672-bb"></a><code class="computeroutput">bernoulli_distribution</code> private member functions</h3> 84<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"> <a name="idm45549384464096-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_floating_point</span><span class="special"><</span> <span class="identifier">RealType</span> <span class="special">></span><span class="special">::</span><span class="identifier">value</span><span class="special">,</span> 85 <span class="string">"Template argument must be a floating point type"</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> 86</div> 87</div> 88</div> 89<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 90<td align="left"></td> 91<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p> 92 Distributed under the Boost Software License, Version 1.0. (See accompanying 93 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>) 94 </p> 95</div></td> 96</tr></table> 97<hr> 98<div class="spirit-nav"> 99<a accesskey="p" href="svm_ptr.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.random.bernoulli_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="discrete_distribution.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 100</div> 101</body> 102</html> 103
