diff options
Diffstat (limited to 'doc/html/boost/random/gamma_distribution/param_type.html')
| -rw-r--r-- | doc/html/boost/random/gamma_distribution/param_type.html | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/doc/html/boost/random/gamma_distribution/param_type.html b/doc/html/boost/random/gamma_distribution/param_type.html index e7a92e55d0..9eb2539feb 100644 --- a/doc/html/boost/random/gamma_distribution/param_type.html +++ b/doc/html/boost/random/gamma_distribution/param_type.html @@ -6,7 +6,7 @@ <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> -<link rel="up" href="../gamma_distribution.html#idp478748784" title="Description"> +<link rel="up" href="../gamma_distribution.html#idp497603808" title="Description"> <link rel="prev" href="../gamma_distribution.html" title="Class template gamma_distribution"> <link rel="next" href="../generate_canonical.html" title="Function template generate_canonical"> </head> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../gamma_distribution.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../gamma_distribution.html#idp478748784"><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="../generate_canonical.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../gamma_distribution.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../gamma_distribution.html#idp497603808"><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="../generate_canonical.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.random.gamma_distribution.param_type"></a><div class="titlepage"></div> @@ -40,72 +40,72 @@ <span class="keyword">typedef</span> <a class="link" href="../gamma_distribution.html" title="Class template gamma_distribution">gamma_distribution</a> <a name="boost.random.gamma_distribution.param_type.distribution_type"></a><span class="identifier">distribution_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="param_type.html#boost.random.gamma_distribution.param_typeconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="param_type.html#idp735684832-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&</span> <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&</span> <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="param_type.html#idp717427392-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&</span> <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&</span> <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="param_type.html#idp735680976-bb">public member functions</a></span> - <span class="identifier">RealType</span> <a class="link" href="param_type.html#idp735681536-bb"><span class="identifier">alpha</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">RealType</span> <a class="link" href="param_type.html#idp735683104-bb"><span class="identifier">beta</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="param_type.html#idp717423536-bb">public member functions</a></span> + <span class="identifier">RealType</span> <a class="link" href="param_type.html#idp717424096-bb"><span class="identifier">alpha</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">RealType</span> <a class="link" href="param_type.html#idp717425664-bb"><span class="identifier">beta</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="param_type.html#idp735688704-bb">friend functions</a></span> + <span class="comment">// <a class="link" href="param_type.html#idp717431264-bb">friend functions</a></span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span> <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> - <a class="link" href="param_type.html#idp735689264-bb"><span class="keyword">operator</span><span class="special"><<</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="param_type.html#idp717431824-bb"><span class="keyword">operator</span><span class="special"><<</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</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> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span> <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> - <a class="link" href="param_type.html#idp735694272-bb"><span class="keyword">operator</span><span class="special">>></span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="param_type.html#idp735699120-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="param_type.html#idp735702704-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="param_type.html#idp717436832-bb"><span class="keyword">operator</span><span class="special">>></span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="param_type.html#idp717441680-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="param_type.html#idp717445264-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp479015024"></a><h2>Description</h2> +<a name="idp497870080"></a><h2>Description</h2> <div class="refsect2"> -<a name="idp479015440"></a><h3> +<a name="idp497870496"></a><h3> <a name="boost.random.gamma_distribution.param_typeconstruct-copy-destruct"></a><code class="computeroutput">param_type</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a name="idp735684832-bb"></a><span class="identifier">param_type</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&</span> alpha <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&</span> beta <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp717427392-bb"></a><span class="identifier">param_type</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&</span> alpha <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&</span> beta <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="param_type.html" title="Class param_type">param_type</a></code></code> object from the "alpha" and "beta" parameters.</p> <p>Requires: alpha > 0 && beta > 0 </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp479033072"></a><h3> -<a name="idp735680976-bb"></a><code class="computeroutput">param_type</code> public member functions</h3> +<a name="idp497888048"></a><h3> +<a name="idp717423536-bb"></a><code class="computeroutput">param_type</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="identifier">RealType</span> <a name="idp735681536-bb"></a><span class="identifier">alpha</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">RealType</span> <a name="idp717424096-bb"></a><span class="identifier">alpha</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the "alpha" parameter of the distribution. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">RealType</span> <a name="idp735683104-bb"></a><span class="identifier">beta</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">RealType</span> <a name="idp717425664-bb"></a><span class="identifier">beta</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the "beta" parameter of the distribution. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp479045888"></a><h3> -<a name="idp735688704-bb"></a><code class="computeroutput">param_type</code> friend functions</h3> +<a name="idp497900800"></a><h3> +<a name="idp717431264-bb"></a><code class="computeroutput">param_type</code> friend functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span> <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> - <a name="idp735689264-bb"></a><span class="keyword">operator</span><span class="special"><<</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> os<span class="special">,</span> + <a name="idp717431824-bb"></a><span class="keyword">operator</span><span class="special"><<</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> os<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> param<span class="special">)</span><span class="special">;</span></pre> <p>Writes the parameters to a <code class="computeroutput">std::ostream</code>. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span> <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> - <a name="idp735694272-bb"></a><span class="keyword">operator</span><span class="special">>></span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> is<span class="special">,</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> param<span class="special">)</span><span class="special">;</span></pre> + <a name="idp717436832-bb"></a><span class="keyword">operator</span><span class="special">>></span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> is<span class="special">,</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> param<span class="special">)</span><span class="special">;</span></pre> <p>Reads the parameters from a <code class="computeroutput">std::istream</code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp735699120-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> lhs<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp717441680-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> lhs<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> <p>Returns true if the two sets of parameters are the same. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp735702704-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> lhs<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp717445264-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> lhs<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> <p>Returns true if the two sets fo parameters are different. </p> </li> </ol></div> @@ -122,7 +122,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../gamma_distribution.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../gamma_distribution.html#idp478748784"><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="../generate_canonical.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../gamma_distribution.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../gamma_distribution.html#idp497603808"><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="../generate_canonical.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |