diff options
Diffstat (limited to 'doc/html/boost/variate_generator.html')
| -rw-r--r-- | doc/html/boost/variate_generator.html | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/doc/html/boost/variate_generator.html b/doc/html/boost/variate_generator.html index 510e49cd41..7ecd373a93 100644 --- a/doc/html/boost/variate_generator.html +++ b/doc/html/boost/variate_generator.html @@ -42,70 +42,70 @@ <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#idp711873776-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#idp738566624-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#idp711858624-bb">public member functions</a></span> - <span class="identifier">result_type</span> <a class="link" href="variate_generator.html#idp711859184-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#idp711860464-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#idp711863296-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#idp711864624-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#idp711866240-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#idp711868272-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#idp711869872-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#idp711871744-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#idp738551472-bb">public member functions</a></span> + <span class="identifier">result_type</span> <a class="link" href="variate_generator.html#idp738552032-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#idp738553312-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#idp738556144-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#idp738557472-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#idp738559088-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#idp738561120-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#idp738562720-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#idp738564592-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="idp512508928"></a><h2>Description</h2> +<a name="idp496240416"></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="idp512515232"></a><h3> +<a name="idp496246704"></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="idp711873776-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="idp738566624-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="idp512527344"></a><h3> -<a name="idp711858624-bb"></a><code class="computeroutput">variate_generator</code> public member functions</h3> +<a name="idp496258816"></a><h3> +<a name="idp738551472-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="idp711859184-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="idp738552032-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="idp711860464-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="idp738553312-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="idp711863296-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="idp738556144-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="idp711864624-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="idp738557472-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="idp711866240-bb"></a><span class="identifier">distribution</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">distribution_type</span> <span class="special">&</span> <a name="idp738559088-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="idp711868272-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="idp738561120-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="idp711869872-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="idp738562720-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="idp711871744-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="idp738564592-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> |