diff options
Diffstat (limited to 'doc/html/boost/random/negati_1_3_34_5_6_26_1_1_1.html')
| -rw-r--r-- | doc/html/boost/random/negati_1_3_34_5_6_26_1_1_1.html | 206 |
1 files changed, 0 insertions, 206 deletions
diff --git a/doc/html/boost/random/negati_1_3_34_5_6_26_1_1_1.html b/doc/html/boost/random/negati_1_3_34_5_6_26_1_1_1.html deleted file mode 100644 index 0145c0181f..0000000000 --- a/doc/html/boost/random/negati_1_3_34_5_6_26_1_1_1.html +++ /dev/null @@ -1,206 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> -<title>Class template negative_binomial_distribution</title> -<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="../../boost_random/reference.html#header.boost.random.negative_binomial_distribution_hpp" title="Header <boost/random/negative_binomial_distribution.hpp>"> -<link rel="prev" href="../../BOOST_RAND_1_3_34_5_6_25_2.html" title="Macro BOOST_RANDOM_MERSENNE_TWISTER_DISCARD_THRESHOLD"> -<link rel="next" href="negati_1_3_34_5_6_26_1_1_1/param_type.html" title="Class param_type"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table cellpadding="2" width="100%"><tr> -<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> -<td align="center"><a href="../../../../index.html">Home</a></td> -<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> -<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> -<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> -<td align="center"><a href="../../../../more/index.htm">More</a></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="../../BOOST_RAND_1_3_34_5_6_25_2.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.negative_binomial_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="negati_1_3_34_5_6_26_1_1_1/param_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> -</div> -<div class="refentry"> -<a name="boost.random.negati_1_3_34_5_6_26_1_1_1"></a><div class="titlepage"></div> -<div class="refnamediv"> -<h2><span class="refentrytitle">Class template negative_binomial_distribution</span></h2> -<p>boost::random::negative_binomial_distribution</p> -</div> -<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../boost_random/reference.html#header.boost.random.negative_binomial_distribution_hpp" title="Header <boost/random/negative_binomial_distribution.hpp>">boost/random/negative_binomial_distribution.hpp</a>> - -</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntType <span class="special">=</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">typename</span> RealType <span class="special">=</span> <span class="keyword">double</span><span class="special">></span> -<span class="keyword">class</span> <a class="link" href="negati_1_3_34_5_6_26_1_1_1.html" title="Class template negative_binomial_distribution">negative_binomial_distribution</a> <span class="special">{</span> -<span class="keyword">public</span><span class="special">:</span> - <span class="comment">// types</span> - <span class="keyword">typedef</span> <span class="identifier">IntType</span> <a name="boost.random.negati_1_3_34_5_6_26_1_1_1.result_type"></a><span class="identifier">result_type</span><span class="special">;</span> - <span class="keyword">typedef</span> <span class="identifier">RealType</span> <a name="boost.random.negati_1_3_34_5_6_26_1_1_1.input_type"></a><span class="identifier">input_type</span><span class="special">;</span> - - <span class="comment">// member classes/structs/unions</span> - - <span class="keyword">class</span> <a class="link" href="negati_1_3_34_5_6_26_1_1_1/param_type.html" title="Class param_type">param_type</a> <span class="special">{</span> - <span class="keyword">public</span><span class="special">:</span> - <span class="comment">// types</span> - <span class="keyword">typedef</span> <a class="link" href="negati_1_3_34_5_6_26_1_1_1.html" title="Class template negative_binomial_distribution">negative_binomial_distribution</a> <a class="link" href="negati_1_3_34_5_6_26_1_1_1/param_type.html#boost.random.negati_1_3_34_5_6_26_1_1_1.param_type.distribution_type"><span class="identifier">distribution_type</span></a><span class="special">;</span> - - <span class="comment">// <a class="link" href="negati_1_3_34_5_6_26_1_1_1/param_type.html#boost.random.negati_1_3_34_5_6_26_1_1_1.param_typeconstruct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="negati_1_3_34_5_6_26_1_1_1/param_type.html#id-1_3_34_5_6_26_1_1_1_3_3-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="identifier">IntType</span> <span class="special">=</span> <span class="number">1</span><span class="special">,</span> <span class="identifier">RealType</span> <span class="special">=</span> <span class="number">0</span><span class="special">.</span><span class="number">5</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="negati_1_3_34_5_6_26_1_1_1/param_type.html#id-1_3_34_5_6_26_1_1_1_3_2-bb">public member functions</a></span> - <span class="identifier">IntType</span> <a class="link" href="negati_1_3_34_5_6_26_1_1_1/param_type.html#id-1_3_34_5_6_26_1_1_1_3_2_1-bb"><span class="identifier">k</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="negati_1_3_34_5_6_26_1_1_1/param_type.html#id-1_3_34_5_6_26_1_1_1_3_2_2-bb"><span class="identifier">p</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="negati_1_3_34_5_6_26_1_1_1/param_type.html#id-1_3_34_5_6_26_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="negati_1_3_34_5_6_26_1_1_1/param_type.html#id-1_3_34_5_6_26_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="negati_1_3_34_5_6_26_1_1_1/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="negati_1_3_34_5_6_26_1_1_1/param_type.html#id-1_3_34_5_6_26_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="negati_1_3_34_5_6_26_1_1_1/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="negati_1_3_34_5_6_26_1_1_1/param_type.html#id-1_3_34_5_6_26_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="negati_1_3_34_5_6_26_1_1_1/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="negati_1_3_34_5_6_26_1_1_1/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="negati_1_3_34_5_6_26_1_1_1/param_type.html#id-1_3_34_5_6_26_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="negati_1_3_34_5_6_26_1_1_1/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="negati_1_3_34_5_6_26_1_1_1/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="negati_1_3_34_5_6_26_1_1_1.html#boost.random.negati_1_3_34_5_6_26_1_1_1construct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_1_1_1_7-bb"><span class="identifier">negative_binomial_distribution</span></a><span class="special">(</span><span class="identifier">IntType</span> <span class="special">=</span> <span class="number">1</span><span class="special">,</span> <span class="identifier">RealType</span> <span class="special">=</span> <span class="number">0</span><span class="special">.</span><span class="number">5</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">explicit</span> <a class="link" href="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_1_1_1_8-bb"><span class="identifier">negative_binomial_distribution</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="negati_1_3_34_5_6_26_1_1_1/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="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_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="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_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="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_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="negati_1_3_34_5_6_26_1_1_1/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">IntType</span> <a class="link" href="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_1_1_1_6_3-bb"><span class="identifier">k</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="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_1_1_1_6_4-bb"><span class="identifier">p</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="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_1_1_1_6_5-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="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_1_1_1_6_6-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="negati_1_3_34_5_6_26_1_1_1/param_type.html" title="Class param_type">param_type</a> <a class="link" href="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_1_1_1_6_7-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="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_1_1_1_6_8-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="negati_1_3_34_5_6_26_1_1_1/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="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_1_1_1_6_9-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="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_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="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_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="negati_1_3_34_5_6_26_1_1_1.html" title="Class template negative_binomial_distribution">negative_binomial_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="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_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="negati_1_3_34_5_6_26_1_1_1.html" title="Class template negative_binomial_distribution">negative_binomial_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="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_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="negati_1_3_34_5_6_26_1_1_1.html" title="Class template negative_binomial_distribution">negative_binomial_distribution</a> <span class="special">&</span><span class="special">,</span> - <span class="keyword">const</span> <a class="link" href="negati_1_3_34_5_6_26_1_1_1.html" title="Class template negative_binomial_distribution">negative_binomial_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="negati_1_3_34_5_6_26_1_1_1.html#id-1_3_34_5_6_26_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="negati_1_3_34_5_6_26_1_1_1.html" title="Class template negative_binomial_distribution">negative_binomial_distribution</a> <span class="special">&</span><span class="special">,</span> - <span class="keyword">const</span> <a class="link" href="negati_1_3_34_5_6_26_1_1_1.html" title="Class template negative_binomial_distribution">negative_binomial_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.25.3.4"></a><h2>Description</h2> -<p>The negative binomial distribution is an integer valued distribution with two parameters, <code class="computeroutput">k</code> and <code class="computeroutput">p</code>. The distribution produces non-negative values.</p> -<p>The distribution function is <span class="inlinemediaobject"><img src="../../images/random//form_30.png"></span>.</p> -<p>This implementation uses a gamma-poisson mixture. </p> -<div class="refsect2"> -<a name="id-1.3.34.5.6.25.3.4.5"></a><h3> -<a name="boost.random.negati_1_3_34_5_6_26_1_1_1construct-copy-destruct"></a><code class="computeroutput">negative_binomial_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_26_1_1_1_7-bb"></a><span class="identifier">negative_binomial_distribution</span><span class="special">(</span><span class="identifier">IntType</span> k <span class="special">=</span> <span class="number">1</span><span class="special">,</span> <span class="identifier">RealType</span> p <span class="special">=</span> <span class="number">0</span><span class="special">.</span><span class="number">5</span><span class="special">)</span><span class="special">;</span></pre> -<p>Construct a <code class="computeroutput"><code class="computeroutput"><a class="link" href="negati_1_3_34_5_6_26_1_1_1.html" title="Class template negative_binomial_distribution">negative_binomial_distribution</a></code></code> object. <code class="computeroutput">k</code> and <code class="computeroutput">p</code> are the parameters of the distribution.</p> -<p>Requires: k >=0 && 0 <= p <= 1 </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_34_5_6_26_1_1_1_8-bb"></a><span class="identifier">negative_binomial_distribution</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="negati_1_3_34_5_6_26_1_1_1/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="negati_1_3_34_5_6_26_1_1_1.html" title="Class template negative_binomial_distribution">negative_binomial_distribution</a></code></code> object from the parameters. </p> -</li> -</ol></div> -</div> -<div class="refsect2"> -<a name="id-1.3.34.5.6.25.3.4.6"></a><h3> -<a name="id-1_3_34_5_6_26_1_1_1_6-bb"></a><code class="computeroutput">negative_binomial_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_26_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 negative binomial 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_26_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="negati_1_3_34_5_6_26_1_1_1/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 negative binomial distribution with parameters specified by <code class="computeroutput">param</code>. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="identifier">IntType</span> <a name="id-1_3_34_5_6_26_1_1_1_6_3-bb"></a><span class="identifier">k</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Returns the <code class="computeroutput">k</code> parameter of the distribution. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="identifier">RealType</span> <a name="id-1_3_34_5_6_26_1_1_1_6_4-bb"></a><span class="identifier">p</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Returns the <code class="computeroutput">p</code> 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_26_1_1_1_6_5-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_26_1_1_1_6_6-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="negati_1_3_34_5_6_26_1_1_1/param_type.html" title="Class param_type">param_type</a> <a name="id-1_3_34_5_6_26_1_1_1_6_7-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_26_1_1_1_6_8-bb"></a><span class="identifier">param</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="negati_1_3_34_5_6_26_1_1_1/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_26_1_1_1_6_9-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.25.3.4.7"></a><h3> -<a name="id-1_3_34_5_6_26_1_1_1_9-bb"></a><code class="computeroutput">negative_binomial_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_26_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="negati_1_3_34_5_6_26_1_1_1.html" title="Class template negative_binomial_distribution">negative_binomial_distribution</a> <span class="special">&</span> bd<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_26_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="negati_1_3_34_5_6_26_1_1_1.html" title="Class template negative_binomial_distribution">negative_binomial_distribution</a> <span class="special">&</span> bd<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_26_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="negati_1_3_34_5_6_26_1_1_1.html" title="Class template negative_binomial_distribution">negative_binomial_distribution</a> <span class="special">&</span> lhs<span class="special">,</span> - <span class="keyword">const</span> <a class="link" href="negati_1_3_34_5_6_26_1_1_1.html" title="Class template negative_binomial_distribution">negative_binomial_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_26_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="negati_1_3_34_5_6_26_1_1_1.html" title="Class template negative_binomial_distribution">negative_binomial_distribution</a> <span class="special">&</span> lhs<span class="special">,</span> - <span class="keyword">const</span> <a class="link" href="negati_1_3_34_5_6_26_1_1_1.html" title="Class template negative_binomial_distribution">negative_binomial_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> -</ol></div> -</div> -</div> -</div> -<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> -<td align="left"></td> -<td align="right"><div class="copyright-footer">Copyright © 2000-2005 Jens Maurer<br>Copyright © 2009, 2010 Steven Watanabe<p> - Distributed under the Boost Software License, Version 1.0. (See accompanying - file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) - </p> -</div></td> -</tr></table> -<hr> -<div class="spirit-nav"> -<a accesskey="p" href="../../BOOST_RAND_1_3_34_5_6_25_2.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.negative_binomial_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="negati_1_3_34_5_6_26_1_1_1/param_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> -</div> -</body> -</html> |