diff options
author | Chanho Park <chanho61.park@samsung.com> | 2014-12-11 18:55:56 +0900 |
---|---|---|
committer | Chanho Park <chanho61.park@samsung.com> | 2014-12-11 18:55:56 +0900 |
commit | 08c1e93fa36a49f49325a07fe91ff92c964c2b6c (patch) | |
tree | 7a7053ceb8874b28ec4b868d4c49b500008a102e /doc/html/boost/random/uniform_smallint.html | |
parent | bb4dd8289b351fae6b55e303f189127a394a1edd (diff) | |
download | boost-08c1e93fa36a49f49325a07fe91ff92c964c2b6c.tar.gz boost-08c1e93fa36a49f49325a07fe91ff92c964c2b6c.tar.bz2 boost-08c1e93fa36a49f49325a07fe91ff92c964c2b6c.zip |
Imported Upstream version 1.57.0upstream/1.57.0
Diffstat (limited to 'doc/html/boost/random/uniform_smallint.html')
-rw-r--r-- | doc/html/boost/random/uniform_smallint.html | 104 |
1 files changed, 52 insertions, 52 deletions
diff --git a/doc/html/boost/random/uniform_smallint.html b/doc/html/boost/random/uniform_smallint.html index f0fcfe47a4..1a03c17cf5 100644 --- a/doc/html/boost/random/uniform_smallint.html +++ b/doc/html/boost/random/uniform_smallint.html @@ -3,7 +3,7 @@ <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template uniform_smallint</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../boost_random/reference.html#header.boost.random.uniform_smallint_hpp" title="Header <boost/random/uniform_smallint.hpp>"> <link rel="prev" href="uniform_real_distribution/param_type.html" title="Class param_type"> @@ -46,55 +46,55 @@ <span class="keyword">typedef</span> <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <a class="link" href="uniform_smallint/param_type.html#boost.random.uniform_smallint.param_type.distribution_type"><span class="identifier">distribution_type</span></a><span class="special">;</span> <span class="comment">// <a class="link" href="uniform_smallint/param_type.html#boost.random.uniform_smallint.param_typeconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="uniform_smallint/param_type.html#id1303208-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="identifier">IntType</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">IntType</span> <span class="special">=</span> <span class="number">9</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="uniform_smallint/param_type.html#idp100418672-bb"><span class="identifier">param_type</span></a><span class="special">(</span><span class="identifier">IntType</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">IntType</span> <span class="special">=</span> <span class="number">9</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="uniform_smallint/param_type.html#id1303181-bb">public member functions</a></span> - <span class="identifier">IntType</span> <a class="link" href="uniform_smallint/param_type.html#id1303185-bb"><span class="identifier">a</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">IntType</span> <a class="link" href="uniform_smallint/param_type.html#id1303196-bb"><span class="identifier">b</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="uniform_smallint/param_type.html#idp100414848-bb">public member functions</a></span> + <span class="identifier">IntType</span> <a class="link" href="uniform_smallint/param_type.html#idp100415408-bb"><span class="identifier">a</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">IntType</span> <a class="link" href="uniform_smallint/param_type.html#idp100416960-bb"><span class="identifier">b</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="uniform_smallint/param_type.html#id1303236-bb">friend functions</a></span> + <span class="comment">// <a class="link" href="uniform_smallint/param_type.html#idp223845088-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="uniform_smallint/param_type.html#id1303240-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="uniform_smallint/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="uniform_smallint/param_type.html#idp223845648-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="uniform_smallint/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="uniform_smallint/param_type.html#id1293983-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="uniform_smallint/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="uniform_smallint/param_type.html#id1294026-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint/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="uniform_smallint/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="uniform_smallint/param_type.html#id1294057-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint/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="uniform_smallint/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="uniform_smallint/param_type.html#idp223850656-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="uniform_smallint/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="uniform_smallint/param_type.html#idp223855664-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint/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="uniform_smallint/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="uniform_smallint/param_type.html#idp223812448-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint/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="uniform_smallint/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="uniform_smallint.html#boost.random.uniform_smallintconstruct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="uniform_smallint.html#id1294255-bb"><span class="identifier">uniform_smallint</span></a><span class="special">(</span><span class="identifier">IntType</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">IntType</span> <span class="special">=</span> <span class="number">9</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">explicit</span> <a class="link" href="uniform_smallint.html#id1294293-bb"><span class="identifier">uniform_smallint</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint/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">explicit</span> <a class="link" href="uniform_smallint.html#idp108700096-bb"><span class="identifier">uniform_smallint</span></a><span class="special">(</span><span class="identifier">IntType</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">IntType</span> <span class="special">=</span> <span class="number">9</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="uniform_smallint.html#idp154307248-bb"><span class="identifier">uniform_smallint</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint/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="uniform_smallint.html#id1294098-bb">public member functions</a></span> - <span class="identifier">result_type</span> <a class="link" href="uniform_smallint.html#id1294102-bb"><span class="identifier">a</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">result_type</span> <a class="link" href="uniform_smallint.html#id1294114-bb"><span class="identifier">b</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">result_type</span> <a class="link" href="uniform_smallint.html#id1294125-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">result_type</span> <a class="link" href="uniform_smallint.html#id1294137-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <a class="link" href="uniform_smallint/param_type.html" title="Class param_type">param_type</a> <a class="link" href="uniform_smallint.html#id1294149-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="uniform_smallint.html#id1294162-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint/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">void</span> <a class="link" href="uniform_smallint.html#id1294183-bb"><span class="identifier">reset</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> Engine<span class="special">></span> <span class="identifier">result_type</span> <a class="link" href="uniform_smallint.html#id1294196-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">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="uniform_smallint.html#idp223817808-bb">public member functions</a></span> + <span class="identifier">result_type</span> <a class="link" href="uniform_smallint.html#idp223818368-bb"><span class="identifier">a</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">result_type</span> <a class="link" href="uniform_smallint.html#idp223819936-bb"><span class="identifier">b</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">result_type</span> <a class="link" href="uniform_smallint.html#idp223821504-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">result_type</span> <a class="link" href="uniform_smallint.html#idp223823072-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="uniform_smallint/param_type.html" title="Class param_type">param_type</a> <a class="link" href="uniform_smallint.html#idp223824640-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="uniform_smallint.html#idp108688752-bb"><span class="identifier">param</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint/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">void</span> <a class="link" href="uniform_smallint.html#idp108691184-bb"><span class="identifier">reset</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> Engine<span class="special">></span> <span class="identifier">result_type</span> <a class="link" href="uniform_smallint.html#idp108692544-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">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Engine<span class="special">></span> - <span class="identifier">result_type</span> <a class="link" href="uniform_smallint.html#id1294221-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">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="uniform_smallint/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">result_type</span> <a class="link" href="uniform_smallint.html#idp108695664-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">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="uniform_smallint/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="uniform_smallint.html#id1294317-bb">friend functions</a></span> + <span class="comment">// <a class="link" href="uniform_smallint.html#idp154310224-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="uniform_smallint.html#id1294321-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> + <a class="link" href="uniform_smallint.html#idp154310784-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="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</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="uniform_smallint.html#id1294364-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> + <a class="link" href="uniform_smallint.html#idp154315792-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="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</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="uniform_smallint.html#id1294406-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</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="uniform_smallint.html#id1294438-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</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="uniform_smallint.html#idp93799632-bb"><span class="keyword">operator</span><span class="special">==</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</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="uniform_smallint.html#idp93803264-bb"><span class="keyword">operator</span><span class="special">!=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="id3135645"></a><h2>Description</h2> -<p>The distribution function <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a> models a <a class="link" href="../../boost_random/reference.html#boost_random.reference.concepts.random_distribution" title="Random Distribution">random distribution</a> . On each invocation, it returns a random integer value uniformly distributed in the set of integer numbers {min, min+1, min+2, ..., max}. It assumes that the desired range (max-min+1) is small compared to the range of the underlying source of random numbers and thus makes no attempt to limit quantization errors.</p> -<p>Let <span class="inlinemediaobject"><img src="../../images/random/form_19.png"></span> the desired range of integer numbers, and let <span class="inlinemediaobject"><img src="../../images/random/form_20.png"></span> be the range of the underlying source of random numbers. Then, for the uniform distribution, the theoretical probability for any number i in the range <span class="inlinemediaobject"><img src="../../images/random/form_21.png"></span> will be <span class="inlinemediaobject"><img src="../../images/random/form_22.png"></span>. Likewise, assume a uniform distribution on <span class="inlinemediaobject"><img src="../../images/random/form_20.png"></span> for the underlying source of random numbers, i.e. <span class="inlinemediaobject"><img src="../../images/random/form_23.png"></span>. Let <span class="inlinemediaobject"><img src="../../images/random/form_24.png"></span> denote the random distribution generated by <code class="computeroutput"><a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a></code>. Then the sum over all i in <span class="inlinemediaobject"><img src="../../images/random/form_21.png"></span> of <span class="inlinemediaobject"><img src="../../images/random/form_25.png"></span> shall not exceed <span class="inlinemediaobject"><img src="../../images/random/form_26.png"></span>.</p> +<a name="idp417133520"></a><h2>Description</h2> +<p>The distribution function <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a> models a <a class="link" href="../../boost_random/reference.html#boost_random.reference.concepts.random_distribution" title="Random Distribution">random distribution</a> . On each invocation, it returns a random integer value uniformly distributed in the set of integer numbers {min, min+1, min+2, ..., max}. It assumes that the desired range (max-min+1) is small compared to the range of the underlying source of random numbers and thus makes no attempt to limit quantization errors.</p> +<p>Let <span class="inlinemediaobject"><img src="../../images/random//form_21.png"></span> the desired range of integer numbers, and let <span class="inlinemediaobject"><img src="../../images/random//form_22.png"></span> be the range of the underlying source of random numbers. Then, for the uniform distribution, the theoretical probability for any number i in the range <span class="inlinemediaobject"><img src="../../images/random//form_23.png"></span> will be <span class="inlinemediaobject"><img src="../../images/random//form_24.png"></span>. Likewise, assume a uniform distribution on <span class="inlinemediaobject"><img src="../../images/random//form_22.png"></span> for the underlying source of random numbers, i.e. <span class="inlinemediaobject"><img src="../../images/random//form_25.png"></span>. Let <span class="inlinemediaobject"><img src="../../images/random//form_26.png"></span> denote the random distribution generated by <code class="computeroutput"><a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a></code>. Then the sum over all i in <span class="inlinemediaobject"><img src="../../images/random//form_23.png"></span> of <span class="inlinemediaobject"><img src="../../images/random//form_27.png"></span> shall not exceed <span class="inlinemediaobject"><img src="../../images/random//form_28.png"></span>.</p> <p>The template parameter IntType shall denote an integer-like value type.</p> <p> </p> <div class="note"><table border="0" summary="Note"> @@ -102,94 +102,94 @@ <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> <th align="left">Note</th> </tr> -<tr><td align="left" valign="top"><p> The property above is the square sum of the relative differences in probabilities between the desired uniform distribution <span class="inlinemediaobject"><img src="../../images/random/form_27.png"></span> and the generated distribution <span class="inlinemediaobject"><img src="../../images/random/form_24.png"></span>. The property can be fulfilled with the calculation <span class="inlinemediaobject"><img src="../../images/random/form_28.png"></span>, as follows: Let <span class="inlinemediaobject"><img src="../../images/random/form_29.png"></span>. The base distribution on <span class="inlinemediaobject"><img src="../../images/random/form_20.png"></span> is folded onto the range <span class="inlinemediaobject"><img src="../../images/random/form_21.png"></span>. The numbers i < r have assigned <span class="inlinemediaobject"><img src="../../images/random/form_30.png"></span> numbers of the base distribution, the rest has only <span class="inlinemediaobject"><img src="../../images/random/form_31.png"></span>. Therefore, <span class="inlinemediaobject"><img src="../../images/random/form_32.png"></span> for i < r and <span class="inlinemediaobject"><img src="../../images/random/form_33.png"></span> otherwise. Substituting this in the above sum formula leads to the desired result. </p></td></tr> +<tr><td align="left" valign="top"><p> The property above is the square sum of the relative differences in probabilities between the desired uniform distribution <span class="inlinemediaobject"><img src="../../images/random//form_29.png"></span> and the generated distribution <span class="inlinemediaobject"><img src="../../images/random//form_26.png"></span>. The property can be fulfilled with the calculation <span class="inlinemediaobject"><img src="../../images/random//form_30.png"></span>, as follows: Let <span class="inlinemediaobject"><img src="../../images/random//form_31.png"></span>. The base distribution on <span class="inlinemediaobject"><img src="../../images/random//form_22.png"></span> is folded onto the range <span class="inlinemediaobject"><img src="../../images/random//form_23.png"></span>. The numbers i < r have assigned <span class="inlinemediaobject"><img src="../../images/random//form_32.png"></span> numbers of the base distribution, the rest has only <span class="inlinemediaobject"><img src="../../images/random//form_33.png"></span>. Therefore, <span class="inlinemediaobject"><img src="../../images/random//form_34.png"></span> for i < r and <span class="inlinemediaobject"><img src="../../images/random//form_35.png"></span> otherwise. Substituting this in the above sum formula leads to the desired result. </p></td></tr> </table></div> <p> </p> -<p>Note: The upper bound for <span class="inlinemediaobject"><img src="../../images/random/form_34.png"></span> is <span class="inlinemediaobject"><img src="../../images/random/form_35.png"></span>. Regarding the upper bound for the square sum of the relative quantization error of <span class="inlinemediaobject"><img src="../../images/random/form_36.png"></span>, it seems wise to either choose <span class="inlinemediaobject"><img src="../../images/random/form_20.png"></span> so that <span class="inlinemediaobject"><img src="../../images/random/form_37.png"></span> or ensure that <span class="inlinemediaobject"><img src="../../images/random/form_20.png"></span> is divisible by <span class="inlinemediaobject"><img src="../../images/random/form_21.png"></span>. </p> +<p>Note: The upper bound for <span class="inlinemediaobject"><img src="../../images/random//form_36.png"></span> is <span class="inlinemediaobject"><img src="../../images/random//form_37.png"></span>. Regarding the upper bound for the square sum of the relative quantization error of <span class="inlinemediaobject"><img src="../../images/random//form_38.png"></span>, it seems wise to either choose <span class="inlinemediaobject"><img src="../../images/random//form_22.png"></span> so that <span class="inlinemediaobject"><img src="../../images/random//form_39.png"></span> or ensure that <span class="inlinemediaobject"><img src="../../images/random//form_22.png"></span> is divisible by <span class="inlinemediaobject"><img src="../../images/random//form_23.png"></span>. </p> <div class="refsect2"> -<a name="id3136294"></a><h3> +<a name="idp417207328"></a><h3> <a name="boost.random.uniform_smallintconstruct-copy-destruct"></a><code class="computeroutput">uniform_smallint</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="id1294255-bb"></a><span class="identifier">uniform_smallint</span><span class="special">(</span><span class="identifier">IntType</span> min <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">IntType</span> max <span class="special">=</span> <span class="number">9</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp108700096-bb"></a><span class="identifier">uniform_smallint</span><span class="special">(</span><span class="identifier">IntType</span> min <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">IntType</span> max <span class="special">=</span> <span class="number">9</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a></code></code>. <code class="computeroutput">min</code> and <code class="computeroutput">max</code> are the lower and upper bounds of the output range, respectively. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="id1294293-bb"></a><span class="identifier">uniform_smallint</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> param<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp154307248-bb"></a><span class="identifier">uniform_smallint</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint/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>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a></code></code> from its parameters. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="id3136484"></a><h3> -<a name="id1294098-bb"></a><code class="computeroutput">uniform_smallint</code> public member functions</h3> +<a name="idp417230352"></a><h3> +<a name="idp223817808-bb"></a><code class="computeroutput">uniform_smallint</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="identifier">result_type</span> <a name="id1294102-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> +<pre class="literallayout"><span class="identifier">result_type</span> <a name="idp223818368-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> <p>Returns the minimum value of the distribution. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">result_type</span> <a name="id1294114-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> +<pre class="literallayout"><span class="identifier">result_type</span> <a name="idp223819936-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> <p>Returns the maximum value of the distribution. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">result_type</span> <a name="id1294125-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> +<pre class="literallayout"><span class="identifier">result_type</span> <a name="idp223821504-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> <p>Returns the minimum value of the distribution. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">result_type</span> <a name="id1294137-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> +<pre class="literallayout"><span class="identifier">result_type</span> <a name="idp223823072-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> <p>Returns the maximum value of the distribution. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="uniform_smallint/param_type.html" title="Class param_type">param_type</a> <a name="id1294149-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> +<pre class="literallayout"><a class="link" href="uniform_smallint/param_type.html" title="Class param_type">param_type</a> <a name="idp223824640-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> <p>Returns the parameters of the distribution. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="id1294162-bb"></a><span class="identifier">param</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> param<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp108688752-bb"></a><span class="identifier">param</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint/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>Sets the parameters of the distribution. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="id1294183-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp108691184-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: Subsequent uses of the distribution do not depend on values produced by any engine prior to invoking reset. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Engine<span class="special">></span> <span class="identifier">result_type</span> <a name="id1294196-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">&</span> eng<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Engine<span class="special">></span> <span class="identifier">result_type</span> <a name="idp108692544-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">&</span> eng<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a value uniformly distributed in the range [min(), max()]. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Engine<span class="special">></span> - <span class="identifier">result_type</span> <a name="id1294221-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">&</span> eng<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="uniform_smallint/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> param<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> + <span class="identifier">result_type</span> <a name="idp108695664-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">&</span> eng<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="uniform_smallint/param_type.html" title="Class param_type">param_type</a> <span class="special">&</span> param<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a value uniformly distributed in the range [param.a(), param.b()]. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="id3137010"></a><h3> -<a name="id1294317-bb"></a><code class="computeroutput">uniform_smallint</code> friend functions</h3> +<a name="idp417294320"></a><h3> +<a name="idp154310224-bb"></a><code class="computeroutput">uniform_smallint</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="id1294321-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> + <a name="idp154310784-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="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&</span> ud<span class="special">)</span><span class="special">;</span></pre> <p>Writes the distribution 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="id1294364-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> + <a name="idp154315792-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="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&</span> ud<span class="special">)</span><span class="special">;</span></pre> <p>Reads the distribution 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="id1294406-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&</span> lhs<span class="special">,</span> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp93799632-bb"></a><span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&</span> lhs<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> <p>Returns true if the two distributions will produce identical sequences of values given equal generators. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="id1294438-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&</span> lhs<span class="special">,</span> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">bool</span> <a name="idp93803264-bb"></a><span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&</span> lhs<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="uniform_smallint.html" title="Class template uniform_smallint">uniform_smallint</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> <p>Returns true if the two distributions may produce different sequences of values given equal generators. </p> </li> |