doc/html/boost/random/binomial_distribution.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Class template binomial_distribution</title>
   6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../../boost_random/reference.html#header.boost.random.binomial_distribution_hpp" title="Header &lt;boost/random/binomial_distribution.hpp&gt;">
  10 <link rel="prev" href="beta_distribution/param_type.html" title="Class param_type">
  11 <link rel="next" href="binomial_distribution/param_type.html" title="Class param_type">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="beta_distribution/param_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.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="binomial_distribution/param_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.random.binomial_distribution"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class template binomial_distribution</span></h2>
  30 <p>boost::random::binomial_distribution</p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_random/reference.html#header.boost.random.binomial_distribution_hpp" title="Header &lt;boost/random/binomial_distribution.hpp&gt;">boost/random/binomial_distribution.hpp</a>&gt;
  34
  35 </span><span class="keyword">template</span><span class="special">&lt;</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">&gt;</span>
  36 <span class="keyword">class</span> <a class="link" href="binomial_distribution.html" title="Class template binomial_distribution">binomial_distribution</a> <span class="special">{</span>
  37 <span class="keyword">public</span><span class="special">:</span>
  38   <span class="comment">// types</span>
  39   <span class="keyword">typedef</span> <span class="identifier">IntType</span>  <a name="boost.random.binomial_distribution.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">RealType</span> <a name="boost.random.binomial_distribution.input_type"></a><span class="identifier">input_type</span><span class="special">;</span>
  41
  42   <span class="comment">// member classes/structs/unions</span>
  43
  44   <span class="keyword">class</span> <a class="link" href="binomial_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">{</span>
  45   <span class="keyword">public</span><span class="special">:</span>
  46     <span class="comment">// types</span>
  47     <span class="keyword">typedef</span> <a class="link" href="binomial_distribution.html" title="Class template binomial_distribution">binomial_distribution</a> <a class="link" href="binomial_distribution/param_type.html#boost.random.binomial_distribution.param_type.distribution_type"><span class="identifier">distribution_type</span></a><span class="special">;</span>
  48
  49     <span class="comment">// <a class="link" href="binomial_distribution/param_type.html#boost.random.binomial_distribution.param_typeconstruct-copy-destruct">construct/copy/destruct</a></span>
  50     <span class="keyword">explicit</span> <a class="link" href="binomial_distribution/param_type.html#idp708290576-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>
  51
  52     <span class="comment">// <a class="link" href="binomial_distribution/param_type.html#idp708285856-bb">public member functions</a></span>
  53     <span class="identifier">IntType</span> <a class="link" href="binomial_distribution/param_type.html#idp708286416-bb"><span class="identifier">t</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  54     <span class="identifier">RealType</span> <a class="link" href="binomial_distribution/param_type.html#idp708288416-bb"><span class="identifier">p</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  55
  56     <span class="comment">// <a class="link" href="binomial_distribution/param_type.html#idp708295488-bb">friend functions</a></span>
  57     <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span>
  58       <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
  59       <a class="link" href="binomial_distribution/param_type.html#idp708296048-bb"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="binomial_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  60     <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span>
  61       <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
  62       <a class="link" href="binomial_distribution/param_type.html#idp708301072-bb"><span class="keyword">operator</span><span class="special">&gt;&gt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <a class="link" href="binomial_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  63     <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="binomial_distribution/param_type.html#idp708305936-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binomial_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="binomial_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  64     <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="binomial_distribution/param_type.html#idp708309504-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binomial_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="binomial_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  65   <span class="special">}</span><span class="special">;</span>
  66
  67   <span class="comment">// <a class="link" href="binomial_distribution.html#boost.random.binomial_distributionconstruct-copy-destruct">construct/copy/destruct</a></span>
  68   <span class="keyword">explicit</span> <a class="link" href="binomial_distribution.html#idp708336176-bb"><span class="identifier">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>
  69   <span class="keyword">explicit</span> <a class="link" href="binomial_distribution.html#idp708341200-bb"><span class="identifier">binomial_distribution</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binomial_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  70
  71   <span class="comment">// <a class="link" href="binomial_distribution.html#idp708314928-bb">public member functions</a></span>
  72   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> URNG<span class="special">&gt;</span> <span class="identifier">IntType</span> <a class="link" href="binomial_distribution.html#idp708315488-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">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  73   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> URNG<span class="special">&gt;</span> <span class="identifier">IntType</span> <a class="link" href="binomial_distribution.html#idp708318624-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">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="binomial_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  74   <span class="identifier">IntType</span> <a class="link" href="binomial_distribution.html#idp708323376-bb"><span class="identifier">t</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  75   <span class="identifier">RealType</span> <a class="link" href="binomial_distribution.html#idp708325376-bb"><span class="identifier">p</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  76   <span class="identifier">IntType</span> <a class="link" href="binomial_distribution.html#idp708327376-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  77   <span class="identifier">IntType</span> <a class="link" href="binomial_distribution.html#idp708328960-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  78   <a class="link" href="binomial_distribution/param_type.html" title="Class param_type">param_type</a> <a class="link" href="binomial_distribution.html#idp708330544-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  79   <span class="keyword">void</span> <a class="link" href="binomial_distribution.html#idp708332240-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binomial_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  80   <span class="keyword">void</span> <a class="link" href="binomial_distribution.html#idp708334656-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  81
  82   <span class="comment">// <a class="link" href="binomial_distribution.html#idp708344192-bb">friend functions</a></span>
  83   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span>
  84     <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
  85     <a class="link" href="binomial_distribution.html#idp708344752-bb"><span class="keyword">operator</span><span class="special">&lt;&lt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span>
  86                <span class="keyword">const</span> <a class="link" href="binomial_distribution.html" title="Class template binomial_distribution">binomial_distribution</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  87   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span>
  88     <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
  89     <a class="link" href="binomial_distribution.html#idp708349776-bb"><span class="keyword">operator</span><span class="special">&gt;&gt;</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">,</span> <a class="link" href="binomial_distribution.html" title="Class template binomial_distribution">binomial_distribution</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  90   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="binomial_distribution.html#idp708354640-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binomial_distribution.html" title="Class template binomial_distribution">binomial_distribution</a> <span class="special">&amp;</span><span class="special">,</span>
  91                          <span class="keyword">const</span> <a class="link" href="binomial_distribution.html" title="Class template binomial_distribution">binomial_distribution</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  92   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="binomial_distribution.html#idp708358272-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binomial_distribution.html" title="Class template binomial_distribution">binomial_distribution</a> <span class="special">&amp;</span><span class="special">,</span>
  93                          <span class="keyword">const</span> <a class="link" href="binomial_distribution.html" title="Class template binomial_distribution">binomial_distribution</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  94 <span class="special">}</span><span class="special">;</span></pre></div>
  95 <div class="refsect1">
  96 <a name="idp490040720"></a><h2>Description</h2>
  97 <p>The binomial distribution is an integer valued distribution with two parameters, <code class="computeroutput">t</code> and <code class="computeroutput">p</code>. The values of the distribution are within the range [0,t].</p>
  98 <p>The distribution function is <span class="inlinemediaobject"><img src="../../images/random//form_1.png"></span>.</p>
  99 <p>The algorithm used is the BTRD algorithm described in</p>
 100 <p> </p>
 101 <div class="blockquote"><blockquote class="blockquote"><p>  "The generation of binomial random variates", Wolfgang Hormann, Journal of Statistical Computation and Simulation, Volume 46, Issue 1 &amp; 2 April 1993 , pages 101 - 110  </p></blockquote></div>
 102 <p>  </p>
 103 <div class="refsect2">
 104 <a name="idp490046992"></a><h3>
 105 <a name="boost.random.binomial_distributionconstruct-copy-destruct"></a><code class="computeroutput">binomial_distribution</code>
 106         public
 107        construct/copy/destruct</h3>
 108 <div class="orderedlist"><ol class="orderedlist" type="1">
 109 <li class="listitem">
 110 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp708336176-bb"></a><span class="identifier">binomial_distribution</span><span class="special">(</span><span class="identifier">IntType</span> t <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>
 111 <p>Construct a <code class="computeroutput"><code class="computeroutput"><a class="link" href="binomial_distribution.html" title="Class template binomial_distribution">binomial_distribution</a></code></code> object. <code class="computeroutput">t</code> and <code class="computeroutput">p</code> are the parameters of the distribution.</p>
 112 <p>Requires: t &gt;=0 &amp;&amp; 0 &lt;= p &lt;= 1 </p>
 113 </li>
 114 <li class="listitem">
 115 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp708341200-bb"></a><span class="identifier">binomial_distribution</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binomial_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span> param<span class="special">)</span><span class="special">;</span></pre>
 116 <p>Construct an <code class="computeroutput"><code class="computeroutput"><a class="link" href="binomial_distribution.html" title="Class template binomial_distribution">binomial_distribution</a></code></code> object from the parameters. </p>
 117 </li>
 118 </ol></div>
 119 </div>
 120 <div class="refsect2">
 121 <a name="idp490071488"></a><h3>
 122 <a name="idp708314928-bb"></a><code class="computeroutput">binomial_distribution</code> public member functions</h3>
 123 <div class="orderedlist"><ol class="orderedlist" type="1">
 124 <li class="listitem">
 125 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> URNG<span class="special">&gt;</span> <span class="identifier">IntType</span> <a name="idp708315488-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">&amp;</span> urng<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 126 <p>Returns a random variate distributed according to the binomial distribution. </p>
 127 </li>
 128 <li class="listitem">
 129 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> URNG<span class="special">&gt;</span>
 130   <span class="identifier">IntType</span> <a name="idp708318624-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">&amp;</span> urng<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="binomial_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span> param<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 131 <p>Returns a random variate distributed according to the binomial distribution with parameters specified by <code class="computeroutput">param</code>. </p>
 132 </li>
 133 <li class="listitem">
 134 <pre class="literallayout"><span class="identifier">IntType</span> <a name="idp708323376-bb"></a><span class="identifier">t</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 135 <p>Returns the <code class="computeroutput">t</code> parameter of the distribution. </p>
 136 </li>
 137 <li class="listitem">
 138 <pre class="literallayout"><span class="identifier">RealType</span> <a name="idp708325376-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>
 139 <p>Returns the <code class="computeroutput">p</code> parameter of the distribution. </p>
 140 </li>
 141 <li class="listitem">
 142 <pre class="literallayout"><span class="identifier">IntType</span> <a name="idp708327376-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>
 143 <p>Returns the smallest value that the distribution can produce. </p>
 144 </li>
 145 <li class="listitem">
 146 <pre class="literallayout"><span class="identifier">IntType</span> <a name="idp708328960-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>
 147 <p>Returns the largest value that the distribution can produce. </p>
 148 </li>
 149 <li class="listitem">
 150 <pre class="literallayout"><a class="link" href="binomial_distribution/param_type.html" title="Class param_type">param_type</a> <a name="idp708330544-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>
 151 <p>Returns the parameters of the distribution. </p>
 152 </li>
 153 <li class="listitem">
 154 <pre class="literallayout"><span class="keyword">void</span> <a name="idp708332240-bb"></a><span class="identifier">param</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binomial_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span> param<span class="special">)</span><span class="special">;</span></pre>
 155 <p>Sets parameters of the distribution. </p>
 156 </li>
 157 <li class="listitem">
 158 <pre class="literallayout"><span class="keyword">void</span> <a name="idp708334656-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 159 <p>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </p>
 160 </li>
 161 </ol></div>
 162 </div>
 163 <div class="refsect2">
 164 <a name="idp490137328"></a><h3>
 165 <a name="idp708344192-bb"></a><code class="computeroutput">binomial_distribution</code> friend functions</h3>
 166 <div class="orderedlist"><ol class="orderedlist" type="1">
 167 <li class="listitem">
 168 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span>
 169   <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
 170   <a name="idp708344752-bb"></a><span class="keyword">operator</span><span class="special">&lt;&lt;</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> os<span class="special">,</span>
 171              <span class="keyword">const</span> <a class="link" href="binomial_distribution.html" title="Class template binomial_distribution">binomial_distribution</a> <span class="special">&amp;</span> bd<span class="special">)</span><span class="special">;</span></pre>
 172 <p>Writes the parameters of the distribution to a <code class="computeroutput">std::ostream</code>. </p>
 173 </li>
 174 <li class="listitem">
 175 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">&gt;</span>
 176   <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span>
 177   <a name="idp708349776-bb"></a><span class="keyword">operator</span><span class="special">&gt;&gt;</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">&gt;</span> <span class="special">&amp;</span> is<span class="special">,</span>
 178              <a class="link" href="binomial_distribution.html" title="Class template binomial_distribution">binomial_distribution</a> <span class="special">&amp;</span> bd<span class="special">)</span><span class="special">;</span></pre>
 179 <p>Reads the parameters of the distribution from a <code class="computeroutput">std::istream</code>. </p>
 180 </li>
 181 <li class="listitem">
 182 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp708354640-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binomial_distribution.html" title="Class template binomial_distribution">binomial_distribution</a> <span class="special">&amp;</span> lhs<span class="special">,</span>
 183                        <span class="keyword">const</span> <a class="link" href="binomial_distribution.html" title="Class template binomial_distribution">binomial_distribution</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 184 <p>Returns true if the two distributions will produce the same sequence of values, given equal generators. </p>
 185 </li>
 186 <li class="listitem">
 187 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp708358272-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="binomial_distribution.html" title="Class template binomial_distribution">binomial_distribution</a> <span class="special">&amp;</span> lhs<span class="special">,</span>
 188                        <span class="keyword">const</span> <a class="link" href="binomial_distribution.html" title="Class template binomial_distribution">binomial_distribution</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 189 <p>Returns true if the two distributions could produce different sequences of values, given equal generators. </p>
 190 </li>
 191 </ol></div>
 192 </div>
 193 </div>
 194 </div>
 195 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 196 <td align="left"></td>
 197 <td align="right"><div class="copyright-footer">Copyright &#169; 2000-2005 Jens Maurer<br>Copyright &#169; 2009, 2010 Steven Watanabe<p>
 198         Distributed under the Boost Software License, Version 1.0. (See accompanying
 199         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>)
 200       </p>
 201 </div></td>
 202 </tr></table>
 203 <hr>
 204 <div class="spirit-nav">
 205 <a accesskey="p" href="beta_distribution/param_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.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="binomial_distribution/param_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 206 </div>
 207 </body>
 208 </html>