• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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=UTF-8">
5<title>Class template geometric_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.geometric_distribution_hpp" title="Header &lt;boost/random/geometric_distribution.hpp&gt;">
10<link rel="prev" href="generate_canonical.html" title="Function template generate_canonical">
11<link rel="next" href="geometric_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="generate_canonical.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.geometric_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="geometric_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.geometric_distribution"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Class template geometric_distribution</span></h2>
30<p>boost::random::geometric_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.geometric_distribution_hpp" title="Header &lt;boost/random/geometric_distribution.hpp&gt;">boost/random/geometric_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="geometric_distribution.html" title="Class template geometric_distribution">geometric_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">RealType</span> <a name="boost.random.geometric_distribution.input_type"></a><span class="identifier">input_type</span><span class="special">;</span>
40  <span class="keyword">typedef</span> <span class="identifier">IntType</span>  <a name="boost.random.geometric_distribution.result_type"></a><span class="identifier">result_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="geometric_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="geometric_distribution.html" title="Class template geometric_distribution">geometric_distribution</a> <a class="link" href="geometric_distribution/param_type.html#boost.random.geometric_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="geometric_distribution/param_type.html#boost.random.geometric_distribution.param_typeconstruct-copy-destruct">construct/copy/destruct</a></span>
50    <span class="keyword">explicit</span> <a class="link" href="geometric_distribution/param_type.html#id-1_3_34_5_6_17_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">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="geometric_distribution/param_type.html#id-1_3_34_5_6_17_1_1_1_3_2-bb">public member functions</a></span>
53    <span class="identifier">RealType</span> <a class="link" href="geometric_distribution/param_type.html#id-1_3_34_5_6_17_1_1_1_3_2_1-bb"><span class="identifier">p</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
54
55    <span class="comment">// <a class="link" href="geometric_distribution/param_type.html#id-1_3_34_5_6_17_1_1_1_3_4-bb">friend functions</a></span>
56    <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>
57      <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>
58      <a class="link" href="geometric_distribution/param_type.html#id-1_3_34_5_6_17_1_1_1_3_4_1-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="geometric_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
59    <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>
60      <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>
61      <a class="link" href="geometric_distribution/param_type.html#id-1_3_34_5_6_17_1_1_1_3_4_2-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> <span class="keyword">const</span> <a class="link" href="geometric_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
62    <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="geometric_distribution/param_type.html#id-1_3_34_5_6_17_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="geometric_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="geometric_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="geometric_distribution/param_type.html#id-1_3_34_5_6_17_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="geometric_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="geometric_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="special">}</span><span class="special">;</span>
65
66  <span class="comment">// <a class="link" href="geometric_distribution.html#boost.random.geometric_distributionconstruct-copy-destruct">construct/copy/destruct</a></span>
67  <span class="keyword">explicit</span> <a class="link" href="geometric_distribution.html#id-1_3_34_5_6_17_1_1_1_7-bb"><span class="identifier">geometric_distribution</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</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>
68  <span class="keyword">explicit</span> <a class="link" href="geometric_distribution.html#id-1_3_34_5_6_17_1_1_1_8-bb"><span class="identifier">geometric_distribution</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="geometric_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
69
70  <span class="comment">// <a class="link" href="geometric_distribution.html#id-1_3_34_5_6_17_1_1_1_6-bb">public member functions</a></span>
71  <span class="identifier">RealType</span> <a class="link" href="geometric_distribution.html#id-1_3_34_5_6_17_1_1_1_6_1-bb"><span class="identifier">p</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
72  <span class="identifier">IntType</span> <a class="link" href="geometric_distribution.html#id-1_3_34_5_6_17_1_1_1_6_2-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
73  <span class="identifier">IntType</span> <a class="link" href="geometric_distribution.html#id-1_3_34_5_6_17_1_1_1_6_3-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
74  <a class="link" href="geometric_distribution/param_type.html" title="Class param_type">param_type</a> <a class="link" href="geometric_distribution.html#id-1_3_34_5_6_17_1_1_1_6_4-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
75  <span class="keyword">void</span> <a class="link" href="geometric_distribution.html#id-1_3_34_5_6_17_1_1_1_6_5-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="geometric_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
76  <span class="keyword">void</span> <a class="link" href="geometric_distribution.html#id-1_3_34_5_6_17_1_1_1_6_6-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
77  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Engine<span class="special">&gt;</span> <span class="identifier">result_type</span> <a class="link" href="geometric_distribution.html#id-1_3_34_5_6_17_1_1_1_6_7-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Engine</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
78  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Engine<span class="special">&gt;</span>
79    <span class="identifier">result_type</span> <a class="link" href="geometric_distribution.html#id-1_3_34_5_6_17_1_1_1_6_8-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">Engine</span> <span class="special">&amp;</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="geometric_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>
80
81  <span class="comment">// <a class="link" href="geometric_distribution.html#id-1_3_34_5_6_17_1_1_1_9-bb">friend functions</a></span>
82  <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>
83    <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>
84    <a class="link" href="geometric_distribution.html#id-1_3_34_5_6_17_1_1_1_9_1-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>
85               <span class="keyword">const</span> <a class="link" href="geometric_distribution.html" title="Class template geometric_distribution">geometric_distribution</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
86  <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>
87    <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>
88    <a class="link" href="geometric_distribution.html#id-1_3_34_5_6_17_1_1_1_9_2-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>
89               <span class="keyword">const</span> <a class="link" href="geometric_distribution.html" title="Class template geometric_distribution">geometric_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="geometric_distribution.html#id-1_3_34_5_6_17_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="geometric_distribution.html" title="Class template geometric_distribution">geometric_distribution</a> <span class="special">&amp;</span><span class="special">,</span>
91                         <span class="keyword">const</span> <a class="link" href="geometric_distribution.html" title="Class template geometric_distribution">geometric_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="geometric_distribution.html#id-1_3_34_5_6_17_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="geometric_distribution.html" title="Class template geometric_distribution">geometric_distribution</a> <span class="special">&amp;</span><span class="special">,</span>
93                         <span class="keyword">const</span> <a class="link" href="geometric_distribution.html" title="Class template geometric_distribution">geometric_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="id-1.3.34.5.6.16.3.4"></a><h2>Description</h2>
97<p>An instantiation of the class template <code class="computeroutput"><a class="link" href="geometric_distribution.html" title="Class template geometric_distribution">geometric_distribution</a></code> models a <a class="link" href="../../boost_random/reference.html#boost_random.reference.concepts.random_distribution" title="Random Distribution">random distribution</a> . The distribution produces positive integers which are the number of bernoulli trials with probability <code class="computeroutput">p</code> required to get one that fails.</p>
98<p>For the geometric distribution, <span class="inlinemediaobject"><img src="../../images/random//form_14.png"></span>.</p>
99<p> </p>
100<div class="warning"><table border="0" summary="Warning">
101<tr>
102<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../doc/src/images/warning.png"></td>
103<th align="left">Warning</th>
104</tr>
105<tr><td align="left" valign="top"><p>  This distribution has been updated to match the C++ standard. Its behavior has changed from the original boost::geometric_distribution. A backwards compatible wrapper is provided in namespace boost.  </p></td></tr>
106</table></div>
107<p>  </p>
108<div class="refsect2">
109<a name="id-1.3.34.5.6.16.3.4.5"></a><h3>
110<a name="boost.random.geometric_distributionconstruct-copy-destruct"></a><code class="computeroutput">geometric_distribution</code>
111        public
112       construct/copy/destruct</h3>
113<div class="orderedlist"><ol class="orderedlist" type="1">
114<li class="listitem">
115<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_34_5_6_17_1_1_1_7-bb"></a><span class="identifier">geometric_distribution</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">RealType</span> <span class="special">&amp;</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>
116<p>Contructs a new <code class="computeroutput"><a class="link" href="geometric_distribution.html" title="Class template geometric_distribution">geometric_distribution</a></code> with the paramter <code class="computeroutput">p</code>.</p>
117<p>Requires: 0 &lt; p &lt; 1 </p>
118</li>
119<li class="listitem">
120<pre class="literallayout"><span class="keyword">explicit</span> <a name="id-1_3_34_5_6_17_1_1_1_8-bb"></a><span class="identifier">geometric_distribution</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="geometric_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>
121<p>Constructs a new <code class="computeroutput"><a class="link" href="geometric_distribution.html" title="Class template geometric_distribution">geometric_distribution</a></code> from its parameters. </p>
122</li>
123</ol></div>
124</div>
125<div class="refsect2">
126<a name="id-1.3.34.5.6.16.3.4.6"></a><h3>
127<a name="id-1_3_34_5_6_17_1_1_1_6-bb"></a><code class="computeroutput">geometric_distribution</code> public member functions</h3>
128<div class="orderedlist"><ol class="orderedlist" type="1">
129<li class="listitem">
130<pre class="literallayout"><span class="identifier">RealType</span> <a name="id-1_3_34_5_6_17_1_1_1_6_1-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>
131<p>Returns: the distribution parameter <code class="computeroutput">p</code> </p>
132</li>
133<li class="listitem">
134<pre class="literallayout"><span class="identifier">IntType</span> <a name="id-1_3_34_5_6_17_1_1_1_6_2-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>
135<p>Returns the smallest value that the distribution can produce. </p>
136</li>
137<li class="listitem">
138<pre class="literallayout"><span class="identifier">IntType</span> <a name="id-1_3_34_5_6_17_1_1_1_6_3-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>
139<p>Returns the largest value that the distribution can produce. </p>
140</li>
141<li class="listitem">
142<pre class="literallayout"><a class="link" href="geometric_distribution/param_type.html" title="Class param_type">param_type</a> <a name="id-1_3_34_5_6_17_1_1_1_6_4-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>
143<p>Returns the parameters of the distribution. </p>
144</li>
145<li class="listitem">
146<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_17_1_1_1_6_5-bb"></a><span class="identifier">param</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="geometric_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>
147<p>Sets the parameters of the distribution. </p>
148</li>
149<li class="listitem">
150<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_17_1_1_1_6_6-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
151<p>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </p>
152</li>
153<li class="listitem">
154<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Engine<span class="special">&gt;</span> <span class="identifier">result_type</span> <a name="id-1_3_34_5_6_17_1_1_1_6_7-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Engine</span> <span class="special">&amp;</span> eng<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
155<p>Returns a random variate distributed according to the <code class="computeroutput"><a class="link" href="geometric_distribution.html" title="Class template geometric_distribution">geometric_distribution</a></code>. </p>
156</li>
157<li class="listitem">
158<pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Engine<span class="special">&gt;</span>
159  <span class="identifier">result_type</span> <a name="id-1_3_34_5_6_17_1_1_1_6_8-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">Engine</span> <span class="special">&amp;</span> eng<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="geometric_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>
160<p>Returns a random variate distributed according to the geometric distribution with parameters specified by param. </p>
161</li>
162</ol></div>
163</div>
164<div class="refsect2">
165<a name="id-1.3.34.5.6.16.3.4.7"></a><h3>
166<a name="id-1_3_34_5_6_17_1_1_1_9-bb"></a><code class="computeroutput">geometric_distribution</code> friend functions</h3>
167<div class="orderedlist"><ol class="orderedlist" type="1">
168<li class="listitem">
169<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>
170  <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>
171  <a name="id-1_3_34_5_6_17_1_1_1_9_1-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>
172             <span class="keyword">const</span> <a class="link" href="geometric_distribution.html" title="Class template geometric_distribution">geometric_distribution</a> <span class="special">&amp;</span> gd<span class="special">)</span><span class="special">;</span></pre>
173<p>Writes the distribution to a <code class="computeroutput">std::ostream</code>. </p>
174</li>
175<li class="listitem">
176<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>
177  <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>
178  <a name="id-1_3_34_5_6_17_1_1_1_9_2-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>
179             <span class="keyword">const</span> <a class="link" href="geometric_distribution.html" title="Class template geometric_distribution">geometric_distribution</a> <span class="special">&amp;</span> gd<span class="special">)</span><span class="special">;</span></pre>
180<p>Reads the distribution from a <code class="computeroutput">std::istream</code>. </p>
181</li>
182<li class="listitem">
183<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_17_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="geometric_distribution.html" title="Class template geometric_distribution">geometric_distribution</a> <span class="special">&amp;</span> lhs<span class="special">,</span>
184                       <span class="keyword">const</span> <a class="link" href="geometric_distribution.html" title="Class template geometric_distribution">geometric_distribution</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
185<p>Returns true if the two distributions will produce identical sequences of values given equal generators. </p>
186</li>
187<li class="listitem">
188<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_17_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="geometric_distribution.html" title="Class template geometric_distribution">geometric_distribution</a> <span class="special">&amp;</span> lhs<span class="special">,</span>
189                       <span class="keyword">const</span> <a class="link" href="geometric_distribution.html" title="Class template geometric_distribution">geometric_distribution</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
190<p>Returns true if the two distributions may produce different sequences of values given equal generators. </p>
191</li>
192</ol></div>
193</div>
194</div>
195</div>
196<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
197<td align="left"></td>
198<td align="right"><div class="copyright-footer">Copyright © 2000-2005 Jens Maurer<br>Copyright © 2009, 2010 Steven Watanabe<p>
199        Distributed under the Boost Software License, Version 1.0. (See accompanying
200        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>)
201      </p>
202</div></td>
203</tr></table>
204<hr>
205<div class="spirit-nav">
206<a accesskey="p" href="generate_canonical.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.geometric_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="geometric_distribution/param_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
207</div>
208</body>
209</html>
210