884b61aa3ffc7bff04720b8e0cb054101831cf90
[platform/upstream/boost.git] / doc / html / boost_random.html
1 <html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Chapter&#160;24.&#160;Boost.Random</title>
5 <link rel="stylesheet" href="../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
8 <link rel="up" href="libraries.html" title="Part&#160;I.&#160;The Boost C++ Libraries (BoostBook Subset)">
9 <link rel="prev" href="proto/appendices.html" title="Appendices">
10 <link rel="next" href="boost_random/tutorial.html" title="Tutorial">
11 </head>
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>
20 </tr></table>
21 <hr>
22 <div class="spirit-nav">
23 <a accesskey="p" href="proto/appendices.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="libraries.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="boost_random/tutorial.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
24 </div>
25 <div class="chapter">
26 <div class="titlepage"><div>
27 <div><h2 class="title">
28 <a name="boost_random"></a>Chapter&#160;24.&#160;Boost.Random</h2></div>
29 <div><div class="author"><h3 class="author">
30 <span class="firstname">Jens</span> <span class="surname">Maurer</span>
31 </h3></div></div>
32 <div><p class="copyright">Copyright &#169; 2000-2005 Jens Maurer</p></div>
33 <div><p class="copyright">Copyright &#169; 2009, 2010 Steven Watanabe</p></div>
34 <div><div class="legalnotice">
35 <a name="boost_random.legal"></a><p>
36         Distributed under the Boost Software License, Version 1.0. (See accompanying
37         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>)
38       </p>
39 </div></div>
40 </div></div>
41 <div class="toc">
42 <p><b>Table of Contents</b></p>
43 <dl class="toc">
44 <dt><span class="section"><a href="boost_random.html#boost_random.introduction">Introduction</a></span></dt>
45 <dt><span class="section"><a href="boost_random/tutorial.html">Tutorial</a></span></dt>
46 <dd><dl>
47 <dt><span class="section"><a href="boost_random/tutorial.html#boost_random.tutorial.generating_integers_in_a_range">Generating
48       integers in a range</a></span></dt>
49 <dt><span class="section"><a href="boost_random/tutorial.html#boost_random.tutorial.generating_integers_with_different_probabilities">Generating
50       integers with different probabilities</a></span></dt>
51 <dt><span class="section"><a href="boost_random/tutorial.html#boost_random.tutorial.generating_a_random_password">Generating
52       a random password</a></span></dt>
53 </dl></dd>
54 <dt><span class="section"><a href="boost_random/reference.html">Reference</a></span></dt>
55 <dd><dl>
56 <dt><span class="section"><a href="boost_random/reference.html#boost_random.reference.concepts">Concepts</a></span></dt>
57 <dt><span class="section"><a href="boost_random/reference.html#boost_random.reference.generators">Generators</a></span></dt>
58 <dt><span class="section"><a href="boost_random/reference.html#boost_random.reference.distributions">Distributions</a></span></dt>
59 <dt><span class="section"><a href="boost_random/reference.html#headers">Headers</a></span></dt>
60 </dl></dd>
61 <dt><span class="section"><a href="boost_random/performance.html">Performance</a></span></dt>
62 <dt><span class="section"><a href="boost_random/history_and_acknowledgements.html">History and
63     Acknowledgements</a></span></dt>
64 </dl>
65 </div>
66 <div class="section">
67 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
68 <a name="boost_random.introduction"></a><a class="link" href="boost_random.html#boost_random.introduction" title="Introduction">Introduction</a>
69 </h2></div></div></div>
70 <p>
71       Random numbers are useful in a variety of applications. The Boost Random Number
72       Library (Boost.Random for short) provides a variety of <a class="link" href="boost_random/reference.html#boost_random.reference.generators" title="Generators">generators</a>
73       and <a class="link" href="boost_random/reference.html#boost_random.reference.distributions" title="Distributions">distributions</a>
74       to produce random numbers having useful properties, such as uniform distribution.
75     </p>
76 <p>
77       You should read the <a class="link" href="boost_random/reference.html#boost_random.reference.concepts" title="Concepts">concepts
78       documentation</a> for an introduction and the definition of the basic concepts.
79       For a quick start, it may be sufficient to have a look at <a href="../../libs/random/example/random_demo.cpp" target="_top">random_demo.cpp</a>.
80     </p>
81 <p>
82       For a very quick start, here's an example:
83     </p>
84 <pre class="programlisting"><code class="computeroutput"><a class="link" href="boost/random/mt19937.html" title="Type definition mt19937">boost::random::mt19937</a></code> <span class="identifier">rng</span><span class="special">;</span>         <span class="comment">// produces randomness out of thin air</span>
85                                     <span class="comment">// see pseudo-random number generators</span>
86 <code class="computeroutput"><a class="link" href="boost/random/uniform_int_distribution.html" title="Class template uniform_int_distribution">boost::random::uniform_int_distribution</a></code>&lt;&gt; <span class="identifier">six</span><span class="special">(</span><span class="number">1</span><span class="special">,</span><span class="number">6</span><span class="special">);</span>
87                                     <span class="comment">// distribution that maps to 1..6</span>
88                                     <span class="comment">// see random number distributions</span>
89 <span class="keyword">int</span> <span class="identifier">x</span> <span class="special">=</span> <span class="identifier">six</span><span class="special">(</span><span class="identifier">rng</span><span class="special">);</span>                   <span class="comment">// simulate rolling a die</span>
90 </pre>
91 </div>
92 </div>
93 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
94 <td align="left"><p><small>Last revised: October 30, 2014 at 10:20:46 GMT</small></p></td>
95 <td align="right"><div class="copyright-footer"></div></td>
96 </tr></table>
97 <hr>
98 <div class="spirit-nav">
99 <a accesskey="p" href="proto/appendices.html"><img src="../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="libraries.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="boost_random/tutorial.html"><img src="../../doc/src/images/next.png" alt="Next"></a>
100 </div>
101 </body>
102 </html>