doc/html/boost/random/cauchy_distribution/param_type.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class param_type</title>
   5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../cauchy_distribution.html#idp397991760" title="Description">
   9 <link rel="prev" href="../cauchy_distribution.html" title="Class template cauchy_distribution">
  10 <link rel="next" href="../chi_squared_distribution.html" title="Class template chi_squared_distribution">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="../cauchy_distribution.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cauchy_distribution.html#idp397991760"><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="../chi_squared_distribution.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.random.cauchy_distribution.param_type"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class param_type</span></h2>
  29 <p>boost::random::cauchy_distribution::param_type</p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <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;
  33
  34 </span>
  35
  36 <span class="keyword">class</span> <a class="link" href="param_type.html" title="Class param_type">param_type</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> <a class="link" href="../cauchy_distribution.html" title="Class template cauchy_distribution">cauchy_distribution</a> <a name="boost.random.cauchy_distribution.param_type.distribution_type"></a><span class="identifier">distribution_type</span><span class="special">;</span>
  40
  41   <span class="comment">// <a class="link" href="param_type.html#boost.random.cauchy_distribution.param_typeconstruct-copy-destruct">construct/copy/destruct</a></span>
  42   <span class="keyword">explicit</span> <a class="link" href="param_type.html#idp149741152-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>
  43
  44   <span class="comment">// <a class="link" href="param_type.html#idp149743440-bb">public member functions</a></span>
  45   <span class="identifier">RealType</span> <a class="link" href="param_type.html#idp149206816-bb"><span class="identifier">median</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  46   <span class="identifier">RealType</span> <a class="link" href="param_type.html#idp149744128-bb"><span class="identifier">sigma</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  47   <span class="identifier">RealType</span> <a class="link" href="param_type.html#idp149743312-bb"><span class="identifier">a</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  48   <span class="identifier">RealType</span> <a class="link" href="param_type.html#idp149741328-bb"><span class="identifier">b</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  49
  50   <span class="comment">// <a class="link" href="param_type.html#idp149738208-bb">friend functions</a></span>
  51   <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>
  52     <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>
  53     <a class="link" href="param_type.html#idp149736752-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="param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  54   <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>
  55     <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>
  56     <a class="link" href="param_type.html#idp228491408-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="param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  57   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="param_type.html#idp110335872-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="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="param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  58   <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="param_type.html#idp228486416-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="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="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="special">}</span><span class="special">;</span></pre></div>
  60 <div class="refsect1">
  61 <a name="idp398269584"></a><h2>Description</h2>
  62 <div class="refsect2">
  63 <a name="idp398270000"></a><h3>
  64 <a name="boost.random.cauchy_distribution.param_typeconstruct-copy-destruct"></a><code class="computeroutput">param_type</code>
  65         public
  66        construct/copy/destruct</h3>
  67 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  68 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idp149741152-bb"></a><span class="identifier">param_type</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>
  69 <p>Constructs the parameters of the cauchy distribution. </p>
  70 </li></ol></div>
  71 </div>
  72 <div class="refsect2">
  73 <a name="idp398283440"></a><h3>
  74 <a name="idp149743440-bb"></a><code class="computeroutput">param_type</code> public member functions</h3>
  75 <div class="orderedlist"><ol class="orderedlist" type="1">
  76 <li class="listitem">
  77 <pre class="literallayout"><span class="identifier">RealType</span> <a name="idp149206816-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>
  78 <p>Returns the median of the distribution. </p>
  79 </li>
  80 <li class="listitem">
  81 <pre class="literallayout"><span class="identifier">RealType</span> <a name="idp149744128-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>
  82 <p>Returns the sigma parameter of the distribution. </p>
  83 </li>
  84 <li class="listitem">
  85 <pre class="literallayout"><span class="identifier">RealType</span> <a name="idp149743312-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>
  86 <p>Returns the median of the distribution. </p>
  87 </li>
  88 <li class="listitem">
  89 <pre class="literallayout"><span class="identifier">RealType</span> <a name="idp149741328-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>
  90 <p>Returns the sigma parameter of the distribution. </p>
  91 </li>
  92 </ol></div>
  93 </div>
  94 <div class="refsect2">
  95 <a name="idp398306848"></a><h3>
  96 <a name="idp149738208-bb"></a><code class="computeroutput">param_type</code> friend functions</h3>
  97 <div class="orderedlist"><ol class="orderedlist" type="1">
  98 <li class="listitem">
  99 <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>
 100   <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>
 101   <a name="idp149736752-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>
 102              <span class="keyword">const</span> <a class="link" href="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>
 103 <p>Writes the parameters to a std::ostream. </p>
 104 </li>
 105 <li class="listitem">
 106 <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>
 107   <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>
 108   <a name="idp228491408-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>
 109              <span class="keyword">const</span> <a class="link" href="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>
 110 <p>Reads the parameters from a std::istream. </p>
 111 </li>
 112 <li class="listitem">
 113 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp110335872-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span> lhs<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 114 <p>Returns true if the two sets of parameters are equal. </p>
 115 </li>
 116 <li class="listitem">
 117 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp228486416-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span> lhs<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">&amp;</span> rhs<span class="special">)</span><span class="special">;</span></pre>
 118 <p>Returns true if the two sets of parameters are different. </p>
 119 </li>
 120 </ol></div>
 121 </div>
 122 </div>
 123 </div>
 124 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 125 <td align="left"></td>
 126 <td align="right"><div class="copyright-footer">Copyright &#169; 2000-2005 Jens Maurer<br>Copyright &#169; 2009, 2010 Steven Watanabe<p>
 127         Distributed under the Boost Software License, Version 1.0. (See accompanying
 128         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>)
 129       </p>
 130 </div></td>
 131 </tr></table>
 132 <hr>
 133 <div class="spirit-nav">
 134 <a accesskey="p" href="../cauchy_distribution.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cauchy_distribution.html#idp397991760"><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="../chi_squared_distribution.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
 135 </div>
 136 </body>
 137 </html>