<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.5"/>
<title>libstdc++: std::cauchy_distribution< _RealType > 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="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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 style="padding-left: 0.5em;">
<div id="projectname">libstdc++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
</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">
$(document).ready(function(){initNavTree('a00660.html','');});
</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="a02865.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">std::cauchy_distribution< _RealType > Class Template Reference<div class="ingroups"><a class="el" href="a01748.html">Normal 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="a00661.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:aa8912582da5d0545839decb4e97304ce"><td class="memItemLeft" align="right" valign="top">typedef _RealType </td><td class="memItemRight" valign="bottom"><a class="el" href="a00660.html#aa8912582da5d0545839decb4e97304ce">result_type</a></td></tr>
<tr class="separator:aa8912582da5d0545839decb4e97304ce"><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:a35b2f383ee2afb54184248c44b77dee8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35b2f383ee2afb54184248c44b77dee8"></a>
 </td><td class="memItemRight" valign="bottom"><b>cauchy_distribution</b> (_RealType __a=_RealType(0), _RealType __b=_RealType(1))</td></tr>
<tr class="separator:a35b2f383ee2afb54184248c44b77dee8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84ba98587b6d708314c0b95689cd8c7f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a84ba98587b6d708314c0b95689cd8c7f"></a>
 </td><td class="memItemRight" valign="bottom"><b>cauchy_distribution</b> (const <a class="el" href="a00661.html">param_type</a> &__p)</td></tr>
