diff options
Diffstat (limited to 'doc/html/boost/random/piecew_1_3_34_5_6_31_1_1_1/param_type.html')
| -rw-r--r-- | doc/html/boost/random/piecew_1_3_34_5_6_31_1_1_1/param_type.html | 161 |
1 files changed, 161 insertions, 0 deletions
diff --git a/doc/html/boost/random/piecew_1_3_34_5_6_31_1_1_1/param_type.html b/doc/html/boost/random/piecew_1_3_34_5_6_31_1_1_1/param_type.html new file mode 100644 index 0000000000..e69588020a --- /dev/null +++ b/doc/html/boost/random/piecew_1_3_34_5_6_31_1_1_1/param_type.html @@ -0,0 +1,161 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Class param_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../piecew_1_3_34_5_6_31_1_1_1.html#id-1.3.34.5.6.30.3.4" title="Description"> +<link rel="prev" href="../piecew_1_3_34_5_6_31_1_1_1.html" title="Class template piecewise_constant_distribution"> +<link rel="next" href="../piecew_1_3_34_5_6_32_1_1_1.html" title="Class template piecewise_linear_distribution"> +</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="../piecew_1_3_34_5_6_31_1_1_1.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../piecew_1_3_34_5_6_31_1_1_1.html#id-1.3.34.5.6.30.3.4"><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="../piecew_1_3_34_5_6_32_1_1_1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.random.piecew_1_3_34_5_6_31_1_1_1.param_type"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Class param_type</span></h2> +<p>boost::random::piecewise_constant_distribution::param_type</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../boost_random/reference.html#header.boost.random.piecewise_constant_distribution_hpp" title="Header <boost/random/piecewise_constant_distribution.hpp>">boost/random/piecewise_constant_distribution.hpp</a>> + +</span> + +<span class="keyword">class</span> <a class="link" href="param_type.html" title="Class param_type">param_type</a> <span class="special">{</span> +<span class="keyword">public</span><span class="special">:</span> + <span class="comment">// types</span> + <span class="keyword">typedef</span> <a class="link" href="../piecew_1_3_34_5_6_31_1_1_1.html" title="Class template piecewise_constant_distribution">piecewise_constant_distribution</a> <a name="boost.random.piecew_1_3_34_5_6_31_1_1_1.param_type.distribution_type"></a><span class="identifier">distribution_type</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="param_type.html#boost.random.piecew_1_3_34_5_6_31_1_1_1.param_typeconstruct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="param_type.html#id-1_3_34_5_6_31_1_1_1_3_4-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntervalIter<span class="special">,</span> <span class="keyword">typename</span> WeightIter<span class="special">></span> + <a class="link" href="param_type.html#id-1_3_34_5_6_31_1_1_1_3_5-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="identifier">IntervalIter</span><span class="special">,</span> <span class="identifier">IntervalIter</span><span class="special">,</span> <span class="identifier">WeightIter</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> F<span class="special">></span> + <a class="link" href="param_type.html#id-1_3_34_5_6_31_1_1_1_3_6-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="identifier">F</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntervalRange<span class="special">,</span> <span class="keyword">typename</span> WeightRange<span class="special">></span> + <a class="link" href="param_type.html#id-1_3_34_5_6_31_1_1_1_3_7-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">IntervalRange</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">WeightRange</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> F<span class="special">></span> <a class="link" href="param_type.html#id-1_3_34_5_6_31_1_1_1_3_8-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">RealType</span><span class="special">,</span> <span class="identifier">RealType</span><span class="special">,</span> <span class="identifier">F</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="param_type.html#id-1_3_34_5_6_31_1_1_1_3_2-bb">friend functions</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span> + <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> + <a class="link" href="param_type.html#id-1_3_34_5_6_31_1_1_1_3_2_1-bb"><span class="keyword">operator</span><span class="special"><<</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></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">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span> + <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> + <a class="link" href="param_type.html#id-1_3_34_5_6_31_1_1_1_3_2_2-bb"><span class="keyword">operator</span><span class="special">>></span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></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">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="param_type.html#id-1_3_34_5_6_31_1_1_1_3_2_3-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">&</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">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">friend</span> <span class="keyword">bool</span> <a class="link" href="param_type.html#id-1_3_34_5_6_31_1_1_1_3_2_4-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">&</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">&</span><span class="special">)</span><span class="special">;</span> + + <span class="comment">// <a class="link" href="param_type.html#id-1_3_34_5_6_31_1_1_1_3_3-bb">public member functions</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">RealType</span> <span class="special">></span> <a class="link" href="param_type.html#id-1_3_34_5_6_31_1_1_1_3_3_1-bb"><span class="identifier">intervals</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">RealType</span> <span class="special">></span> <a class="link" href="param_type.html#id-1_3_34_5_6_31_1_1_1_3_3_2-bb"><span class="identifier">densities</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> +<span class="special">}</span><span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="id-1.3.34.5.6.30.3.4.6.4"></a><h2>Description</h2> +<div class="refsect2"> +<a name="id-1.3.34.5.6.30.3.4.6.4.2"></a><h3> +<a name="boost.random.piecew_1_3_34_5_6_31_1_1_1.param_typeconstruct-copy-destruct"></a><code class="computeroutput">param_type</code> + public + construct/copy/destruct</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><a name="id-1_3_34_5_6_31_1_1_1_3_4-bb"></a><span class="identifier">param_type</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="param_type.html" title="Class param_type">param_type</a></code></code> object, representing a distribution that produces values uniformly distributed in the range [0, 1). </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntervalIter<span class="special">,</span> <span class="keyword">typename</span> WeightIter<span class="special">></span> + <a name="id-1_3_34_5_6_31_1_1_1_3_5-bb"></a><span class="identifier">param_type</span><span class="special">(</span><span class="identifier">IntervalIter</span> intervals_first<span class="special">,</span> <span class="identifier">IntervalIter</span> intervals_last<span class="special">,</span> + <span class="identifier">WeightIter</span> weight_first<span class="special">)</span><span class="special">;</span></pre> +<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="param_type.html" title="Class param_type">param_type</a></code></code> object from two iterator ranges containing the interval boundaries and the interval weights. If there are less than two boundaries, then this is equivalent to the default constructor and creates a single interval, [0, 1).</p> +<p>The values of the interval boundaries must be strictly increasing, and the number of weights must be one less than the number of interval boundaries. If there are extra weights, they are ignored. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> F<span class="special">></span> + <a name="id-1_3_34_5_6_31_1_1_1_3_6-bb"></a><span class="identifier">param_type</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">initializer_list</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span> il<span class="special">,</span> <span class="identifier">F</span> f<span class="special">)</span><span class="special">;</span></pre> +<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="param_type.html" title="Class param_type">param_type</a></code></code> object from an initializer_list containing the interval boundaries and a unary function specifying the weights. Each weight is determined by calling the function at the midpoint of the corresponding interval.</p> +<p>If the initializer_list contains less than two elements, this is equivalent to the default constructor and the distribution will produce values uniformly distributed in the range [0, 1). </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> IntervalRange<span class="special">,</span> <span class="keyword">typename</span> WeightRange<span class="special">></span> + <a name="id-1_3_34_5_6_31_1_1_1_3_7-bb"></a><span class="identifier">param_type</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">IntervalRange</span> <span class="special">&</span> intervals_arg<span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">WeightRange</span> <span class="special">&</span> weights_arg<span class="special">)</span><span class="special">;</span></pre> +<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="param_type.html" title="Class param_type">param_type</a></code></code> object from Boost.Range ranges holding the interval boundaries and the weights. If there are less than two interval boundaries, this is equivalent to the default constructor and the distribution will produce values uniformly distributed in the range [0, 1). The number of weights must be one less than the number of interval boundaries. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> F<span class="special">></span> + <a name="id-1_3_34_5_6_31_1_1_1_3_8-bb"></a><span class="identifier">param_type</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> nw<span class="special">,</span> <span class="identifier">RealType</span> xmin<span class="special">,</span> <span class="identifier">RealType</span> xmax<span class="special">,</span> <span class="identifier">F</span> f<span class="special">)</span><span class="special">;</span></pre> +<p>Constructs the parameters for a distribution that approximates a function. The range of the distribution is [xmin, xmax). This range is divided into nw equally sized intervals and the weights are found by calling the unary function f on the midpoints of the intervals. </p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id-1.3.34.5.6.30.3.4.6.4.3"></a><h3> +<a name="id-1_3_34_5_6_31_1_1_1_3_2-bb"></a><code class="computeroutput">param_type</code> friend functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span> + <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> + <a name="id-1_3_34_5_6_31_1_1_1_3_2_1-bb"></a><span class="keyword">operator</span><span class="special"><<</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> os<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">&</span> param<span class="special">)</span><span class="special">;</span></pre> +<p>Writes the parameters to a <code class="computeroutput">std::ostream</code>. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharT<span class="special">,</span> <span class="keyword">typename</span> Traits<span class="special">></span> + <span class="keyword">friend</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> + <a name="id-1_3_34_5_6_31_1_1_1_3_2_2-bb"></a><span class="keyword">operator</span><span class="special">>></span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">Traits</span> <span class="special">></span> <span class="special">&</span> is<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">&</span> param<span class="special">)</span><span class="special">;</span></pre> +<p>Reads the parameters from a <code class="computeroutput">std::istream</code>. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_31_1_1_1_3_2_3-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">&</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">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> +<p>Returns true if the two sets of parameters are the same. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id-1_3_34_5_6_31_1_1_1_3_2_4-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">&</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">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> +<p>Returns true if the two sets of parameters are different. </p> +</li> +</ol></div> +</div> +<div class="refsect2"> +<a name="id-1.3.34.5.6.30.3.4.6.4.4"></a><h3> +<a name="id-1_3_34_5_6_31_1_1_1_3_3-bb"></a><code class="computeroutput">param_type</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">RealType</span> <span class="special">></span> <a name="id-1_3_34_5_6_31_1_1_1_3_3_1-bb"></a><span class="identifier">intervals</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Returns a vector containing the interval boundaries. </p> +</li> +<li class="listitem"> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">RealType</span> <span class="special">></span> <a name="id-1_3_34_5_6_31_1_1_1_3_3_2-bb"></a><span class="identifier">densities</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<p>Returns a vector containing the probability densities over all the intervals of the distribution. </p> +</li> +</ol></div> +</div> +</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 © 2000-2005 Jens Maurer<br>Copyright © 2009, 2010 Steven Watanabe<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="../piecew_1_3_34_5_6_31_1_1_1.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../piecew_1_3_34_5_6_31_1_1_1.html#id-1.3.34.5.6.30.3.4"><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="../piecew_1_3_34_5_6_32_1_1_1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |