devn00b
/
EQ2EMu


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
							<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Conceptual Requirements for Distribution Types</title>
<link rel="stylesheet" href="../math.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../index.html" title="Math Toolkit 2.11.0">
<link rel="up" href="../using_udt.html" title="Chapter&#160;19.&#160;Use with User-Defined Floating-Point Types - Boost.Multiprecision and others">
<link rel="prev" href="real_concepts.html" title="Conceptual Requirements for Real Number Types">
<link rel="next" href="archetypes.html" title="Conceptual Archetypes for Reals and Distributions">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="real_concepts.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../using_udt.html"><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="archetypes.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="math_toolkit.dist_concept"></a><a class="link" href="dist_concept.html" title="Conceptual Requirements for Distribution Types">Conceptual Requirements for
    Distribution Types</a>
</h2></div></div></div>
<p>
      A <span class="emphasis"><em>DistributionType</em></span> is a type that implements the following
      conceptual requirements, and encapsulates a statistical distribution.
    </p>
<p>
      Please note that this documentation should not be used as a substitute for
      the <a class="link" href="dist_ref.html" title="Statistical Distributions Reference">reference documentation</a>, and
      <a class="link" href="stat_tut.html" title="Statistical Distributions Tutorial">tutorial</a> of the statistical distributions.
    </p>
<p>
      In the following table, <span class="emphasis"><em>d</em></span> is an object of type <code class="computeroutput"><span class="identifier">DistributionType</span></code>, <span class="emphasis"><em>cd</em></span>
      is an object of type <code class="computeroutput"><span class="keyword">const</span> <span class="identifier">DistributionType</span></code>
      and <span class="emphasis"><em>cr</em></span> is an object of a type convertible to <code class="computeroutput"><span class="identifier">RealType</span></code>.
    </p>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
              <p>
                Expression
              </p>
            </th>
<th>
              <p>
                Result Type
              </p>
            </th>
<th>
              <p>
                Notes
              </p>
            </th>
</tr></thead>
<tbody>
<tr>
<td>
              <p>
                DistributionType::value_type
              </p>
            </td>
<td>
              <p>
                RealType
              </p>
            </td>
<td>
              <p>
                The real-number type <span class="emphasis"><em>RealType</em></span> upon which the
                distribution operates.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                DistributionType::policy_type
              </p>
            </td>
<td>
              <p>
                RealType
              </p>
            </td>
<td>
              <p>
                The <a class="link" href="../policy.html" title="Chapter&#160;20.&#160;Policies: Controlling Precision, Error Handling etc">Policy</a> to use when evaluating functions
                that depend on this distribution.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                d = cd
              </p>
            </td>
<td>
              <p>
                Distribution&amp;
              </p>
            </td>
<td>
              <p>
                Distribution types are assignable.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                Distribution(cd)
              </p>
            </td>
<td>
              <p>
                Distribution
              </p>
            </td>
<td>
              <p>
                Distribution types are copy constructible.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                pdf(cd, cr)
              </p>
            </td>
<td>
              <p>
                RealType
              </p>
            </td>
<td>
              <p>
                Returns the PDF of the distribution.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                cdf(cd, cr)
              </p>
            </td>
<td>
              <p>
                RealType
              </p>
            </td>
<td>
              <p>
                Returns the CDF of the distribution.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                cdf(complement(cd, cr))
              </p>
            </td>
<td>
              <p>
                RealType
              </p>
            </td>
<td>
              <p>
                Returns the complement of the CDF of the distribution, the same as:
                <code class="computeroutput"><span class="number">1</span><span class="special">-</span><span class="identifier">cdf</span><span class="special">(</span><span class="identifier">cd</span><span class="special">,</span> <span class="identifier">cr</span><span class="special">)</span></code>
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                quantile(cd, cr)
              </p>
            </td>
<td>
              <p>
                RealType
              </p>
            </td>
<td>
              <p>
                Returns the quantile (or percentile) of the distribution.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                quantile(complement(cd, cr))
              </p>
            </td>
<td>
              <p>
                RealType
              </p>
            </td>
<td>
              <p>
                Returns the quantile (or percentile) of the distribution, starting
                from the complement of the probability, the same as: <code class="computeroutput"><span class="identifier">quantile</span><span class="special">(</span><span class="identifier">cd</span><span class="special">,</span> <span class="number">1</span><span class="special">-</span><span class="identifier">cr</span><span class="special">)</span></code>
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                chf(cd, cr)
              </p>
            </td>
<td>
              <p>
                RealType
              </p>
            </td>
<td>
              <p>
                Returns the cumulative hazard function of the distribution.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                hazard(cd, cr)
              </p>
            </td>
<td>
              <p>
                RealType
              </p>
            </td>
<td>
              <p>
                Returns the hazard function of the distribution.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                kurtosis(cd)
              </p>
            </td>
<td>
              <p>
                RealType
              </p>
            </td>
<td>
              <p>
                Returns the kurtosis of the distribution.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                kurtosis_excess(cd)
              </p>
            </td>
<td>
              <p>
                RealType
              </p>
            </td>
<td>
              <p>
                Returns the kurtosis excess of the distribution.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                mean(cd)
              </p>
            </td>
<td>
              <p>
                RealType
              </p>
            </td>
<td>
              <p>
                Returns the mean of the distribution.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                mode(cd)
              </p>
            </td>
<td>
              <p>
                RealType
              </p>
            </td>
<td>
              <p>
                Returns the mode of the distribution.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                skewness(cd)
              </p>
            </td>
<td>
              <p>
                RealType
              </p>
            </td>
<td>
              <p>
                Returns the skewness of the distribution.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                standard_deviation(cd)
              </p>
            </td>
<td>
              <p>
                RealType
              </p>
            </td>
<td>
              <p>
                Returns the standard deviation of the distribution.
              </p>
            </td>
</tr>
<tr>
<td>
              <p>
                variance(cd)
              </p>
            </td>
<td>
              <p>
                RealType
              </p>
            </td>
<td>
              <p>
                Returns the variance of the distribution.
              </p>
            </td>
</tr>
</tbody>
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2006-2019 Nikhar
      Agrawal, Anton Bikineev, Paul A. Bristow, Marco Guazzone, Christopher Kormanyos,
      Hubert Holin, Bruno Lalande, John Maddock, Jeremy Murphy, Matthew Pulver, Johan
      R&#229;de, Gautam Sewani, Benjamin Sobotta, Nicholas Thompson, Thijs van den Berg,
      Daryle Walker and Xiaogang Zhang<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="real_concepts.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../using_udt.html"><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="archetypes.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>