<tr class="separator:a84ba98587b6d708314c0b95689cd8c7f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c35e8422b1a83e76821997d77d5568f"><td class="memTemplParams" colspan="2"><a class="anchor" id="a0c35e8422b1a83e76821997d77d5568f"></a>
template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > </td></tr>
<tr class="memitem:a0c35e8422b1a83e76821997d77d5568f"><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:a0c35e8422b1a83e76821997d77d5568f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b9148a7de17c8d9d62a6c6577462467"><td class="memTemplParams" colspan="2"><a class="anchor" id="a4b9148a7de17c8d9d62a6c6577462467"></a>
template<typename _ForwardIterator , typename _UniformRandomNumberGenerator > </td></tr>
<tr class="memitem:a4b9148a7de17c8d9d62a6c6577462467"><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="a00661.html">param_type</a> &__p)</td></tr>
<tr class="separator:a4b9148a7de17c8d9d62a6c6577462467"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc99a6138be1f665359e4456ae5e00b2"><td class="memTemplParams" colspan="2"><a class="anchor" id="afc99a6138be1f665359e4456ae5e00b2"></a>
template<typename _UniformRandomNumberGenerator > </td></tr>
<tr class="memitem:afc99a6138be1f665359e4456ae5e00b2"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>__generate</b> (<a class="el" href="a00660.html#aa8912582da5d0545839decb4e97304ce">result_type</a> *__f, <a class="el" href="a00660.html#aa8912582da5d0545839decb4e97304ce">result_type</a> *__t, _UniformRandomNumberGenerator &__urng, const <a class="el" href="a00661.html">param_type</a> &__p)</td></tr>
<tr class="separator:afc99a6138be1f665359e4456ae5e00b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6c541f53c7402d10880c656fe0c868f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6c541f53c7402d10880c656fe0c868f"></a>
_RealType </td><td class="memItemRight" valign="bottom"><b>a</b> () const </td></tr>
<tr class="separator:ae6c541f53c7402d10880c656fe0c868f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0435ab9f36bba22d03df4396a2042d5e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0435ab9f36bba22d03df4396a2042d5e"></a>
_RealType </td><td class="memItemRight" valign="bottom"><b>b</b> () const </td></tr>
<tr class="separator:a0435ab9f36bba22d03df4396a2042d5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8d26b863cc79c0d10814745f7a4b173"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00660.html#aa8912582da5d0545839decb4e97304ce">result_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00660.html#af8d26b863cc79c0d10814745f7a4b173">max</a> () const </td></tr>
<tr class="separator:af8d26b863cc79c0d10814745f7a4b173"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff97eb6a0dc4318da5585e68be2e6deb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00660.html#aa8912582da5d0545839decb4e97304ce">result_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00660.html#aff97eb6a0dc4318da5585e68be2e6deb">min</a> () const </td></tr>
<tr class="separator:aff97eb6a0dc4318da5585e68be2e6deb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abfc19a82a01032d4887ee8b576d620c3"><td class="memTemplParams" colspan="2"><a class="anchor" id="abfc19a82a01032d4887ee8b576d620c3"></a>
template<typename _UniformRandomNumberGenerator > </td></tr>
<tr class="memitem:abfc19a82a01032d4887ee8b576d620c3"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="a00660.html">cauchy_distribution</a>< _RealType ><br class="typebreak"/>
::<a class="el" href="a00660.html#aa8912582da5d0545839decb4e97304ce">result_type</a> </td><td class="memTemplItemRight" valign="bottom"><b>operator()</b> (_UniformRandomNumberGenerator &__urng, const <a class="el" href="a00661.html">param_type</a> &__p)</td></tr>
<tr class="separator:abfc19a82a01032d4887ee8b576d620c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae2c1bb8200f59e2e62b591676fffbf41"><td class="memTemplParams" colspan="2">template<typename _UniformRandomNumberGenerator > </td></tr>
<tr class="memitem:ae2c1bb8200f59e2e62b591676fffbf41"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="a00660.html#aa8912582da5d0545839decb4e97304ce">result_type</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00660.html#ae2c1bb8200f59e2e62b591676fffbf41">operator()</a> (_UniformRandomNumberGenerator &__urng)</td></tr>
<tr class="separator:ae2c1bb8200f59e2e62b591676fffbf41"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9667b83624fd8469adfcf68ddf0b3011"><td class="memTemplParams" colspan="2"><a class="anchor" id="a9667b83624fd8469adfcf68ddf0b3011"></a>
template<typename _UniformRandomNumberGenerator > </td></tr>
<tr class="memitem:a9667b83624fd8469adfcf68ddf0b3011"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="a00660.html#aa8912582da5d0545839decb4e97304ce">result_type</a> </td><td class="memTemplItemRight" valign="bottom"><b>operator()</b> (_UniformRandomNumberGenerator &__urng, const <a class="el" href="a00661.html">param_type</a> &__p)</td></tr>
<tr class="separator:a9667b83624fd8469adfcf68ddf0b3011"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02c00a71041d194f5ed85e949d905ac7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00661.html">param_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00660.html#a02c00a71041d194f5ed85e949d905ac7">param</a> () const </td></tr>
<tr class="separator:a02c00a71041d194f5ed85e949d905ac7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef17e054f8317d965a4baf4fa0424760"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00660.html#aef17e054f8317d965a4baf4fa0424760">param</a> (const <a class="el" href="a00661.html">param_type</a> &__param)</td></tr>
<tr class="separator:aef17e054f8317d965a4baf4fa0424760"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa71463201b987ecaf218767aeaf9f8e8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00660.html#aa71463201b987ecaf218767aeaf9f8e8">reset</a> ()</td></tr>
<tr class="separator:aa71463201b987ecaf218767aeaf9f8e8"><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:a9df65ecb32574bdf021bd67b12ad772f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00660.html#a9df65ecb32574bdf021bd67b12ad772f">operator==</a> (const <a class="el" href="a00660.html">cauchy_distribution</a> &__d1, const <a class="el" href="a00660.html">cauchy_distribution</a> &__d2)</td></tr>
<tr class="separator:a9df65ecb32574bdf021bd67b12ad772f"><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 _RealType = double><br/>
class std::cauchy_distribution< _RealType ></h3>
<p>A cauchy_distribution random number distribution. </p>
<p>The formula for the normal probability mass function is <img class="formulaInl" alt="$p(x|a,b) = (\pi b (1 + (\frac{x-a}{b})^2))^{-1}$" src="form_10.png"/> </p>
<p>Definition at line <a class="el" href="a01452_source.html#l02929">2929</a> of file <a class="el" href="a01452_source.html">random.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="aa8912582da5d0545839decb4e97304ce"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </div>
<table class="memname">
<tr>
<td class="memname">typedef _RealType <a class="el" href="a00660.html">std::cauchy_distribution</a>< _RealType >::<a class="el" href="a00660.html#aa8912582da5d0545839decb4e97304ce">result_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The type of the range of the distribution. </p>
<p>Definition at line <a class="el" href="a01452_source.html#l02932">2932</a> of file <a class="el" href="a01452_source.html">random.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af8d26b863cc79c0d10814745f7a4b173"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00660.html#aa8912582da5d0545839decb4e97304ce">result_type</a> <a class="el" href="a00660.html">std::cauchy_distribution</a>< _RealType >::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>Definition at line <a class="el" href="a01452_source.html#l03020">3020</a> of file <a class="el" href="a01452_source.html">random.h</a>.</p>
<p>References <a class="el" href="a01334_source.html#l00313">std::numeric_limits< _Tp >::max()</a>.</p>
</div>
</div>
<a class="anchor" id="aff97eb6a0dc4318da5585e68be2e6deb"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00660.html#aa8912582da5d0545839decb4e97304ce">result_type</a> <a class="el" href="a00660.html">std::cauchy_distribution</a>< _RealType >::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>Definition at line <a class="el" href="a01452_source.html#l03013">3013</a> of file <a class="el" href="a01452_source.html">random.h</a>.</p>
<p>References <a class="el" href="a01334_source.html#l00319">std::numeric_limits< _Tp >::lowest()</a>.</p>
</div>
</div>
<a class="anchor" id="ae2c1bb8200f59e2e62b591676fffbf41"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </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="a00660.html#aa8912582da5d0545839decb4e97304ce">result_type</a> <a class="el" href="a00660.html">std::cauchy_distribution</a>< _RealType >::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>Definition at line <a class="el" href="a01452_source.html#l03028">3028</a> of file <a class="el" href="a01452_source.html">random.h</a>.</p>
</div>
</div>
<a class="anchor" id="a02c00a71041d194f5ed85e949d905ac7"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00661.html">param_type</a> <a class="el" href="a00660.html">std::cauchy_distribution</a>< _RealType >::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>Definition at line <a class="el" href="a01452_source.html#l02998">2998</a> of file <a class="el" href="a01452_source.html">random.h</a>.</p>
<p>Referenced by <a class="el" href="a01453_source.html#l02299">std::operator>>()</a>.</p>
</div>
</div>
<a class="anchor" id="aef17e054f8317d965a4baf4fa0424760"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00660.html">std::cauchy_distribution</a>< _RealType >::param </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00661.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>Definition at line <a class="el" href="a01452_source.html#l03006">3006</a> of file <a class="el" href="a01452_source.html">random.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa71463201b987ecaf218767aeaf9f8e8"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="a00660.html">std::cauchy_distribution</a>< _RealType >::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>Definition at line <a class="el" href="a01452_source.html#l02980">2980</a> of file <a class="el" href="a01452_source.html">random.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a9df65ecb32574bdf021bd67b12ad772f"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename _RealType = double> </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="a00660.html">cauchy_distribution</a>< _RealType > & </td>
<td class="paramname"><em>__d1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00660.html">cauchy_distribution</a>< _RealType > & </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 Cauchy distributions have the same parameters. </p>
<p>Definition at line <a class="el" href="a01452_source.html#l03063">3063</a> of file <a class="el" href="a01452_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="a01452_source.html">random.h</a></li>
<li><a class="el" href="a01453_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="a01662.html">std</a></li><li class="navelem"><a class="el" href="a00660.html">cauchy_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.5 </li>
</ul>
</div>
</body>
</html>
