diff options
Diffstat (limited to 'doc/html/boost/random/poisson_distribution.html')
| -rw-r--r-- | doc/html/boost/random/poisson_distribution.html | 96 |
1 files changed, 48 insertions, 48 deletions
diff --git a/doc/html/boost/random/poisson_distribution.html b/doc/html/boost/random/poisson_distribution.html index ed88570606..7145f26d2c 100644 --- a/doc/html/boost/random/poisson_distribution.html +++ b/doc/html/boost/random/poisson_distribution.html @@ -7,7 +7,7 @@ <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="../../boost_random/reference.html#header.boost.random.poisson_distribution_hpp" title="Header <boost/random/poisson_distribution.hpp>"> -<link rel="prev" href="piecew_1_3_34_5_6_30_1_1_1/param_type.html" title="Class param_type"> +<link rel="prev" href="piecew_1_3_34_5_6_32_1_1_1/param_type.html" title="Class param_type"> <link rel="next" href="poisson_distribution/param_type.html" title="Class param_type"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="piecew_1_3_34_5_6_30_1_1_1/param_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.poisson_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="poisson_distribution/param_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="piecew_1_3_34_5_6_32_1_1_1/param_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.poisson_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="poisson_distribution/param_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.random.poisson_distribution"></a><div class="titlepage"></div> @@ -47,137 +47,137 @@ <span class="keyword">typedef</span> <a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a> <a class="link" href="poisson_distribution/param_type.html#boost.random.poisson_distribution.param_type.distribution_type"><span class="identifier">distribution_type</span></a><span class="special">;</span> <span class="comment">// <a class="link" href="poisson_distribution/param_type.html#boost.random.poisson_distribution.param_typeconstruct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="poisson_distribution/param_type.html#id-1_3_34_5_6_31_1_1_1_3_3-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="identifier">RealType</span> <span class="special">=</span> <span class="number">1</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="poisson_distribution/param_type.html#id-1_3_34_5_6_33_1_1_1_3_3-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="identifier">RealType</span> <span class="special">=</span> <span class="number">1</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="poisson_distribution/param_type.html#id-1_3_34_5_6_31_1_1_1_3_2-bb">public member functions</a></span> - <span class="identifier">RealType</span> <a class="link" href="poisson_distribution/param_type.html#id-1_3_34_5_6_31_1_1_1_3_2_1-bb"><span class="identifier">mean</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="poisson_distribution/param_type.html#id-1_3_34_5_6_33_1_1_1_3_2-bb">public member functions</a></span> + <span class="identifier">RealType</span> <a class="link" href="poisson_distribution/param_type.html#id-1_3_34_5_6_33_1_1_1_3_2_1-bb"><span class="identifier">mean</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="poisson_distribution/param_type.html#id-1_3_34_5_6_31_1_1_1_3_4-bb">friend functions</a></span> + <span class="comment">// <a class="link" href="poisson_distribution/param_type.html#id-1_3_34_5_6_33_1_1_1_3_4-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="poisson_distribution/param_type.html#id-1_3_34_5_6_31_1_1_1_3_4_1-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="poisson_distribution/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="poisson_distribution/param_type.html#id-1_3_34_5_6_33_1_1_1_3_4_1-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="poisson_distribution/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="poisson_distribution/param_type.html#id-1_3_34_5_6_31_1_1_1_3_4_2-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="poisson_distribution/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="poisson_distribution/param_type.html#id-1_3_34_5_6_31_1_1_1_3_4_3-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution/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="poisson_distribution/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="poisson_distribution/param_type.html#id-1_3_34_5_6_31_1_1_1_3_4_4-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution/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="poisson_distribution/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="poisson_distribution/param_type.html#id-1_3_34_5_6_33_1_1_1_3_4_2-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="poisson_distribution/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="poisson_distribution/param_type.html#id-1_3_34_5_6_33_1_1_1_3_4_3-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution/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="poisson_distribution/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="poisson_distribution/param_type.html#id-1_3_34_5_6_33_1_1_1_3_4_4-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution/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="poisson_distribution/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> <span class="comment">// <a class="link" href="poisson_distribution.html#boost.random.poisson_distributionconstruct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_31_1_1_1_7-bb"><span class="identifier">poisson_distribution</span></a><span class="special">(</span><span class="identifier">RealType</span> <span class="special">=</span> <span class="number">1</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">explicit</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_31_1_1_1_8-bb"><span class="identifier">poisson_distribution</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution/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">explicit</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_33_1_1_1_7-bb"><span class="identifier">poisson_distribution</span></a><span class="special">(</span><span class="identifier">RealType</span> <span class="special">=</span> <span class="number">1</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_33_1_1_1_8-bb"><span class="identifier">poisson_distribution</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_31_1_1_1_6-bb">public member functions</a></span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> URNG<span class="special">></span> <span class="identifier">IntType</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_31_1_1_1_6_1-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">URNG</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> URNG<span class="special">></span> <span class="identifier">IntType</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_31_1_1_1_6_2-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">URNG</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="poisson_distribution/param_type.html" title="Class param_type">param_type</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="poisson_distribution.html#id-1_3_34_5_6_31_1_1_1_6_3-bb"><span class="identifier">mean</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">IntType</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_31_1_1_1_6_4-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">IntType</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_31_1_1_1_6_5-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <a class="link" href="poisson_distribution/param_type.html" title="Class param_type">param_type</a> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_31_1_1_1_6_6-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_31_1_1_1_6_7-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution/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">void</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_31_1_1_1_6_8-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_33_1_1_1_6-bb">public member functions</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> URNG<span class="special">></span> <span class="identifier">IntType</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_33_1_1_1_6_1-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">URNG</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> URNG<span class="special">></span> <span class="identifier">IntType</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_33_1_1_1_6_2-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">URNG</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="poisson_distribution/param_type.html" title="Class param_type">param_type</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="poisson_distribution.html#id-1_3_34_5_6_33_1_1_1_6_3-bb"><span class="identifier">mean</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">IntType</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_33_1_1_1_6_4-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">IntType</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_33_1_1_1_6_5-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="poisson_distribution/param_type.html" title="Class param_type">param_type</a> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_33_1_1_1_6_6-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_33_1_1_1_6_7-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution/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">void</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_33_1_1_1_6_8-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_31_1_1_1_9-bb">friend functions</a></span> + <span class="comment">// <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_33_1_1_1_9-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="poisson_distribution.html#id-1_3_34_5_6_31_1_1_1_9_1-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> + <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_33_1_1_1_9_1-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="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</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="poisson_distribution.html#id-1_3_34_5_6_31_1_1_1_9_2-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="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</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="poisson_distribution.html#id-1_3_34_5_6_31_1_1_1_9_3-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a> <span class="special">&</span><span class="special">,</span> + <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_33_1_1_1_9_2-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="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</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="poisson_distribution.html#id-1_3_34_5_6_33_1_1_1_9_3-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</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="poisson_distribution.html#id-1_3_34_5_6_31_1_1_1_9_4-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a> <span class="special">&</span><span class="special">,</span> + <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="poisson_distribution.html#id-1_3_34_5_6_33_1_1_1_9_4-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</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="id-1.3.34.5.6.30.3.4"></a><h2>Description</h2> -<p>An instantiation of the class template <code class="computeroutput"><a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a></code> is a model of <a class="link" href="../../boost_random/reference.html#boost_random.reference.concepts.random_distribution" title="Random Distribution">random distribution</a> . The poisson distribution has <span class="inlinemediaobject"><img src="../../images/random//form_35.png"></span></p> +<a name="id-1.3.34.5.6.32.3.4"></a><h2>Description</h2> +<p>An instantiation of the class template <code class="computeroutput"><a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a></code> is a model of <a class="link" href="../../boost_random/reference.html#boost_random.reference.concepts.random_distribution" title="Random Distribution">random distribution</a> . The poisson distribution has <span class="inlinemediaobject"><img src="../../images/random//form_36.png"></span></p> <p>This implementation is based on the PTRD algorithm described</p> <p> </p> <div class="blockquote"><blockquote class="blockquote"><p> "The transformed rejection method for generating Poisson random variables", Wolfgang Hormann, Insurance: Mathematics and Economics Volume 12, Issue 1, February 1993, Pages 39-45 </p></blockquote></div> <p> </p> <div class="refsect2"> -<a name="id-1.3.34.5.6.30.3.4.5"></a><h3> +<a name="id-1.3.34.5.6.32.3.4.5"></a><h3> <a name="boost.random.poisson_distributionconstruct-copy-destruct"></a><code class="computeroutput">poisson_distribution</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_34_5_6_31_1_1_1_7-bb"></a><span class="identifier">poisson_distribution</span><span class="special">(</span><span class="identifier">RealType</span> mean <span class="special">=</span> <span class="number">1</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_34_5_6_33_1_1_1_7-bb"></a><span class="identifier">poisson_distribution</span><span class="special">(</span><span class="identifier">RealType</span> mean <span class="special">=</span> <span class="number">1</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a></code></code> with the parameter <code class="computeroutput">mean</code>.</p> <p>Requires: mean > 0 </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_34_5_6_31_1_1_1_8-bb"></a><span class="identifier">poisson_distribution</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> param<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_34_5_6_33_1_1_1_8-bb"></a><span class="identifier">poisson_distribution</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution/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>Construct an <code class="computeroutput"><code class="computeroutput"><a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a></code></code> object from the parameters. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="id-1.3.34.5.6.30.3.4.6"></a><h3> -<a name="id-1_3_34_5_6_31_1_1_1_6-bb"></a><code class="computeroutput">poisson_distribution</code> public member functions</h3> +<a name="id-1.3.34.5.6.32.3.4.6"></a><h3> +<a name="id-1_3_34_5_6_33_1_1_1_6-bb"></a><code class="computeroutput">poisson_distribution</code> public member 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> URNG<span class="special">></span> <span class="identifier">IntType</span> <a name="id-1_3_34_5_6_31_1_1_1_6_1-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">URNG</span> <span class="special">&</span> urng<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> URNG<span class="special">></span> <span class="identifier">IntType</span> <a name="id-1_3_34_5_6_33_1_1_1_6_1-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">URNG</span> <span class="special">&</span> urng<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a random variate distributed according to the poisson distribution. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> URNG<span class="special">></span> - <span class="identifier">IntType</span> <a name="id-1_3_34_5_6_31_1_1_1_6_2-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">URNG</span> <span class="special">&</span> urng<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="poisson_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> param<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> + <span class="identifier">IntType</span> <a name="id-1_3_34_5_6_33_1_1_1_6_2-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">URNG</span> <span class="special">&</span> urng<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="poisson_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> param<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a random variate distributed according to the poisson distribution with parameters specified by param. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">RealType</span> <a name="id-1_3_34_5_6_31_1_1_1_6_3-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> +<pre class="literallayout"><span class="identifier">RealType</span> <a name="id-1_3_34_5_6_33_1_1_1_6_3-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> <p>Returns the "mean" parameter of the distribution. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">IntType</span> <a name="id-1_3_34_5_6_31_1_1_1_6_4-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">IntType</span> <a name="id-1_3_34_5_6_33_1_1_1_6_4-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>Returns the smallest value that the distribution can produce. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">IntType</span> <a name="id-1_3_34_5_6_31_1_1_1_6_5-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">IntType</span> <a name="id-1_3_34_5_6_33_1_1_1_6_5-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>Returns the largest value that the distribution can produce. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="poisson_distribution/param_type.html" title="Class param_type">param_type</a> <a name="id-1_3_34_5_6_31_1_1_1_6_6-bb"></a><span class="identifier">param</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="poisson_distribution/param_type.html" title="Class param_type">param_type</a> <a name="id-1_3_34_5_6_33_1_1_1_6_6-bb"></a><span class="identifier">param</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the parameters of the distribution. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_31_1_1_1_6_7-bb"></a><span class="identifier">param</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> param<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_33_1_1_1_6_7-bb"></a><span class="identifier">param</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution/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>Sets parameters of the distribution. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_31_1_1_1_6_8-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_33_1_1_1_6_8-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="id-1.3.34.5.6.30.3.4.7"></a><h3> -<a name="id-1_3_34_5_6_31_1_1_1_9-bb"></a><code class="computeroutput">poisson_distribution</code> friend functions</h3> +<a name="id-1.3.34.5.6.32.3.4.7"></a><h3> +<a name="id-1_3_34_5_6_33_1_1_1_9-bb"></a><code class="computeroutput">poisson_distribution</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="id-1_3_34_5_6_31_1_1_1_9_1-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="id-1_3_34_5_6_33_1_1_1_9_1-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="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a> <span class="special">&</span> pd<span class="special">)</span><span class="special">;</span></pre> <p>Writes the parameters of the distribution 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="id-1_3_34_5_6_31_1_1_1_9_2-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 name="id-1_3_34_5_6_33_1_1_1_9_2-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="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a> <span class="special">&</span> pd<span class="special">)</span><span class="special">;</span></pre> <p>Reads the parameters of the distribution 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="id-1_3_34_5_6_31_1_1_1_9_3-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a> <span class="special">&</span> lhs<span class="special">,</span> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_33_1_1_1_9_3-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a> <span class="special">&</span> lhs<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> <p>Returns true if the two distributions will produce the same sequence of values, given equal generators. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_31_1_1_1_9_4-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a> <span class="special">&</span> lhs<span class="special">,</span> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_33_1_1_1_9_4-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a> <span class="special">&</span> lhs<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="poisson_distribution.html" title="Class template poisson_distribution">poisson_distribution</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> <p>Returns true if the two distributions could produce different sequences of values, given equal generators. </p> </li> @@ -195,7 +195,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="piecew_1_3_34_5_6_30_1_1_1/param_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.poisson_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="poisson_distribution/param_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="piecew_1_3_34_5_6_32_1_1_1/param_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.poisson_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="poisson_distribution/param_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |