3 <meta http-equiv=
"Content-Type" content=
"text/html; charset=US-ASCII">
4 <title>Conceptual Requirements for Distribution Types
</title>
5 <link rel=
"stylesheet" href=
"../math.css" type=
"text/css">
6 <meta name=
"generator" content=
"DocBook XSL Stylesheets V1.77.1">
7 <link rel=
"home" href=
"../index.html" title=
"Math Toolkit 2.5.1">
8 <link rel=
"up" href=
"../using_udt.html" title=
"Chapter 14. Use with User-Defined Floating-Point Types - Boost.Multiprecision and others">
9 <link rel=
"prev" href=
"real_concepts.html" title=
"Conceptual Requirements for Real Number Types">
10 <link rel=
"next" href=
"archetypes.html" title=
"Conceptual Archetypes for Reals and Distributions">
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>
22 <div class=
"spirit-nav">
23 <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>
26 <div class=
"titlepage"><div><div><h2 class=
"title" style=
"clear: both">
27 <a name=
"math_toolkit.dist_concept"></a><a class=
"link" href=
"dist_concept.html" title=
"Conceptual Requirements for Distribution Types">Conceptual Requirements for
28 Distribution Types
</a>
29 </h2></div></div></div>
31 A
<span class=
"emphasis"><em>DistributionType
</em></span> is a type that implements the following
32 conceptual requirements, and encapsulates a statistical distribution.
35 Please note that this documentation should not be used as a substitute for
36 the
<a class=
"link" href=
"dist_ref.html" title=
"Statistical Distributions Reference">reference documentation
</a>, and
37 <a class=
"link" href=
"stat_tut.html" title=
"Statistical Distributions Tutorial">tutorial
</a> of the statistical distributions.
40 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>
41 is an object of type
<code class=
"computeroutput"><span class=
"keyword">const
</span> <span class=
"identifier">DistributionType
</span></code>
42 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>.
44 <div class=
"informaltable"><table class=
"table">
71 DistributionType::value_type
81 The real-number type
<span class=
"emphasis"><em>RealType
</em></span> upon which the
82 distribution operates.
89 DistributionType::policy_type
99 The
<a class=
"link" href=
"../policy.html" title=
"Chapter 15. Policies: Controlling Precision, Error Handling etc">Policy
</a> to use when evaluating functions
100 that depend on this distribution.
117 Distribution types are assignable.
134 Distribution types are copy constructible.
151 Returns the PDF of the distribution.
168 Returns the CDF of the distribution.
175 cdf(complement(cd, cr))
185 Returns the complement of the CDF of the distribution, the same as:
186 <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>
203 Returns the quantile (or percentile) of the distribution.
210 quantile(complement(cd, cr))
220 Returns the quantile (or percentile) of the distribution, starting
221 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>
238 Returns the cumulative hazard function of the distribution.
255 Returns the hazard function of the distribution.
272 Returns the kurtosis of the distribution.
289 Returns the kurtosis excess of the distribution.
306 Returns the mean of the distribution.
323 Returns the mode of the distribution.
340 Returns the skewness of the distribution.
347 standard_deviation(cd)
357 Returns the standard deviation of the distribution.
374 Returns the variance of the distribution.
381 <table xmlns:
rev=
"http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width=
"100%"><tr>
382 <td align=
"left"></td>
383 <td align=
"right"><div class=
"copyright-footer">Copyright
© 2006-
2010,
2012-
2014 Nikhar Agrawal,
384 Anton Bikineev, Paul A. Bristow, Marco Guazzone, Christopher Kormanyos, Hubert
385 Holin, Bruno Lalande, John Maddock, Jeremy Murphy, Johan R
åde, Gautam Sewani,
386 Benjamin Sobotta, Thijs van den Berg, Daryle Walker and Xiaogang Zhang
<p>
387 Distributed under the Boost Software License, Version
1.0. (See accompanying
388 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>)
393 <div class=
"spirit-nav">
394 <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>