<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template variate_generator</title>
<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../boost_random/reference.html#header.boost.random.variate_generator_hpp" title="Header <boost/random/variate_generator.hpp>">
<link rel="prev" href="random/uniform_smallint/param_type.html" title="Class param_type">
<span class="keyword">typedef</span> <span class="identifier">Distribution</span><span class="special">::</span><span class="identifier">result_type</span> <a name="boost.variate_generator.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
<span class="comment">// <a class="link" href="variate_generator.html#boost.variate_generatorconstruct-copy-destruct">construct/copy/destruct</a></span>
- <a class="link" href="variate_generator.html#id1294689-bb"><span class="identifier">variate_generator</span></a><span class="special">(</span><span class="identifier">Engine</span><span class="special">,</span> <span class="identifier">Distribution</span><span class="special">)</span><span class="special">;</span>
+ <a class="link" href="variate_generator.html#idp152176928-bb"><span class="identifier">variate_generator</span></a><span class="special">(</span><span class="identifier">Engine</span><span class="special">,</span> <span class="identifier">Distribution</span><span class="special">)</span><span class="special">;</span>
- <span class="comment">// <a class="link" href="variate_generator.html#id1294564-bb">public member functions</a></span>
- <span class="identifier">result_type</span> <a class="link" href="variate_generator.html#id1294568-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">result_type</span> <a class="link" href="variate_generator.html#id1294579-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
- <span class="identifier">engine_value_type</span> <span class="special">&</span> <a class="link" href="variate_generator.html#id1294604-bb"><span class="identifier">engine</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <span class="keyword">const</span> <span class="identifier">engine_value_type</span> <span class="special">&</span> <a class="link" href="variate_generator.html#id1294616-bb"><span class="identifier">engine</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="identifier">distribution_type</span> <span class="special">&</span> <a class="link" href="variate_generator.html#id1294629-bb"><span class="identifier">distribution</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
- <span class="keyword">const</span> <span class="identifier">distribution_type</span> <span class="special">&</span> <a class="link" href="variate_generator.html#id1294648-bb"><span class="identifier">distribution</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="identifier">result_type</span> <a class="link" href="variate_generator.html#id1294660-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
- <span class="identifier">result_type</span> <a class="link" href="variate_generator.html#id1294674-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="comment">// <a class="link" href="variate_generator.html#idp159542768-bb">public member functions</a></span>
+ <span class="identifier">result_type</span> <a class="link" href="variate_generator.html#idp159543328-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">result_type</span> <a class="link" href="variate_generator.html#idp159544608-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
+ <span class="identifier">engine_value_type</span> <span class="special">&</span> <a class="link" href="variate_generator.html#idp159547376-bb"><span class="identifier">engine</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">const</span> <span class="identifier">engine_value_type</span> <span class="special">&</span> <a class="link" href="variate_generator.html#idp159548704-bb"><span class="identifier">engine</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="identifier">distribution_type</span> <span class="special">&</span> <a class="link" href="variate_generator.html#idp159550320-bb"><span class="identifier">distribution</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
+ <span class="keyword">const</span> <span class="identifier">distribution_type</span> <span class="special">&</span> <a class="link" href="variate_generator.html#idp159552352-bb"><span class="identifier">distribution</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="identifier">result_type</span> <a class="link" href="variate_generator.html#idp152173024-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
+ <span class="identifier">result_type</span> <a class="link" href="variate_generator.html#idp152174896-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
-<a name="id3139915"></a><h2>Description</h2>
-<p>A random variate generator is used to join a random number generator together with a random number distribution. Boost.Random provides a vast choice of
<a class="link" href="../boost_random/reference.html#boost_random.reference.generators" title="Generators">generators</a> as well as <a class="link" href="../boost_random/reference.html#boost_random.reference.distributions" title="Distributions">distributions</a> .</p>
+<a name="idp417647088"></a><h2>Description</h2>
+<p>A random variate generator is used to join a random number generator together with a random number distribution. Boost.Random provides a vast choice of
<a class="link" href="../boost_random/reference.html#boost_random.reference.generators" title="Generators">generators</a> as well as <a class="link" href="../boost_random/reference.html#boost_random.reference.distributions" title="Distributions">distributions</a> .</p>
<p>The argument for the template parameter Engine shall be of the form U, U&, or U*, where U models a <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> . Then, the member engine_value_type names U (not the pointer or reference to U).</p>
<p>Specializations of <code class="computeroutput"><a class="link" href="variate_generator.html" title="Class template variate_generator">variate_generator</a></code> satisfy the requirements of CopyConstructible. They also satisfy the requirements of Assignable unless the template parameter Engine is of the form U&.</p>
<p>The complexity of all functions specified in this section is constant. No function described in this section except the constructor throws an exception. </p>
<div class="refsect2">
-<a name="id3139977"></a><h3>
+<a name="idp417653424"></a><h3>
<a name="boost.variate_generatorconstruct-copy-destruct"></a><code class="computeroutput">variate_generator</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
-<pre class="literallayout"><a name="id1294689-bb"></a><span class="identifier">variate_generator</span><span class="special">(</span><span class="identifier">Engine</span> e<span class="special">,</span> <span class="identifier">Distribution</span> d<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><a name="idp152176928-bb"></a><span class="identifier">variate_generator</span><span class="special">(</span><span class="identifier">Engine</span> e<span class="special">,</span> <span class="identifier">Distribution</span> d<span class="special">)</span><span class="special">;</span></pre>
<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="variate_generator.html" title="Class template variate_generator">variate_generator</a></code></code> object with the associated <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> eng and the associated <a class="link" href="../boost_random/reference.html#boost_random.reference.concepts.random_distribution" title="Random Distribution">random distribution</a> d.</p>
<p>Throws: If and what the copy constructor of Engine or Distribution throws. </p>
</li></ol></div>
</div>
<div class="refsect2">
-<a name="id3140081"></a><h3>
-<a name="id1294564-bb"></a><code class="computeroutput">variate_generator</code> public member functions</h3>
+<a name="idp417665536"></a><h3>
+<a name="idp159542768-bb"></a><code class="computeroutput">variate_generator</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
-<pre class="literallayout"><span class="identifier">result_type</span> <a name="id1294568-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="identifier">result_type</span> <a name="idp159543328-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Returns: distribution()(engine()) </p>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">result_type</span> <a name="id1294579-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">result_type</span> <a name="idp159544608-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>
<p>Returns: distribution()(engine(), value). </p>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="identifier">engine_value_type</span> <span class="special">&</span> <a name="id1294604-bb"></a><span class="identifier">engine</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="identifier">engine_value_type</span> <span class="special">&</span> <a name="idp159547376-bb"></a><span class="identifier">engine</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p>Returns: A reference to the associated uniform random number generator. </p>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">engine_value_type</span> <span class="special">&</span> <a name="id1294616-bb"></a><span class="identifier">engine</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">engine_value_type</span> <span class="special">&</span> <a name="idp159548704-bb"></a><span class="identifier">engine</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns: A reference to the associated uniform random number generator. </p>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="identifier">distribution_type</span> <span class="special">&</span> <a name="id1294629-bb"></a><span class="identifier">distribution</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
-<p>Returns: A reference to the associated
<a class="link" href="../boost_random/reference.html#boost_random.reference.concepts.random_distribution" title="Random Distribution">random distribution</a> . </p>
+<pre class="literallayout"><span class="identifier">distribution_type</span> <span class="special">&</span> <a name="idp159550320-bb"></a><span class="identifier">distribution</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
+<p>Returns: A reference to the associated <a class="link" href="../boost_random/reference.html#boost_random.reference.concepts.random_distribution" title="Random Distribution">random distribution</a> . </p>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">distribution_type</span> <span class="special">&</span> <a name="id1294648-bb"></a><span class="identifier">distribution</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">distribution_type</span> <span class="special">&</span> <a name="idp159552352-bb"></a><span class="identifier">distribution</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Returns: A reference to the associated random distribution. </p>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="identifier">result_type</span> <a name="id1294660-bb"></a><span class="identifier">min</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="identifier">result_type</span> <a name="idp152173024-bb"></a><span class="identifier">min</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Precondition: distribution().min() is well-formed</p>
<p>Returns: distribution().min() </p>
</li>
<li class="listitem">
-<pre class="literallayout"><span class="identifier">result_type</span> <a name="id1294674-bb"></a><span class="identifier">max</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
+<pre class="literallayout"><span class="identifier">result_type</span> <a name="idp152174896-bb"></a><span class="identifier">max</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p>Precondition: distribution().max() is well-formed</p>
<p>Returns: distribution().max() </p>
</li>
projects / platform / upstream / boost.git / blobdiff