libs/compute/doc/html/boost/compute/normal_distribution.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   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&#160;1.&#160;Boost.Compute">
   8 <link rel="up" href="../../boost_compute/reference.html#header.boost.compute.random.normal_distribution_hpp" title="Header &lt;boost/compute/random/normal_distribution.hpp&gt;">
   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 &#8212; 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: &lt;<a class="link" href="../../boost_compute/reference.html#header.boost.compute.random.normal_distribution_hpp" title="Header &lt;boost/compute/random/normal_distribution.hpp&gt;">boost/compute/random/normal_distribution.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RealType <span class="special">=</span> <span class="keyword">float</span><span class="special">&gt;</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#idp49691008-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#idp49694608-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#idp49678112-bb">public member functions</a></span>
  45   <span class="identifier">result_type</span> <a class="link" href="normal_distribution.html#idp49678672-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#idp49680112-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#idp49681552-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#idp49683008-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">&lt;</span><span class="keyword">typename</span> OutputIterator<span class="special">,</span> <span class="keyword">typename</span> Generator<span class="special">&gt;</span>
  50     <span class="keyword">void</span> <a class="link" href="normal_distribution.html#idp49684464-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">&amp;</span><span class="special">,</span>
  51                   <span class="identifier">command_queue</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  52
  53   <span class="comment">// <a class="link" href="normal_distribution.html#idp49695216-bb">private member functions</a></span>
  54    <a class="link" href="normal_distribution.html#idp49695792-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">&lt;</span> <span class="identifier">RealType</span> <span class="special">&gt;</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="idp111000656"></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 <div class="refsect2">
  67 <a name="idp111005408"></a><h3>
  68 <a name="boost.compute.normal_distributionconstruct-copy-destruct"></a><code class="computeroutput">normal_distribution</code>
  69         public
  70        construct/copy/destruct</h3>
  71 <div class="orderedlist"><ol class="orderedlist" type="1">
  72 <li class="listitem">
  73 <pre class="literallayout"><a name="idp49691008-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>
  74 <p>Creates a new normal distribution producing numbers with the given <code class="computeroutput">mean</code> and <code class="computeroutput">stddev</code>. </p>
  75 </li>
  76 <li class="listitem">
  77 <pre class="literallayout"><a name="idp49694608-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>
  78 </ol></div>
  79 </div>
  80 <div class="refsect2">
  81 <a name="idp111023920"></a><h3>
  82 <a name="idp49678112-bb"></a><code class="computeroutput">normal_distribution</code> public member functions</h3>
  83 <div class="orderedlist"><ol class="orderedlist" type="1">
  84 <li class="listitem">
  85 <pre class="literallayout"><span class="identifier">result_type</span> <a name="idp49678672-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>
  86 <li class="listitem">
  87 <pre class="literallayout"><span class="identifier">result_type</span> <a name="idp49680112-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>
  88 <li class="listitem">
  89 <pre class="literallayout"><span class="identifier">result_type</span> <span class="identifier">min</span> <a name="idp49681552-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>
  90 <li class="listitem">
  91 <pre class="literallayout"><span class="identifier">result_type</span> <span class="identifier">max</span> <a name="idp49683008-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>
  92 <li class="listitem">
  93 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> OutputIterator<span class="special">,</span> <span class="keyword">typename</span> Generator<span class="special">&gt;</span>
  94   <span class="keyword">void</span> <a name="idp49684464-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>
  95                 <span class="identifier">Generator</span> <span class="special">&amp;</span> generator<span class="special">,</span> <span class="identifier">command_queue</span> <span class="special">&amp;</span> queue<span class="special">)</span><span class="special">;</span></pre>
  96 <p>Generates normally-distributed floating-point numbers and stores them to the range [<code class="computeroutput">first</code>, <code class="computeroutput">last</code>). </p>
  97 </li>
  98 </ol></div>
  99 </div>
 100 <div class="refsect2">
 101 <a name="idp111064336"></a><h3>
 102 <a name="idp49695216-bb"></a><code class="computeroutput">normal_distribution</code> private member functions</h3>
 103 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"> <a name="idp49695792-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">&lt;</span> <span class="identifier">RealType</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">value</span><span class="special">,</span>
 104                          <span class="string">"Template argument must be a floating point type"</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div>
 105 </div>
 106 </div>
 107 </div>
 108 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 109 <td align="left"></td>
 110 <td align="right"><div class="copyright-footer">Copyright &#169; 2013, 2014 Kyle Lutz<p>
 111         Distributed under the Boost Software License, Version 1.0. (See accompanying
 112         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>)
 113       </p>
 114 </div></td>
 115 </tr></table>
 116 <hr>
 117 <div class="spirit-nav">
 118 <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>
 119 </div>
 120 </body>
 121 </html>