1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Class template normal_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.normal_distribution_hpp" title="Header <boost/compute/random/normal_distribution.hpp>"> 9<link rel="prev" href="mersenne_twister_engine.html" title="Class template mersenne_twister_engine"> 10<link rel="next" href="threefry_engine.html" title="Class template threefry_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="mersenne_twister_engine.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.random.normal_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="threefry_engine.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.compute.normal_distribution"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Class template normal_distribution</span></h2> 29<p>boost::compute::normal_distribution — Produces random, normally-distributed floating-point numbers. </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.normal_distribution_hpp" title="Header <boost/compute/random/normal_distribution.hpp>">boost/compute/random/normal_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="normal_distribution.html" title="Class template normal_distribution">normal_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">RealType</span> <a name="boost.compute.normal_distribution.result_type"></a><span class="identifier">result_type</span><span class="special">;</span> 39 40 <span class="comment">// <a class="link" href="normal_distribution.html#boost.compute.normal_distributionconstruct-copy-destruct">construct/copy/destruct</a></span> 41 <a class="link" href="normal_distribution.html#idm45549384322960-bb"><span class="identifier">normal_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="identifier">f</span><span class="special">,</span> <span class="identifier">RealType</span> <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="identifier">f</span><span class="special">)</span><span class="special">;</span> 42 <a class="link" href="normal_distribution.html#idm45549384319360-bb"><span class="special">~</span><span class="identifier">normal_distribution</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 43 44 <span class="comment">// <a class="link" href="normal_distribution.html#idm45549384335856-bb">public member functions</a></span> 45 <span class="identifier">result_type</span> <a class="link" href="normal_distribution.html#idm45549384335296-bb"><span class="identifier">mean</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 46 <span class="identifier">result_type</span> <a class="link" href="normal_distribution.html#idm45549384333856-bb"><span class="identifier">stddev</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> <span class="identifier">min</span> <a class="link" href="normal_distribution.html#idm45549384332416-bb"><span class="identifier">BOOST_PREVENT_MACRO_SUBSTITUTION</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 48 <span class="identifier">result_type</span> <span class="identifier">max</span> <a class="link" href="normal_distribution.html#idm45549384330960-bb"><span class="identifier">BOOST_PREVENT_MACRO_SUBSTITUTION</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 49 <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> 50 <span class="keyword">void</span> <a class="link" href="normal_distribution.html#idm45549384329504-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> 51 <span class="identifier">command_queue</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 52 53 <span class="comment">// <a class="link" href="normal_distribution.html#idm45549384318752-bb">private member functions</a></span> 54 <a class="link" href="normal_distribution.html#idm45549384318176-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> 55 <span class="string">"Template argument must be a floating point type"</span><span class="special">)</span><span class="special">;</span> 56<span class="special">}</span><span class="special">;</span></pre></div> 57<div class="refsect1"> 58<a name="idm45849504708752"></a><h2>Description</h2> 59<p>The following example shows how to setup a normal distribution to produce random <code class="computeroutput">float</code> values centered at <code class="computeroutput">5</code>:</p> 60<pre class="programlisting"></pre> 61<p> </p> 62<p><span class="bold"><strong>See Also:</strong></span></p> 63<p>default_random_engine, <a class="link" href="uniform_real_distribution.html" title="Class template uniform_real_distribution">uniform_real_distribution</a> </p> 64<p> 65</p> 66<p> 67</p> 68<div class="refsect2"> 69<a name="idm45849504703872"></a><h3> 70<a name="boost.compute.normal_distributionconstruct-copy-destruct"></a><code class="computeroutput">normal_distribution</code> 71 public 72 construct/copy/destruct</h3> 73<div class="orderedlist"><ol class="orderedlist" type="1"> 74<li class="listitem"> 75<pre class="literallayout"><a name="idm45549384322960-bb"></a><span class="identifier">normal_distribution</span><span class="special">(</span><span class="identifier">RealType</span> mean <span class="special">=</span> <span class="number">0</span><span class="special">.</span><span class="identifier">f</span><span class="special">,</span> <span class="identifier">RealType</span> stddev <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="identifier">f</span><span class="special">)</span><span class="special">;</span></pre> 76<p>Creates a new normal distribution producing numbers with the given <code class="computeroutput">mean</code> and <code class="computeroutput">stddev</code>. </p> 77</li> 78<li class="listitem"> 79<pre class="literallayout"><a name="idm45549384319360-bb"></a><span class="special">~</span><span class="identifier">normal_distribution</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destroys the normal distribution object. </li> 80</ol></div> 81</div> 82<div class="refsect2"> 83<a name="idm45849504685360"></a><h3> 84<a name="idm45549384335856-bb"></a><code class="computeroutput">normal_distribution</code> public member functions</h3> 85<div class="orderedlist"><ol class="orderedlist" type="1"> 86<li class="listitem"> 87<pre class="literallayout"><span class="identifier">result_type</span> <a name="idm45549384335296-bb"></a><span class="identifier">mean</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the mean value of the distribution. </li> 88<li class="listitem"> 89<pre class="literallayout"><span class="identifier">result_type</span> <a name="idm45549384333856-bb"></a><span class="identifier">stddev</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the standard-deviation of the distribution. </li> 90<li class="listitem"> 91<pre class="literallayout"><span class="identifier">result_type</span> <span class="identifier">min</span> <a name="idm45549384332416-bb"></a><span class="identifier">BOOST_PREVENT_MACRO_SUBSTITUTION</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> 92<li class="listitem"> 93<pre class="literallayout"><span class="identifier">result_type</span> <span class="identifier">max</span> <a name="idm45549384330960-bb"></a><span class="identifier">BOOST_PREVENT_MACRO_SUBSTITUTION</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> 94<li class="listitem"> 95<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> 96 <span class="keyword">void</span> <a name="idm45549384329504-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> 97 <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> 98<p>Generates normally-distributed floating-point numbers and stores them to the range [<code class="computeroutput">first</code>, <code class="computeroutput">last</code>). </p> 99</li> 100</ol></div> 101</div> 102<div class="refsect2"> 103<a name="idm45849504645008"></a><h3> 104<a name="idm45549384318752-bb"></a><code class="computeroutput">normal_distribution</code> private member functions</h3> 105<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"> <a name="idm45549384318176-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> 106 <span class="string">"Template argument must be a floating point type"</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> 107</div> 108</div> 109</div> 110<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 111<td align="left"></td> 112<td align="right"><div class="copyright-footer">Copyright © 2013, 2014 Kyle Lutz<p> 113 Distributed under the Boost Software License, Version 1.0. (See accompanying 114 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>) 115 </p> 116</div></td> 117</tr></table> 118<hr> 119<div class="spirit-nav"> 120<a accesskey="p" href="mersenne_twister_engine.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_compute/reference.html#header.boost.compute.random.normal_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="threefry_engine.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> 121</div> 122</body> 123</html> 124
