<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libstdc++: std::geometric_distribution< _IntType > Class Template Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(initResizable); /* @license-end */</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">libstdc++ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function(){initNavTree('a06380.html','');}); /* @license-end */ </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="#friends">Friends</a> | <a href="a06377.html">List of all members</a> </div> <div class="headertitle"> <div class="title">std::geometric_distribution< _IntType > Class Template Reference<div class="ingroups"><a class="el" href="a01473.html">Numerics</a> » <a class="el" href="a01491.html">Random Number Generation</a> » <a class="el" href="a01532.html">Random Number Distributions</a> » <a class="el" href="a01535.html">Bernoulli Distributions</a></div></div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a06384.html">param_type</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:a3853f646d5644e294b44ccbfc8ec34b1"><td class="memItemLeft" align="right" valign="top">typedef _IntType </td><td class="memItemRight" valign="bottom"><a class="el" href="a06380.html#a3853f646d5644e294b44ccbfc8ec34b1">result_type</a></td></tr> <tr class="separator:a3853f646d5644e294b44ccbfc8ec34b1"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:ae12e09c7f6eacf7a22da53553c4de37e"><td class="memItemLeft" align="right" valign="top"><a id="ae12e09c7f6eacf7a22da53553c4de37e"></a>  </td><td class="memItemRight" valign="bottom"><b>geometric_distribution</b> (double __p=0.5)</td></tr> <tr class="separator:ae12e09c7f6eacf7a22da53553c4de37e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a94dd986cf6f05f6eb1f4a6cb9b61577f"><td class="memItemLeft" align="right" valign="top"><a id="a94dd986cf6f05f6eb1f4a6cb9b61577f"></a>  </td><td class="memItemRight" valign="bottom"><b>geometric_distribution</b> (const <a class="el" href="a06384.html">param_type</a> &__p)</td></tr> <tr class="separator:a94dd986cf6f05f6eb1f4a6cb9b61577f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1598231b677c0cffc218e223e16ba64d"><td class="memTemplParams" colspan="2"><a id="a1598231b677c0cffc218e223e16ba64d"></a> template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > </td></tr> <tr class="memitem:a1598231b677c0cffc218e223e16ba64d"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>__generate</b> (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng)</td></tr> <tr class="separator:a1598231b677c0cffc218e223e16ba64d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6d672ae319f11a3b9f74d60a570e5893"><td class="memTemplParams" colspan="2"><a id="a6d672ae319f11a3b9f74d60a570e5893"></a> template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > </td></tr> <tr class="memitem:a6d672ae319f11a3b9f74d60a570e5893"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>__generate</b> (_ForwardIterator __f, _ForwardIterator __t, _UniformRandomNumberGenerator &__urng, const <a class="el" href="a06384.html">param_type</a> &__p)</td></tr> <tr class="separator:a6d672ae319f11a3b9f74d60a570e5893"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4390a8b4c55e4250780e0d781255cfd5"><td class="memTemplParams" colspan="2"><a id="a4390a8b4c55e4250780e0d781255cfd5"></a> template<typename _UniformRandomNumberGenerator > </td></tr> <tr class="memitem:a4390a8b4c55e4250780e0d781255cfd5"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>__generate</b> (<a class="el" href="a06380.html#a3853f646d5644e294b44ccbfc8ec34b1">result_type</a> *__f, <a class="el" href="a06380.html#a3853f646d5644e294b44ccbfc8ec34b1">result_type</a> *__t, _UniformRandomNumberGenerator &__urng, const <a class="el" href="a06384.html">param_type</a> &__p)</td></tr> <tr class="separator:a4390a8b4c55e4250780e0d781255cfd5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a537ddec1681bac5e12dd0aab79983072"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a06380.html#a3853f646d5644e294b44ccbfc8ec34b1">result_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a06380.html#a537ddec1681bac5e12dd0aab79983072">max</a> () const</td></tr> <tr class="separator:a537ddec1681bac5e12dd0aab79983072"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af711039331910d5b184bfcdb43e4e12b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a06380.html#a3853f646d5644e294b44ccbfc8ec34b1">result_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a06380.html#af711039331910d5b184bfcdb43e4e12b">min</a> () const</td></tr> <tr class="separator:af711039331910d5b184bfcdb43e4e12b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4a41c317cae02db9d8cc20dbbcd4d77d"><td class="memTemplParams" colspan="2">template<typename _UniformRandomNumberGenerator > </td></tr> <tr class="memitem:a4a41c317cae02db9d8cc20dbbcd4d77d"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="a06380.html#a3853f646d5644e294b44ccbfc8ec34b1">result_type</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a06380.html#a4a41c317cae02db9d8cc20dbbcd4d77d">operator()</a> (_UniformRandomNumberGenerator &__urng)</td></tr> <tr class="separator:a4a41c317cae02db9d8cc20dbbcd4d77d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac4d5a794fb5063c085dae12d23a246d9"><td class="memTemplParams" colspan="2"><a id="ac4d5a794fb5063c085dae12d23a246d9"></a> template<typename _UniformRandomNumberGenerator > </td></tr> <tr class="memitem:ac4d5a794fb5063c085dae12d23a246d9"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="a06380.html#a3853f646d5644e294b44ccbfc8ec34b1">result_type</a> </td><td class="memTemplItemRight" valign="bottom"><b>operator()</b> (_UniformRandomNumberGenerator &__urng, const <a class="el" href="a06384.html">param_type</a> &__p)</td></tr> <tr class="separator:ac4d5a794fb5063c085dae12d23a246d9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3f50a0fa0b370466364b3928394c5fe3"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a06380.html#a3f50a0fa0b370466364b3928394c5fe3">p</a> () const</td></tr> <tr class="separator:a3f50a0fa0b370466364b3928394c5fe3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a690e55bc0b6fe8c78d4e46a08197e70b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a06384.html">param_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a06380.html#a690e55bc0b6fe8c78d4e46a08197e70b">param</a> () const</td></tr> <tr class="separator:a690e55bc0b6fe8c78d4e46a08197e70b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a75d3adb67d1d8a8d9ec152ed6076a009"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a06380.html#a75d3adb67d1d8a8d9ec152ed6076a009">param</a> (const <a class="el" href="a06384.html">param_type</a> &__param)</td></tr> <tr class="separator:a75d3adb67d1d8a8d9ec152ed6076a009"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad170e9c049fc1d5df02da5097eda29df"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a06380.html#ad170e9c049fc1d5df02da5097eda29df">reset</a> ()</td></tr> <tr class="separator:ad170e9c049fc1d5df02da5097eda29df"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> Friends</h2></td></tr> <tr class="memitem:a63cafb50acfe1b10c4a26cd6c990bc3f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a06380.html#a63cafb50acfe1b10c4a26cd6c990bc3f">operator==</a> (const <a class="el" href="a06380.html">geometric_distribution</a> &__d1, const <a class="el" href="a06380.html">geometric_distribution</a> &__d2)</td></tr> <tr class="separator:a63cafb50acfe1b10c4a26cd6c990bc3f"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><h3>template<typename _IntType = int><br /> class std::geometric_distribution< _IntType ></h3> <p>A discrete geometric random number distribution. </p> <p>The formula for the geometric probability density function is <img class="formulaInl" alt="$p(i|p) = p(1 - p)^{i}$" src="form_16.png"/> where <img class="formulaInl" alt="$p$" src="form_12.png"/> is the parameter of the distribution. </p> <p class="definition">Definition at line <a class="el" href="a00452_source.html#l03898">3898</a> of file <a class="el" href="a00452_source.html">random.h</a>.</p> </div><h2 class="groupheader">Member Typedef Documentation</h2> <a id="a3853f646d5644e294b44ccbfc8ec34b1"></a> <h2 class="memtitle"><span class="permalink"><a href="#a3853f646d5644e294b44ccbfc8ec34b1">◆ </a></span>result_type</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _IntType = int> </div> <table class="memname"> <tr> <td class="memname">typedef _IntType <a class="el" href="a06380.html">std::geometric_distribution</a>< _IntType >::<a class="el" href="a06380.html#a3853f646d5644e294b44ccbfc8ec34b1">result_type</a></td> </tr> </table> </div><div class="memdoc"> <p>The type of the range of the distribution. </p> <p class="definition">Definition at line <a class="el" href="a00452_source.html#l03901">3901</a> of file <a class="el" href="a00452_source.html">random.h</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="a537ddec1681bac5e12dd0aab79983072"></a> <h2 class="memtitle"><span class="permalink"><a href="#a537ddec1681bac5e12dd0aab79983072">◆ </a></span>max()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _IntType = int> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a06380.html#a3853f646d5644e294b44ccbfc8ec34b1">result_type</a> <a class="el" href="a06380.html">std::geometric_distribution</a>< _IntType >::max </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the least upper bound value of the distribution. </p> <p class="definition">Definition at line <a class="el" href="a00452_source.html#l03995">3995</a> of file <a class="el" href="a00452_source.html">random.h</a>.</p> <p class="reference">References <a class="el" href="a00095_source.html#l00321">std::numeric_limits< _Tp >::max()</a>.</p> </div> </div> <a id="af711039331910d5b184bfcdb43e4e12b"></a> <h2 class="memtitle"><span class="permalink"><a href="#af711039331910d5b184bfcdb43e4e12b">◆ </a></span>min()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _IntType = int> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a06380.html#a3853f646d5644e294b44ccbfc8ec34b1">result_type</a> <a class="el" href="a06380.html">std::geometric_distribution</a>< _IntType >::min </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the greatest lower bound value of the distribution. </p> <p class="definition">Definition at line <a class="el" href="a00452_source.html#l03988">3988</a> of file <a class="el" href="a00452_source.html">random.h</a>.</p> </div> </div> <a id="a4a41c317cae02db9d8cc20dbbcd4d77d"></a> <h2 class="memtitle"><span class="permalink"><a href="#a4a41c317cae02db9d8cc20dbbcd4d77d">◆ </a></span>operator()()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _IntType = int> </div> <div class="memtemplate"> template<typename _UniformRandomNumberGenerator > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a06380.html#a3853f646d5644e294b44ccbfc8ec34b1">result_type</a> <a class="el" href="a06380.html">std::geometric_distribution</a>< _IntType >::operator() </td> <td>(</td> <td class="paramtype">_UniformRandomNumberGenerator & </td> <td class="paramname"><em>__urng</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Generating functions. </p> <p class="definition">Definition at line <a class="el" href="a00452_source.html#l04003">4003</a> of file <a class="el" href="a00452_source.html">random.h</a>.</p> </div> </div> <a id="a3f50a0fa0b370466364b3928394c5fe3"></a> <h2 class="memtitle"><span class="permalink"><a href="#a3f50a0fa0b370466364b3928394c5fe3">◆ </a></span>p()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _IntType = int> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">double <a class="el" href="a06380.html">std::geometric_distribution</a>< _IntType >::p </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the distribution parameter <code>p</code>. </p> <p class="definition">Definition at line <a class="el" href="a00452_source.html#l03966">3966</a> of file <a class="el" href="a00452_source.html">random.h</a>.</p> <p class="reference">Referenced by <a class="el" href="a17055_source.html#l01077">std::operator<<()</a>.</p> </div> </div> <a id="a690e55bc0b6fe8c78d4e46a08197e70b"></a> <h2 class="memtitle"><span class="permalink"><a href="#a690e55bc0b6fe8c78d4e46a08197e70b">◆ </a></span>param() <span class="overload">[1/2]</span></h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _IntType = int> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a06384.html">param_type</a> <a class="el" href="a06380.html">std::geometric_distribution</a>< _IntType >::param </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Returns the parameter set of the distribution. </p> <p class="definition">Definition at line <a class="el" href="a00452_source.html#l03973">3973</a> of file <a class="el" href="a00452_source.html">random.h</a>.</p> <p class="reference">Referenced by <a class="el" href="a17055_source.html#l01101">std::operator>>()</a>.</p> </div> </div> <a id="a75d3adb67d1d8a8d9ec152ed6076a009"></a> <h2 class="memtitle"><span class="permalink"><a href="#a75d3adb67d1d8a8d9ec152ed6076a009">◆ </a></span>param() <span class="overload">[2/2]</span></h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _IntType = int> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void <a class="el" href="a06380.html">std::geometric_distribution</a>< _IntType >::param </td> <td>(</td> <td class="paramtype">const <a class="el" href="a06384.html">param_type</a> & </td> <td class="paramname"><em>__param</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Sets the parameter set of the distribution. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">__param</td><td>The new parameter set of the distribution. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="a00452_source.html#l03981">3981</a> of file <a class="el" href="a00452_source.html">random.h</a>.</p> </div> </div> <a id="ad170e9c049fc1d5df02da5097eda29df"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad170e9c049fc1d5df02da5097eda29df">◆ </a></span>reset()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _IntType = int> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void <a class="el" href="a06380.html">std::geometric_distribution</a>< _IntType >::reset </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Resets the distribution state. </p> <p>Does nothing for the geometric distribution. </p> <p class="definition">Definition at line <a class="el" href="a00452_source.html#l03960">3960</a> of file <a class="el" href="a00452_source.html">random.h</a>.</p> </div> </div> <h2 class="groupheader">Friends And Related Function Documentation</h2> <a id="a63cafb50acfe1b10c4a26cd6c990bc3f"></a> <h2 class="memtitle"><span class="permalink"><a href="#a63cafb50acfe1b10c4a26cd6c990bc3f">◆ </a></span>operator==</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _IntType = int> </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">bool operator== </td> <td>(</td> <td class="paramtype">const <a class="el" href="a06380.html">geometric_distribution</a>< _IntType > & </td> <td class="paramname"><em>__d1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="a06380.html">geometric_distribution</a>< _IntType > & </td> <td class="paramname"><em>__d2</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">friend</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Return true if two geometric distributions have the same parameters. </p> <p class="definition">Definition at line <a class="el" href="a00452_source.html#l04038">4038</a> of file <a class="el" href="a00452_source.html">random.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="a00452_source.html">random.h</a></li> <li><a class="el" href="a17055_source.html">bits/random.tcc</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="a01538.html">std</a></li><li class="navelem"><a class="el" href="a06380.html">geometric_distribution</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> </ul> </div> </body> </html>