doc/html/boost/random/cauchy_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 cauchy_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.cauchy_distribution_hpp" title="Header &lt;boost/random/cauchy_distribution.hpp&gt;">
  10 <link rel="prev" href="binomial_distribution/param_type.html" title="Class param_type">
  11 <link rel="next" href="cauchy_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="binomial_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.cauchy_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="cauchy_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.cauchy_distribution"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class template cauchy_distribution</span></h2>
  30 <p>boost::random::cauchy_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.cauchy_distribution_hpp" title="Header &lt;boost/random/cauchy_distribution.hpp&gt;">boost/random/cauchy_distribution.hpp</a>&gt;
  34
  35 </span><span class="keyword">template</span><span class="special">&lt;</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="cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_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.cauchy_distribution.input_type"></a><span class="identifier">input_type</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">RealType</span> <a name="boost.random.cauchy_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="cauchy_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="cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_distribution</a> <a class="link" href="cauchy_distribution/param_type.html#boost.random.cauchy_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="cauchy_distribution/param_type.html#boost.random.cauchy_distribution.param_typeconstruct-copy-destruct">construct/copy/destruct</a></span>
  50     <span class="keyword">explicit</span> <a class="link" href="cauchy_distribution/param_type.html#idp708377664-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">0</span><span class="special">,</span> <span class="identifier">RealType</span> <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">)</span><span class="special">;</span>
  51
  52     <span class="comment">// <a class="link" href="cauchy_distribution/param_type.html#idp708370672-bb">public member functions</a></span>
  53     <span class="identifier">RealType</span> <a class="link" href="cauchy_distribution/param_type.html#idp708371232-bb"><span class="identifier">median</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="cauchy_distribution/param_type.html#idp708372800-bb"><span class="identifier">sigma</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  55     <span class="identifier">RealType</span> <a class="link" href="cauchy_distribution/param_type.html#idp708374368-bb"><span class="identifier">a</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  56     <span class="identifier">RealType</span> <a class="link" href="cauchy_distribution/param_type.html#idp708375936-bb"><span class="identifier">b</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  57
  58     <span class="comment">// <a class="link" href="cauchy_distribution/param_type.html#idp708380624-bb">friend functions</a></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_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>
  61       <a class="link" href="cauchy_distribution/param_type.html#idp708381184-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="cauchy_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">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>
  63       <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>
  64       <a class="link" href="cauchy_distribution/param_type.html#idp708385760-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="cauchy_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="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="cauchy_distribution/param_type.html#idp708390336-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cauchy_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="cauchy_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  66     <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="cauchy_distribution/param_type.html#idp708393904-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cauchy_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="cauchy_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  67   <span class="special">}</span><span class="special">;</span>
  68
  69   <span class="comment">// <a class="link" href="cauchy_distribution.html#boost.random.cauchy_distributionconstruct-copy-destruct">construct/copy/destruct</a></span>
  70   <span class="keyword">explicit</span> <a class="link" href="cauchy_distribution.html#idp708420992-bb"><span class="identifier">cauchy_distribution</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">0</span><span class="special">,</span> <span class="identifier">RealType</span> <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">)</span><span class="special">;</span>
  71   <span class="keyword">explicit</span> <a class="link" href="cauchy_distribution.html#idp708425552-bb"><span class="identifier">cauchy_distribution</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cauchy_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  72
  73   <span class="comment">// <a class="link" href="cauchy_distribution.html#idp708399344-bb">public member functions</a></span>
  74   <span class="identifier">RealType</span> <a class="link" href="cauchy_distribution.html#idp708399904-bb"><span class="identifier">median</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="cauchy_distribution.html#idp708401472-bb"><span class="identifier">sigma</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  76   <span class="identifier">RealType</span> <a class="link" href="cauchy_distribution.html#idp708403040-bb"><span class="identifier">a</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  77   <span class="identifier">RealType</span> <a class="link" href="cauchy_distribution.html#idp708404608-bb"><span class="identifier">b</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  78   <span class="identifier">RealType</span> <a class="link" href="cauchy_distribution.html#idp708406176-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  79   <span class="identifier">RealType</span> <a class="link" href="cauchy_distribution.html#idp708407760-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  80   <a class="link" href="cauchy_distribution/param_type.html" title="Class param_type">param_type</a> <a class="link" href="cauchy_distribution.html#idp708409344-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  81   <span class="keyword">void</span> <a class="link" href="cauchy_distribution.html#idp708410592-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cauchy_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  82   <span class="keyword">void</span> <a class="link" href="cauchy_distribution.html#idp708412576-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  83   <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="cauchy_distribution.html#idp708413936-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="special">;</span>
  84   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Engine<span class="special">&gt;</span>
  85     <span class="identifier">result_type</span> <a class="link" href="cauchy_distribution.html#idp708416800-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="cauchy_distribution/param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  86
  87   <span class="comment">// <a class="link" href="cauchy_distribution.html#idp708428416-bb">friend functions</a></span>
  88   <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>
  89     <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>
  90     <a class="link" href="cauchy_distribution.html#idp708428976-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>
  91                <span class="keyword">const</span> <a class="link" href="cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_distribution</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  92   <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>
  93     <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>
  94     <a class="link" href="cauchy_distribution.html#idp708433984-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>
  95                <span class="keyword">const</span> <a class="link" href="cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_distribution</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  96   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="cauchy_distribution.html#idp708438992-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_distribution</a> <span class="special">&amp;</span><span class="special">,</span>
  97                          <span class="keyword">const</span> <a class="link" href="cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_distribution</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  98   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="cauchy_distribution.html#idp708442624-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_distribution</a> <span class="special">&amp;</span><span class="special">,</span>
  99                          <span class="keyword">const</span> <a class="link" href="cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_distribution</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
 100 <span class="special">}</span><span class="special">;</span></pre></div>
 101 <div class="refsect1">
 102 <a name="idp490685936"></a><h2>Description</h2>
 103 <p>The cauchy distribution is a continuous distribution with two parameters, median and sigma.</p>
 104 <p>It has <span class="inlinemediaobject"><img src="../../images/random//form_2.png"></span> </p>
 105 <div class="refsect2">
 106 <a name="idp490689440"></a><h3>
 107 <a name="boost.random.cauchy_distributionconstruct-copy-destruct"></a><code class="computeroutput">cauchy_distribution</code>
 108         public
 109        construct/copy/destruct</h3>
 110 <div class="orderedlist"><ol class="orderedlist" type="1">
 111 <li class="listitem">
 112 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp708420992-bb"></a><span class="identifier">cauchy_distribution</span><span class="special">(</span><span class="identifier">RealType</span> median <span class="special">=</span> <span class="number">0</span><span class="special">.</span><span class="number">0</span><span class="special">,</span> <span class="identifier">RealType</span> sigma <span class="special">=</span> <span class="number">1</span><span class="special">.</span><span class="number">0</span><span class="special">)</span><span class="special">;</span></pre>
 113 <p>Constructs a <code class="computeroutput"><a class="link" href="cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_distribution</a></code>  with the paramters <code class="computeroutput">median</code> and <code class="computeroutput">sigma</code>. </p>
 114 </li>
 115 <li class="listitem">
 116 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp708425552-bb"></a><span class="identifier">cauchy_distribution</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cauchy_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>
 117 <p>Constructs a <code class="computeroutput"><a class="link" href="cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_distribution</a></code>  from it's parameters. </p>
 118 </li>
 119 </ol></div>
 120 </div>
 121 <div class="refsect2">
 122 <a name="idp490713760"></a><h3>
 123 <a name="idp708399344-bb"></a><code class="computeroutput">cauchy_distribution</code> public member functions</h3>
 124 <div class="orderedlist"><ol class="orderedlist" type="1">
 125 <li class="listitem">
 126 <pre class="literallayout"><span class="identifier">RealType</span> <a name="idp708399904-bb"></a><span class="identifier">median</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 127 <p>Returns: the "median" parameter of the distribution </p>
 128 </li>
 129 <li class="listitem">
 130 <pre class="literallayout"><span class="identifier">RealType</span> <a name="idp708401472-bb"></a><span class="identifier">sigma</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 131 <p>Returns: the "sigma" parameter of the distribution </p>
 132 </li>
 133 <li class="listitem">
 134 <pre class="literallayout"><span class="identifier">RealType</span> <a name="idp708403040-bb"></a><span class="identifier">a</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 135 <p>Returns: the "median" parameter of the distribution </p>
 136 </li>
 137 <li class="listitem">
 138 <pre class="literallayout"><span class="identifier">RealType</span> <a name="idp708404608-bb"></a><span class="identifier">b</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
 139 <p>Returns: the "sigma" parameter of the distribution </p>
 140 </li>
 141 <li class="listitem">
 142 <pre class="literallayout"><span class="identifier">RealType</span> <a name="idp708406176-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">RealType</span> <a name="idp708407760-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"><pre class="literallayout"><a class="link" href="cauchy_distribution/param_type.html" title="Class param_type">param_type</a> <a name="idp708409344-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></li>
 150 <li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp708410592-bb"></a><span class="identifier">param</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cauchy_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></li>
 151 <li class="listitem">
 152 <pre class="literallayout"><span class="keyword">void</span> <a name="idp708412576-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 153 <p>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </p>
 154 </li>
 155 <li class="listitem">
 156 <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="idp708413936-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="special">;</span></pre>
 157 <p>Returns: A random variate distributed according to the cauchy distribution. </p>
 158 </li>
 159 <li class="listitem">
 160 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Engine<span class="special">&gt;</span>
 161   <span class="identifier">result_type</span> <a name="idp708416800-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="cauchy_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>
 162 <p>Returns: A random variate distributed according to the cauchy distribution with parameters specified by param. </p>
 163 </li>
 164 </ol></div>
 165 </div>
 166 <div class="refsect2">
 167 <a name="idp490786432"></a><h3>
 168 <a name="idp708428416-bb"></a><code class="computeroutput">cauchy_distribution</code> friend functions</h3>
 169 <div class="orderedlist"><ol class="orderedlist" type="1">
 170 <li class="listitem">
 171 <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>
 172   <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>
 173   <a name="idp708428976-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>
 174              <span class="keyword">const</span> <a class="link" href="cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_distribution</a> <span class="special">&amp;</span> cd<span class="special">)</span><span class="special">;</span></pre>
 175 <p>Writes the distribution to a <code class="computeroutput">std::ostream</code>. </p>
 176 </li>
 177 <li class="listitem">
 178 <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>
 179   <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>
 180   <a name="idp708433984-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>
 181              <span class="keyword">const</span> <a class="link" href="cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_distribution</a> <span class="special">&amp;</span> cd<span class="special">)</span><span class="special">;</span></pre>
 182 <p>Reads the distribution from a <code class="computeroutput">std::istream</code>. </p>
 183 </li>
 184 <li class="listitem">
 185 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp708438992-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_distribution</a> <span class="special">&amp;</span> lhs<span class="special">,</span>
 186                        <span class="keyword">const</span> <a class="link" href="cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_distribution</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 187 <p>Returns true if the two distributions will produce identical sequences of values, given equal generators. </p>
 188 </li>
 189 <li class="listitem">
 190 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp708442624-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_distribution</a> <span class="special">&amp;</span> lhs<span class="special">,</span>
 191                        <span class="keyword">const</span> <a class="link" href="cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_distribution</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 192 <p>Returns true if the two distributions may produce different sequences of values, given equal generators. </p>
 193 </li>
 194 </ol></div>
 195 </div>
 196 </div>
 197 </div>
 198 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 199 <td align="left"></td>
 200 <td align="right"><div class="copyright-footer">Copyright &#169; 2000-2005 Jens Maurer<br>Copyright &#169; 2009, 2010 Steven Watanabe<p>
 201         Distributed under the Boost Software License, Version 1.0. (See accompanying
 202         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>)
 203       </p>
 204 </div></td>
 205 </tr></table>
 206 <hr>
 207 <div class="spirit-nav">
 208 <a accesskey="p" href="binomial_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.cauchy_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="cauchy_distribution/param_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 209 </div>
 210 </body>
 211 </html>