• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html>
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5<title>Class template uniform_01</title>
6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9<link rel="up" href="../../boost_random/reference.html#header.boost.random.uniform_01_hpp" title="Header &lt;boost/random/uniform_01.hpp&gt;">
10<link rel="prev" href="triangle_distribution/param_type.html" title="Class param_type">
11<link rel="next" href="uniform_int_distribution.html" title="Class template uniform_int_distribution">
12</head>
13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14<table cellpadding="2" width="100%"><tr>
15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
16<td align="center"><a href="../../../../index.html">Home</a></td>
17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20<td align="center"><a href="../../../../more/index.htm">More</a></td>
21</tr></table>
22<hr>
23<div class="spirit-nav">
24<a accesskey="p" href="triangle_distribution/param_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.uniform_01_hpp"><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="uniform_int_distribution.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.random.uniform_01"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Class template uniform_01</span></h2>
30<p>boost::random::uniform_01</p>
31</div>
32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
33<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_random/reference.html#header.boost.random.uniform_01_hpp" title="Header &lt;boost/random/uniform_01.hpp&gt;">boost/random/uniform_01.hpp</a>&gt;
34
35</span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RealType <span class="special">=</span> <span class="keyword">double</span><span class="special">&gt;</span>
36<span class="keyword">class</span> <a class="link" href="uniform_01.html" title="Class template uniform_01">uniform_01</a> <span class="special">{</span>
37<span class="keyword">public</span><span class="special">:</span>
38  <span class="comment">// types</span>
39  <span class="keyword">typedef</span> <span class="identifier">RealType</span> <a name="boost.random.uniform_01.input_type"></a><span class="identifier">input_type</span><span class="special">;</span>
40  <span class="keyword">typedef</span> <span class="identifier">RealType</span> <a name="boost.random.uniform_01.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>
41
42  <span class="comment">// <a class="link" href="uniform_01.html#id-1_3_34_5_6_45_1_1_1_5-bb">public member functions</a></span>
43  <span class="identifier">result_type</span> <a class="link" href="uniform_01.html#id-1_3_34_5_6_45_1_1_1_5_1-bb"><span class="identifier">min</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
44  <span class="identifier">result_type</span> <a class="link" href="uniform_01.html#id-1_3_34_5_6_45_1_1_1_5_2-bb"><span class="identifier">max</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
45  <span class="keyword">void</span> <a class="link" href="uniform_01.html#id-1_3_34_5_6_45_1_1_1_5_3-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
46  <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Engine<span class="special">&gt;</span> <span class="identifier">result_type</span> <a class="link" href="uniform_01.html#id-1_3_34_5_6_45_1_1_1_5_4-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">&amp;</span><span class="special">)</span><span class="special">;</span>
47<span class="special">}</span><span class="special">;</span></pre></div>
48<div class="refsect1">
49<a name="id-1.3.34.5.6.44.3.4"></a><h2>Description</h2>
50<p>The distribution function <a class="link" href="uniform_01.html" title="Class template uniform_01">uniform_01</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 floating-point value uniformly distributed in the range [0..1).</p>
51<p>The template parameter RealType shall denote a float-like value type with support for binary operators +, -, and /.</p>
52<p>Note: The current implementation is buggy, because it may not fill all of the mantissa with random bits. I'm unsure how to fill a (to-be-invented) <code class="computeroutput">boost::bigfloat</code> class with random bits efficiently. It's probably time for a traits class. </p>
53<div class="refsect2">
54<a name="id-1.3.34.5.6.44.3.4.5"></a><h3>
55<a name="id-1_3_34_5_6_45_1_1_1_5-bb"></a><code class="computeroutput">uniform_01</code> public member functions</h3>
56<div class="orderedlist"><ol class="orderedlist" type="1">
57<li class="listitem"><pre class="literallayout"><span class="identifier">result_type</span> <a name="id-1_3_34_5_6_45_1_1_1_5_1-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></li>
58<li class="listitem"><pre class="literallayout"><span class="identifier">result_type</span> <a name="id-1_3_34_5_6_45_1_1_1_5_2-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></li>
59<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_34_5_6_45_1_1_1_5_3-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
60<li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Engine<span class="special">&gt;</span> <span class="identifier">result_type</span> <a name="id-1_3_34_5_6_45_1_1_1_5_4-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">&amp;</span> eng<span class="special">)</span><span class="special">;</span></pre></li>
61</ol></div>
62</div>
63</div>
64</div>
65<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
66<td align="left"></td>
67<td align="right"><div class="copyright-footer">Copyright © 2000-2005 Jens Maurer<br>Copyright © 2009, 2010 Steven Watanabe<p>
68        Distributed under the Boost Software License, Version 1.0. (See accompanying
69        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>)
70      </p>
71</div></td>
72</tr></table>
73<hr>
74<div class="spirit-nav">
75<a accesskey="p" href="triangle_distribution/param_type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random/reference.html#header.boost.random.uniform_01_hpp"><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="uniform_int_distribution.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
76</div>
77</body>
78</html>
79