-
Notifications
You must be signed in to change notification settings - Fork 58
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Link new Boost.Random documentation into the main doc build and remov…
…e the old html git-svn-id: http://svn.boost.org/svn/boost/trunk@60172 b8fc166d-592f-0410-95f2-cb63ce0dd405
- Loading branch information
steven_watanabe
committed
Mar 5, 2010
1 parent
b1fb666
commit b77e8da
Showing
13 changed files
with
38 additions
and
7,184 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> | ||
| <html> | ||
| <head> | ||
| <!-- Copyright (C) 2002 Douglas Gregor <doug.gregor -at- gmail.com> | ||
| Distributed under the Boost Software License, Version 1.0. | ||
| (See accompanying file LICENSE_1_0.txt or copy at | ||
| http://www.boost.org/LICENSE_1_0.txt) --> | ||
| <title>Redirect to generated documentation</title> | ||
| <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/boost_random.html"> | ||
| </head> | ||
| <body> | ||
| Automatic redirection failed, please go to | ||
| <a href="http://boost-sandbox.sourceforge.net/doc/html/boost_random.html">http://boost-sandbox.sourceforge.net/doc/html/boost_random.html</a> | ||
| </body> | ||
| </html> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,209 +1,14 @@ | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> | ||
|
|
||
| <html> | ||
| <head> | ||
| <meta http-equiv="Content-Language" content="en-us"> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> | ||
|
|
||
| <title>Boost Random Number Library</title> | ||
| </head> | ||
|
|
||
| <body bgcolor="#FFFFFF" text="#000000"> | ||
| <table border="1" bgcolor="#007F7F" cellpadding="2" summary=""> | ||
| <tr> | ||
| <td bgcolor="#FFFFFF"><img src="../../boost.png" alt= | ||
| "boost.png (6897 bytes)" width="277" height="86"></td> | ||
|
|
||
| <td><a href="../../index.htm"><font face="Arial,Helvetica" color= | ||
| "#FFFFFF"><big>Home</big></font></a></td> | ||
|
|
||
| <td><a href="../libraries.htm"><font face="Arial,Helvetica" color= | ||
| "#FFFFFF"><big>Libraries</big></font></a></td> | ||
|
|
||
| <td><a href="http://www.boost.org/people/people.htm"><font face="Arial,Helvetica" | ||
| color="#FFFFFF"><big>People</big></font></a></td> | ||
|
|
||
| <td><a href="http://www.boost.org/more/faq.htm"><font face="Arial,Helvetica" color= | ||
| "#FFFFFF"><big>FAQ</big></font></a></td> | ||
|
|
||
| <td><a href="../../more/index.htm"><font face="Arial,Helvetica" color= | ||
| "#FFFFFF"><big>More</big></font></a></td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <h1>Boost Random Number Library</h1> | ||
|
|
||
| <p>Random numbers are useful in a variety of applications. The Boost Random | ||
| Number Library (Boost.Random for short) provides a vast variety of | ||
| generators and distributions to produce random numbers having useful | ||
| properties, such as uniform distribution.</p> | ||
|
|
||
| <p>You should read the <a href="random-concepts.html">concepts | ||
| documentation</a> for an introduction and the definition of the basic | ||
| concepts. For a quick start, it may be sufficient to have a look at | ||
| <a href="random_demo.cpp">random_demo.cpp</a>.</p> | ||
|
|
||
| <p>For a very quick start, here's an example:</p> | ||
| <pre> | ||
| boost::mt19937 rng; // produces randomness out of thin air | ||
| // see pseudo-random number generators | ||
| boost::uniform_int<> six(1,6); // distribution that maps to 1..6 | ||
| // see random number distributions | ||
| boost::variate_generator<boost::mt19937&, boost::uniform_int<> > | ||
| die(rng, six); // glues randomness with mapping | ||
| int x = die(); // simulate rolling a die | ||
| </pre> | ||
|
|
||
| <h2>Library Organization</h2> | ||
|
|
||
| <p>The library is separated into several header files, all within the | ||
| <code>boost/random/</code> directory. Additionally, a convenience header | ||
| file which includes all other headers in <code>boost/random/</code> is | ||
| available as <code><a href= | ||
| "../../boost/random.hpp">boost/random.hpp</a></code>.</p> | ||
|
|
||
| <p>A front-end class template called <code>variate_generator</code> is | ||
| provided; please read the <a href="random-variate.html">documentation</a> | ||
| about it.</p> | ||
|
|
||
| <ul> | ||
| <li><code><a href= | ||
| "../../boost/random/variate_generator.hpp">boost/random/variate_generator.hpp</a></code></li> | ||
| </ul>Several random number generators are available in the following header | ||
| files; please read the <a href="random-generators.html">documentation</a> | ||
| about these. | ||
|
|
||
| <ul> | ||
| <li><code><a href= | ||
| "../../boost/random/linear_congruential.hpp">boost/random/linear_congruential.hpp</a></code></li> | ||
|
|
||
| <li><code><a href= | ||
| "../../boost/random/additive_combine.hpp">boost/random/additive_combine.hpp</a></code></li> | ||
|
|
||
| <li><code><a href= | ||
| "../../boost/random/inversive_congruential.hpp">boost/random/inversive_congruential.hpp</a></code></li> | ||
|
|
||
| <li><code><a href= | ||
| "../../boost/random/shuffle_output.hpp">boost/random/shuffle_output.hpp</a></code></li> | ||
|
|
||
| <li><code><a href= | ||
| "../../boost/random/mersenne_twister.hpp">boost/random/mersenne_twister.hpp</a></code></li> | ||
|
|
||
| <li><code><a href= | ||
| "../../boost/random/lagged_fibonacci.hpp">boost/random/lagged_fibonacci.hpp</a></code></li> | ||
| </ul>Similarly, several random number distributions are available in the | ||
| following header files; please read the <a href= | ||
| "random-distributions.html">documentation</a> about these. | ||
|
|
||
| <ul> | ||
| <li><code><a href= | ||
| "../../boost/random/uniform_smallint.hpp">boost/random/uniform_smallint.hpp</a></code></li> | ||
|
|
||
| <li><code><a href= | ||
| "../../boost/random/uniform_int.hpp">boost/random/uniform_int.hpp</a></code></li> | ||
|
|
||
| <li><code><a href= | ||
| "../../boost/random/uniform_01.hpp">boost/random/uniform_01.hpp</a></code></li> | ||
|
|
||
| <li><code><a href= | ||
| "../../boost/random/uniform_real.hpp">boost/random/uniform_real.hpp</a></code></li> | ||
|
|
||
| <li><code><a href= | ||
| "../../boost/random/triangle_distribution.hpp">boost/random/triangle_distribution.hpp</a></code></li> | ||
|
|
||
| <li><code><a href= | ||
| "../../boost/random/bernoulli_distribution.hpp">boost/random/bernoulli_distribution.hpp</a></code></li> | ||
|
|
||
| <li><code><a href= | ||
| "../../boost/random/cauchy_distribution.hpp">boost/random/cauchy_distribution.hpp</a></code></li> | ||
|
|
||
| <li><code><a href= | ||
| "../../boost/random/exponential_distribution.hpp">boost/random/exponential_distribution.hpp</a></code></li> | ||
|
|
||
| <li><code><a href= | ||
| "../../boost/random/geometric_distribution.hpp">boost/random/geometric_distribution.hpp</a></code></li> | ||
|
|
||
| <li><code><a href= | ||
| "../../boost/random/normal_distribution.hpp">boost/random/normal_distribution.hpp</a></code></li> | ||
|
|
||
| <li><code><a href= | ||
| "../../boost/random/lognormal_distribution.hpp">boost/random/lognormal_distribution.hpp</a></code></li> | ||
|
|
||
| <li><code><a href= | ||
| "../../boost/random/uniform_on_sphere.hpp">boost/random/uniform_on_sphere.hpp</a></code></li> | ||
| </ul>Additionally, non-deterministic random number generators are available | ||
| in the header <code><a href= | ||
| "../../boost/nondet_random.hpp"><boost/nondet_random.hpp></a></code>. | ||
| <a href="nondet_random.html">Documentation</a> is also available. | ||
|
|
||
| <p>In order to map the interface of the generators and distribution | ||
| functions to other concepts, some <a href="random-misc.html">decorators</a> | ||
| are available.</p> | ||
|
|
||
| <h2>Tests</h2> | ||
|
|
||
| <p>An extensive test suite for the pseudo-random number generators and | ||
| distributions is available as <a href= | ||
| "random_test.cpp">random_test.cpp</a>.</p> | ||
|
|
||
| <p>Some <a href="random-performance.html">performance results</a> obtained | ||
| using <a href="random_speed.cpp">random_speed.cpp</a> are also | ||
| available.</p> | ||
|
|
||
| <h2>Rationale</h2> | ||
|
|
||
| <p>The methods for generating and evaluating deterministic and | ||
| non-deterministic random numbers differ radically. Furthermore, due to the | ||
| inherent deterministic design of present-day computers, it is often | ||
| difficult to implement non-deterministic random number generation | ||
| facilities. Thus, the random number library is split into separate header | ||
| files, mirroring the two different application domains.</p> | ||
|
|
||
| <h2>History and Acknowledgements</h2> | ||
|
|
||
| <p>In November 1999, Jeet Sukumaran proposed a framework based on virtual | ||
| functions, and later sketched a template-based approach. Ed Brey pointed | ||
| out that Microsoft Visual C++ does not support in-class member | ||
| initializations and suggested the <code>enum</code> workaround. Dave | ||
| Abrahams highlighted quantization issues.</p> | ||
|
|
||
| <p>The first public release of this random number library materialized in | ||
| March 2000 after extensive discussions on the boost mailing list. Many | ||
| thanks to Beman Dawes for his original <code>min_rand</code> class, | ||
| portability fixes, documentation suggestions, and general guidance. Harry | ||
| Erwin sent a header file which provided additional insight into the | ||
| requirements. Ed Brey and Beman Dawes wanted an iterator-like | ||
| interface.</p> | ||
|
|
||
| <p>Beman Dawes managed the formal review, during which Matthias Troyer, | ||
| Csaba Szepesvari, and Thomas Holenstein gave detailed comments. The | ||
| reviewed version became an official part of boost on 17 June 2000.</p> | ||
|
|
||
| <p>Gary Powell contributed suggestions for code cleanliness. Dave Abrahams | ||
| and Howard Hinnant suggested to move the basic generator templates from | ||
| namespace <code>boost::detail</code> to <code>boost::random</code>.</p> | ||
|
|
||
| <p>Ed Brey asked to remove superfluous warnings and helped with | ||
| <code>uint64_t</code> handling. Andreas Scherer tested with MSVC. Matthias | ||
| Troyer contributed a lagged Fibonacci generator. Michael Stevens found a | ||
| bug in the copy semantics of normal_distribution and suggested | ||
| documentation improvements.</p> | ||
| <hr> | ||
|
|
||
| <p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src= | ||
| "../../doc/images/valid-html401.png" alt="Valid HTML 4.01 Transitional" | ||
| height="31" width="88"></a></p> | ||
|
|
||
| <p>Revised | ||
| <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->05 | ||
| December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38516" --></p> | ||
|
|
||
| <p><i>Copyright © 2000-2005 <a href= | ||
| "http://www.boost.org/people/jens_maurer.htm">Jens Maurer</a></i></p> | ||
|
|
||
| <p><i>Distributed under the Boost Software License, Version 1.0. (See | ||
| accompanying file <a href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or | ||
| copy at <a href= | ||
| "http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p> | ||
| </body> | ||
| <head> | ||
| <meta http-equiv="refresh" content="0; URL=../../doc/html/boost_random.html"> | ||
| </head> | ||
| <body> | ||
| Automatic redirection failed, please go to | ||
| <a href="../../doc/html/boost_random.html">../../doc/html/boost_random.html</a> | ||
| <p>Copyright (c) 2010 Steven Watanabe</p> | ||
| <p>Distributed under the Boost Software License, Version 1.0. (See accompanying file | ||
| <a href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or copy at | ||
| <a href="http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>). | ||
| </p> | ||
| </body> | ||
| </html> |
Oops, something went wrong.