|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r64249 - in sandbox/SOC/2010/quasi_random: boost/random libs/random/doc/html libs/random/doc/html/boost/random libs/random/doc/html/boost_random_quasi_random_number_generators_extension
From: jvd_at_[hidden]
Date: 2010-07-22 04:32:05
Author: qrng
Date: 2010-07-22 04:32:03 EDT (Thu, 22 Jul 2010)
New Revision: 64249
URL: http://svn.boost.org/trac/boost/changeset/64249
Log:
Fixed mysterious problems with Doxygen.
Text files modified:
sandbox/SOC/2010/quasi_random/boost/random/faure.hpp | 6 +-
sandbox/SOC/2010/quasi_random/boost/random/sobol.hpp | 9 ++-
sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost/random/faure.html | 91 ++++++++++++++++++++++++---------------
sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost/random/niederreiter_base2.html | 80 +++++++++++++++++-----------------
sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost/random/sobol.html | 83 ++++++++++++++++++++++--------------
sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost_random_quasi_random_number_generators_extension/reference.html | 54 +++++++++++++++++------
sandbox/SOC/2010/quasi_random/libs/random/doc/html/index.html | 4
7 files changed, 195 insertions(+), 132 deletions(-)
Modified: sandbox/SOC/2010/quasi_random/boost/random/faure.hpp
==============================================================================
--- sandbox/SOC/2010/quasi_random/boost/random/faure.hpp (original)
+++ sandbox/SOC/2010/quasi_random/boost/random/faure.hpp 2010-07-22 04:32:03 EDT (Thu, 22 Jul 2010)
@@ -30,7 +30,7 @@
namespace boost {
namespace random {
-/** @cond */
+/// @cond
namespace detail {
namespace fr {
@@ -226,7 +226,7 @@
};
}} // namespace detail::fr
-/** @endcond */
+/// @endcond
//!class template faure implements a quasi-random number generator as described in
//! \blockquote
@@ -250,7 +250,7 @@
//!In the following documentation @c X denotes the concrete class of the template
//!faure returning objects of type @c RealType, u and v are the values of @c X.
//!
-//!Some member functions may throw exceptions of type @c std::bad_alloc.
+//!Some member functions may throw exceptions of type @c std::bad_alloc and @c std::overflow_error.
template<typename RealType, std::size_t Dimension>
class faure : public detail::qrng_base<
faure<RealType, Dimension>,
Modified: sandbox/SOC/2010/quasi_random/boost/random/sobol.hpp
==============================================================================
--- sandbox/SOC/2010/quasi_random/boost/random/sobol.hpp (original)
+++ sandbox/SOC/2010/quasi_random/boost/random/sobol.hpp 2010-07-22 04:32:03 EDT (Thu, 22 Jul 2010)
@@ -14,9 +14,8 @@
#include <boost/random/detail/operators.hpp>
#include <limits>
-#include <boost/integer/static_log2.hpp>
-
#include <boost/cstdint.hpp>
+#include <boost/integer/static_log2.hpp>
#include <boost/static_assert.hpp>
@@ -31,8 +30,9 @@
namespace boost {
namespace random {
-/** @cond */
+/// @cond
namespace detail {
+
namespace sbl {
// Primitive polynomials in binary encoding
@@ -293,7 +293,8 @@
};
} // namespace detail
-/** @endcond */
+/// @endcond
+
//!class template sobol implements a quasi-random number generator as described in
//! \blockquote
Modified: sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost/random/faure.html
==============================================================================
--- sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost/random/faure.html (original)
+++ sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost/random/faure.html 2010-07-22 04:32:03 EDT (Thu, 22 Jul 2010)
@@ -31,25 +31,32 @@
<span class="bold"><strong>typedef</strong></span> RealType <a name="boost.random.faure.result_type"></a>result_type;
<span class="emphasis"><em>// <a class="link" href="faure.html#boost.random.faureconstruct-copy-destruct">construct/copy/destruct</a></em></span>
- <a class="link" href="faure.html#id2721811-bb">faure</a>();
- <a class="link" href="faure.html#id2721819-bb">faure</a>(std::size_t);
+ <a class="link" href="faure.html#id2422170-bb">faure</a>();
+ <a class="link" href="faure.html#id2422178-bb">faure</a>(std::size_t);
- <span class="emphasis"><em>// <a class="link" href="faure.html#id2722145-bb">public static functions</a></em></span>
- <span class="type"><span class="bold"><strong>static</strong></span> result_type min</span> <a class="link" href="faure.html#id2722148-bb">BOOST_PREVENT_MACRO_SUBSTITUTION</a>() ;
- <span class="type"><span class="bold"><strong>static</strong></span> result_type max</span> <a class="link" href="faure.html#id2722164-bb">BOOST_PREVENT_MACRO_SUBSTITUTION</a>() ;
- <span class="type"><span class="bold"><strong>static</strong></span> std::size_t</span> <a class="link" href="faure.html#id2722182-bb">dimension</a>() ;
+ <span class="emphasis"><em>// <a class="link" href="faure.html#id2422457-bb">friend functions</a></em></span>
+ <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> CharT, <span class="bold"><strong>typename</strong></span> Traits>
+ <span class="type"><span class="bold"><strong>friend</strong></span> std::basic_ostream< CharT, Traits > &</span>
+ <a class="link" href="faure.html#id2422460-bb"><span class="bold"><strong>operator</strong></span><<</a>(std::basic_ostream< CharT, Traits > &, <span class="bold"><strong>const</strong></span> <a class="link" href="faure.html" title="Class template faure">faure</a> &) ;
+ <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> CharT, <span class="bold"><strong>typename</strong></span> Traits>
+ <span class="type"><span class="bold"><strong>friend</strong></span> std::basic_istream< CharT, Traits > &</span>
+ <a class="link" href="faure.html#id2422501-bb"><span class="bold"><strong>operator</strong></span>>></a>(std::basic_istream< CharT, Traits > &, <a class="link" href="faure.html" title="Class template faure">faure</a> &) ;
+ <span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a class="link" href="faure.html#id2421966-bb"><span class="bold"><strong>operator</strong></span>==</a>(<span class="bold"><strong>const</strong></span> <a class="link" href="faure.html" title="Class template faure">faure</a> &, <span class="bold"><strong>const</strong></span> <a class="link" href="faure.html" title="Class template faure">faure</a> &) ;
+ <span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a class="link" href="faure.html#id2421992-bb"><span class="bold"><strong>operator</strong></span>!=</a>(<span class="bold"><strong>const</strong></span> <a class="link" href="faure.html" title="Class template faure">faure</a> &, <span class="bold"><strong>const</strong></span> <a class="link" href="faure.html" title="Class template faure">faure</a> &) ;
- <span class="emphasis"><em>// <a class="link" href="faure.html#id2722197-bb">public member functions</a></em></span>
- <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="faure.html#id2722201-bb">seed</a>() ;
- <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="faure.html#id2722219-bb">seed</a>(std::size_t) ;
- <span class="type">result_type</span> <a class="link" href="faure.html#id2721673-bb"><span class="bold"><strong>operator</strong></span>()</a>() ;
- <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="faure.html#id2721693-bb">discard</a>(std::size_t) ;
- <span class="type"></span> <a class="link" href="faure.html#id2721722-bb">BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR</a>(os, <a class="link" href="faure.html" title="Class template faure">faure</a>, f) ;
- <span class="type"></span> <a class="link" href="faure.html#id2721753-bb">BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR</a>(is, <a class="link" href="faure.html" title="Class template faure">faure</a>, f) ;
- <span class="type"></span> <a class="link" href="faure.html#id2721785-bb">BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR</a>(<a class="link" href="faure.html" title="Class template faure">faure</a>, x, y) ;
+ <span class="emphasis"><em>// <a class="link" href="faure.html#id2422020-bb">public static functions</a></em></span>
+ <span class="type"><span class="bold"><strong>static</strong></span> result_type</span> <a class="link" href="faure.html#id2422023-bb">min</a>() ;
+ <span class="type"><span class="bold"><strong>static</strong></span> result_type</span> <a class="link" href="faure.html#id2422039-bb">max</a>() ;
+ <span class="type"><span class="bold"><strong>static</strong></span> std::size_t</span> <a class="link" href="faure.html#id2422055-bb">dimension</a>() ;
+
+ <span class="emphasis"><em>// <a class="link" href="faure.html#id2422071-bb">public member functions</a></em></span>
+ <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="faure.html#id2422074-bb">seed</a>() ;
+ <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="faure.html#id2422092-bb">seed</a>(std::size_t) ;
+ <span class="type">result_type</span> <a class="link" href="faure.html#id2422122-bb"><span class="bold"><strong>operator</strong></span>()</a>() ;
+ <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="faure.html#id2422141-bb">discard</a>(std::size_t) ;
};</pre></div>
<div class="refsect1" lang="en">
-<a name="id3097217"></a><h2>Description</h2>
+<a name="id2688431"></a><h2>Description</h2>
<p>class template faure implements a quasi-random number generator as described in </p>
<div class="blockquote"><blockquote class="blockquote"><p> Henri Faure, Discrepance de suites associees a un systeme de numeration (en dimension s), Acta Arithmetica, Volume 41, 1982, pages 337-351. </p></blockquote></div>
<p> </p>
@@ -57,45 +64,63 @@
<p> </p>
<p>
In the following documentation <code class="computeroutput">X</code> denotes the concrete class of the template faure returning objects of type <code class="computeroutput">RealType</code>, u and v are the values of <code class="computeroutput">X</code>.</p>
-<p>Some member functions may throw exceptions of type <code class="computeroutput">std::bad_alloc</code>. </p>
+<p>Some member functions may throw exceptions of type <code class="computeroutput">std::bad_alloc</code> and <code class="computeroutput">std::overflow_error</code>. </p>
<div class="refsect2" lang="en">
-<a name="id3097268"></a><h3>
+<a name="id2688486"></a><h3>
<a name="boost.random.faureconstruct-copy-destruct"></a><code class="computeroutput">faure</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1">
<li>
-<pre class="literallayout"><a name="id2721811-bb"></a>faure();</pre>
+<pre class="literallayout"><a name="id2422170-bb"></a>faure();</pre>
<p>Effects: Constructs the default Faure quasi-random number generator.</p>
<p>Throws: bad_alloc. </p>
</li>
<li>
-<pre class="literallayout"><a name="id2721819-bb"></a>faure(std::size_t init);</pre>
+<pre class="literallayout"><a name="id2422178-bb"></a>faure(std::size_t init);</pre>
<p>Effects: Constructs the Faure quasi-random number generator, equivalent to X u; u.seed(init).</p>
<p>Throws: bad_alloc. </p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
-<a name="id3097324"></a><h3>
-<a name="id2722145-bb"></a><code class="computeroutput">faure</code> public static functions</h3>
+<a name="id2688542"></a><h3>
+<a name="id2422457-bb"></a><code class="computeroutput">faure</code> friend functions</h3>
+<div class="orderedlist"><ol type="1">
+<li>
+<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> CharT, <span class="bold"><strong>typename</strong></span> Traits>
+ <span class="type"><span class="bold"><strong>friend</strong></span> std::basic_ostream< CharT, Traits > &</span>
+ <a name="id2422460-bb"></a><span class="bold"><strong>operator</strong></span><<(std::basic_ostream< CharT, Traits > & os, <span class="bold"><strong>const</strong></span> <a class="link" href="faure.html" title="Class template faure">faure</a> & f) ;</pre>Writes a <code class="computeroutput">faure</code> to a <code class="computeroutput">std::ostream</code>. </li>
+<li>
+<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> CharT, <span class="bold"><strong>typename</strong></span> Traits>
+ <span class="type"><span class="bold"><strong>friend</strong></span> std::basic_istream< CharT, Traits > &</span>
+ <a name="id2422501-bb"></a><span class="bold"><strong>operator</strong></span>>>(std::basic_istream< CharT, Traits > & is, <a class="link" href="faure.html" title="Class template faure">faure</a> & f) ;</pre>Reads a <code class="computeroutput">faure</code> from a <code class="computeroutput">std::istream</code>. </li>
+<li>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a name="id2421966-bb"></a><span class="bold"><strong>operator</strong></span>==(<span class="bold"><strong>const</strong></span> <a class="link" href="faure.html" title="Class template faure">faure</a> & x, <span class="bold"><strong>const</strong></span> <a class="link" href="faure.html" title="Class template faure">faure</a> & y) ;</pre>Returns true if the two generators will produce identical sequences. </li>
+<li>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a name="id2421992-bb"></a><span class="bold"><strong>operator</strong></span>!=(<span class="bold"><strong>const</strong></span> <a class="link" href="faure.html" title="Class template faure">faure</a> & lhs, <span class="bold"><strong>const</strong></span> <a class="link" href="faure.html" title="Class template faure">faure</a> & rhs) ;</pre>Returns true if the two generators will produce different sequences,. </li>
+</ol></div>
+</div>
+<div class="refsect2" lang="en">
+<a name="id2688775"></a><h3>
+<a name="id2422020-bb"></a><code class="computeroutput">faure</code> public static functions</h3>
<div class="orderedlist"><ol type="1">
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> result_type min</span> <a name="id2722148-bb"></a>BOOST_PREVENT_MACRO_SUBSTITUTION() ;</pre>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> result_type</span> <a name="id2422023-bb"></a>min() ;</pre>
<p>Returns: Tight lower bound on the set of values returned by operator().</p>
<p>Throws: nothing. </p>
<p>
</p>
</li>
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> result_type max</span> <a name="id2722164-bb"></a>BOOST_PREVENT_MACRO_SUBSTITUTION() ;</pre>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> result_type</span> <a name="id2422039-bb"></a>max() ;</pre>
<p>Returns: Tight upper bound on the set of values returned by operator().</p>
<p>Throws: nothing. </p>
<p>
</p>
</li>
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> std::size_t</span> <a name="id2722182-bb"></a>dimension() ;</pre>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> std::size_t</span> <a name="id2422055-bb"></a>dimension() ;</pre>
<p>Returns: The dimension of of the quasi-random domain.</p>
<p>Throws: nothing. </p>
<p>
@@ -104,18 +129,18 @@
</ol></div>
</div>
<div class="refsect2" lang="en">
-<a name="id3097418"></a><h3>
-<a name="id2722197-bb"></a><code class="computeroutput">faure</code> public member functions</h3>
+<a name="id2688869"></a><h3>
+<a name="id2422071-bb"></a><code class="computeroutput">faure</code> public member functions</h3>
<div class="orderedlist"><ol type="1">
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2722201-bb"></a>seed() ;</pre>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2422074-bb"></a>seed() ;</pre>
<p>Requirements: *this is mutable.</p>
<p>Effects: Resets the quasi-random number generator state to the one given by the default construction. Equivalent to u.seed(0). </p>
<p>
Throws: bad_alloc. </p>
</li>
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2722219-bb"></a>seed(std::size_t init) ;</pre>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2422092-bb"></a>seed(std::size_t init) ;</pre>
<p>Requirements: *this is mutable.</p>
<p>Effects: Effectively sets the quasi-random number generator state to the init-th vector in the s-dimensional quasi-random domain, where s == X::dimension(). </p>
<pre class="programlisting"> X u, v;
@@ -130,13 +155,13 @@
Throws: bad_alloc. </p>
</li>
<li>
-<pre class="literallayout"><span class="type">result_type</span> <a name="id2721673-bb"></a><span class="bold"><strong>operator</strong></span>()() ;</pre>
+<pre class="literallayout"><span class="type">result_type</span> <a name="id2422122-bb"></a><span class="bold"><strong>operator</strong></span>()() ;</pre>
<p>Requirements: *this is mutable.</p>
<p>Returns: Returns a successive element of an s-dimensional (s = X::dimension()) vector at each invocation. When all elements are exhausted, X::operator() begins anew with the starting element of a subsequent s-dimensional vector.</p>
<p>Throws: bad_alloc. </p>
</li>
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2721693-bb"></a>discard(std::size_t z) ;</pre>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2422141-bb"></a>discard(std::size_t z) ;</pre>
<p>Requirements: *this is mutable.</p>
<p>Effects: Advances *this state as if z consecutive X::operator() invocations were executed. </p>
<pre class="programlisting"> X u = v;
@@ -149,12 +174,6 @@
<p>
Throws: bad_alloc. </p>
</li>
-<li>
-<pre class="literallayout"><span class="type"></span> <a name="id2721722-bb"></a>BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR(os, <a class="link" href="faure.html" title="Class template faure">faure</a>, f) ;</pre>Writes a <code class="computeroutput">faure</code> to a <code class="computeroutput">std::ostream</code>. </li>
-<li>
-<pre class="literallayout"><span class="type"></span> <a name="id2721753-bb"></a>BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR(is, <a class="link" href="faure.html" title="Class template faure">faure</a>, f) ;</pre>Reads a <code class="computeroutput">faure</code> from a <code class="computeroutput">std::istream</code>. </li>
-<li>
-<pre class="literallayout"><span class="type"></span> <a name="id2721785-bb"></a>BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR(<a class="link" href="faure.html" title="Class template faure">faure</a>, x, y) ;</pre>Returns true if the two generators will produce identical sequences. </li>
</ol></div>
</div>
</div>
Modified: sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost/random/niederreiter_base2.html
==============================================================================
--- sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost/random/niederreiter_base2.html (original)
+++ sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost/random/niederreiter_base2.html 2010-07-22 04:32:03 EDT (Thu, 22 Jul 2010)
@@ -7,13 +7,13 @@
<link rel="start" href="../../index.html" title="Chapter 1. Boost.Random Quasi-random number generators extension">
<link rel="up" href="../../boost_random_quasi_random_number_generators_extension/reference.html#header.boost.random.niederreiter_base2_hpp" title="Header <boost/random/niederreiter_base2.hpp>">
<link rel="prev" href="faure.html" title="Class template faure">
-<link rel="next" href="sobol.html" title="Class template sobol">
+<link rel="next" href="min.html" title="Function min">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="faure.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random_quasi_random_number_generators_extension/reference.html#header.boost.random.niederreiter_base2_hpp"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="sobol.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="faure.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random_quasi_random_number_generators_extension/reference.html#header.boost.random.niederreiter_base2_hpp"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="min.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" lang="en">
<a name="boost.random.niederreiter_base2"></a><div class="titlepage"></div>
@@ -31,35 +31,35 @@
<span class="bold"><strong>typedef</strong></span> IntType <a name="boost.random.niederreiter_base2.result_type"></a>result_type;
<span class="emphasis"><em>// <a class="link" href="niederreiter_base2.html#boost.random.niederreiter_base2construct-copy-destruct">construct/copy/destruct</a></em></span>
- <a class="link" href="niederreiter_base2.html#id2724473-bb">niederreiter_base2</a>();
- <a class="link" href="niederreiter_base2.html#id2724481-bb">niederreiter_base2</a>(std::size_t);
+ <a class="link" href="niederreiter_base2.html#id2424868-bb">niederreiter_base2</a>();
+ <a class="link" href="niederreiter_base2.html#id2424876-bb">niederreiter_base2</a>(std::size_t);
- <span class="emphasis"><em>// <a class="link" href="niederreiter_base2.html#id2722008-bb">public static functions</a></em></span>
- <span class="type"><span class="bold"><strong>static</strong></span> result_type</span> <a class="link" href="niederreiter_base2.html#id2722012-bb">min</a>() ;
- <span class="type"><span class="bold"><strong>static</strong></span> result_type</span> <a class="link" href="niederreiter_base2.html#id2722026-bb">max</a>() ;
- <span class="type"><span class="bold"><strong>static</strong></span> std::size_t</span> <a class="link" href="niederreiter_base2.html#id2722039-bb">dimension</a>() ;
+ <span class="emphasis"><em>// <a class="link" href="niederreiter_base2.html#id2422368-bb">public static functions</a></em></span>
+ <span class="type"><span class="bold"><strong>static</strong></span> result_type</span> <a class="link" href="niederreiter_base2.html#id2422371-bb">min</a>() ;
+ <span class="type"><span class="bold"><strong>static</strong></span> result_type</span> <a class="link" href="niederreiter_base2.html#id2422385-bb">max</a>() ;
+ <span class="type"><span class="bold"><strong>static</strong></span> std::size_t</span> <a class="link" href="niederreiter_base2.html#id2424757-bb">dimension</a>() ;
- <span class="emphasis"><em>// <a class="link" href="niederreiter_base2.html#id2722053-bb">public member functions</a></em></span>
- <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="niederreiter_base2.html#id2722057-bb">seed</a>() ;
- <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="niederreiter_base2.html#id2722074-bb">seed</a>(std::size_t) ;
- <span class="type">result_type</span> <a class="link" href="niederreiter_base2.html#id2724427-bb"><span class="bold"><strong>operator</strong></span>()</a>() ;
- <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="niederreiter_base2.html#id2724447-bb">discard</a>(std::size_t) ;
+ <span class="emphasis"><em>// <a class="link" href="niederreiter_base2.html#id2424770-bb">public member functions</a></em></span>
+ <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="niederreiter_base2.html#id2424774-bb">seed</a>() ;
+ <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="niederreiter_base2.html#id2424791-bb">seed</a>(std::size_t) ;
+ <span class="type">result_type</span> <a class="link" href="niederreiter_base2.html#id2424821-bb"><span class="bold"><strong>operator</strong></span>()</a>() ;
+ <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="niederreiter_base2.html#id2424841-bb">discard</a>(std::size_t) ;
- <span class="emphasis"><em>// <a class="link" href="niederreiter_base2.html#id2724495-bb">friend functions</a></em></span>
+ <span class="emphasis"><em>// <a class="link" href="niederreiter_base2.html#id2424890-bb">friend functions</a></em></span>
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> CharT, <span class="bold"><strong>typename</strong></span> Traits>
<span class="type"><span class="bold"><strong>friend</strong></span> std::basic_ostream< CharT, Traits > &</span>
- <a class="link" href="niederreiter_base2.html#id2724498-bb"><span class="bold"><strong>operator</strong></span><<</a>(std::basic_ostream< CharT, Traits > &,
+ <a class="link" href="niederreiter_base2.html#id2424893-bb"><span class="bold"><strong>operator</strong></span><<</a>(std::basic_ostream< CharT, Traits > &,
<span class="bold"><strong>const</strong></span> <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &) ;
<span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> CharT, <span class="bold"><strong>typename</strong></span> Traits>
<span class="type"><span class="bold"><strong>friend</strong></span> std::basic_istream< CharT, Traits > &</span>
- <a class="link" href="niederreiter_base2.html#id2724540-bb"><span class="bold"><strong>operator</strong></span>>></a>(std::basic_istream< CharT, Traits > &, <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &) ;
- <span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a class="link" href="niederreiter_base2.html#id2724580-bb"><span class="bold"><strong>operator</strong></span>==</a>(<span class="bold"><strong>const</strong></span> <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &,
+ <a class="link" href="niederreiter_base2.html#id2424933-bb"><span class="bold"><strong>operator</strong></span>>></a>(std::basic_istream< CharT, Traits > &, <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &) ;
+ <span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a class="link" href="niederreiter_base2.html#id2424974-bb"><span class="bold"><strong>operator</strong></span>==</a>(<span class="bold"><strong>const</strong></span> <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &,
<span class="bold"><strong>const</strong></span> <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &) ;
- <span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a class="link" href="niederreiter_base2.html#id2724608-bb"><span class="bold"><strong>operator</strong></span>!=</a>(<span class="bold"><strong>const</strong></span> <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &,
+ <span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a class="link" href="niederreiter_base2.html#id2425001-bb"><span class="bold"><strong>operator</strong></span>!=</a>(<span class="bold"><strong>const</strong></span> <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &,
<span class="bold"><strong>const</strong></span> <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &) ;
};</pre></div>
<div class="refsect1" lang="en">
-<a name="id3098220"></a><h2>Description</h2>
+<a name="id2689588"></a><h2>Description</h2>
<p>class template niederreiter_base2 implements a quasi-random number generator as described in </p>
<div class="blockquote"><blockquote class="blockquote"><p> Bratley, Fox, Niederreiter, ACM Trans. Model. Comp. Sim. 2, 195 (1992). </p></blockquote></div>
<p> </p>
@@ -67,54 +67,54 @@
In the following documentation <code class="computeroutput">X</code> denotes the concrete class of the template niederreiter_base2 returning objects of type <code class="computeroutput">IntType</code>, u and v are the values of <code class="computeroutput">X</code>.</p>
<p>Some member functions may throw exceptions of type std::overflow_error. This happens when the quasi-random domain is exhausted and the generator cannot produce any more values. The length of the low discrepancy sequence is given by <span class="inlinemediaobject"><img src="../../images/random/form_0.png"></span>, where digits = std::numeric_limits<IntType>::digits. </p>
<div class="refsect2" lang="en">
-<a name="id3098280"></a><h3>
+<a name="id2689648"></a><h3>
<a name="boost.random.niederreiter_base2construct-copy-destruct"></a><code class="computeroutput">niederreiter_base2</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1">
<li>
-<pre class="literallayout"><a name="id2724473-bb"></a>niederreiter_base2();</pre>
+<pre class="literallayout"><a name="id2424868-bb"></a>niederreiter_base2();</pre>
<p>Effects: Constructs the default Niederreiter base 2 quasi-random number generator.</p>
<p>Throws: nothing. </p>
</li>
<li>
-<pre class="literallayout"><a name="id2724481-bb"></a>niederreiter_base2(std::size_t init);</pre>
+<pre class="literallayout"><a name="id2424876-bb"></a>niederreiter_base2(std::size_t init);</pre>
<p>Effects: Constructs the Niederreiter base 2 quasi-random number generator, equivalent to X u; u.seed(init).</p>
<p>Throws: overflow_error. </p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
-<a name="id3098334"></a><h3>
-<a name="id2722008-bb"></a><code class="computeroutput">niederreiter_base2</code> public static functions</h3>
+<a name="id2689702"></a><h3>
+<a name="id2422368-bb"></a><code class="computeroutput">niederreiter_base2</code> public static functions</h3>
<div class="orderedlist"><ol type="1">
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> result_type</span> <a name="id2722012-bb"></a>min() ;</pre>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> result_type</span> <a name="id2422371-bb"></a>min() ;</pre>
<p>Returns: Tight lower bound on the set of values returned by operator().</p>
<p>Throws: nothing. </p>
</li>
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> result_type</span> <a name="id2722026-bb"></a>max() ;</pre>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> result_type</span> <a name="id2422385-bb"></a>max() ;</pre>
<p>Returns: Tight upper bound on the set of values returned by operator().</p>
<p>Throws: nothing. </p>
</li>
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> std::size_t</span> <a name="id2722039-bb"></a>dimension() ;</pre>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> std::size_t</span> <a name="id2424757-bb"></a>dimension() ;</pre>
<p>Returns: The dimension of of the quasi-random domain.</p>
<p>Throws: nothing. </p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
-<a name="id3098422"></a><h3>
-<a name="id2722053-bb"></a><code class="computeroutput">niederreiter_base2</code> public member functions</h3>
+<a name="id2689790"></a><h3>
+<a name="id2424770-bb"></a><code class="computeroutput">niederreiter_base2</code> public member functions</h3>
<div class="orderedlist"><ol type="1">
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2722057-bb"></a>seed() ;</pre>Throws: nothing. <p>Requirements: *this is mutable.</p>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2424774-bb"></a>seed() ;</pre>Throws: nothing. <p>Requirements: *this is mutable.</p>
<p>Effects: Resets the quasi-random number generator state to the one given by the default construction. Equivalent to u.seed(0). </p>
</li>
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2722074-bb"></a>seed(std::size_t init) ;</pre>Throws: overflow_error. <p>Requirements: *this is mutable.</p>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2424791-bb"></a>seed(std::size_t init) ;</pre>Throws: overflow_error. <p>Requirements: *this is mutable.</p>
<p>Effects: Effectively sets the quasi-random number generator state to the init-th vector in the s-dimensional quasi-random domain, where s == X::dimension(). </p>
<pre class="programlisting"> X u, v;
for(int i = 0; i < N; ++i)
@@ -126,13 +126,13 @@
<p> </p>
</li>
<li>
-<pre class="literallayout"><span class="type">result_type</span> <a name="id2724427-bb"></a><span class="bold"><strong>operator</strong></span>()() ;</pre>
+<pre class="literallayout"><span class="type">result_type</span> <a name="id2424821-bb"></a><span class="bold"><strong>operator</strong></span>()() ;</pre>
<p>Requirements: *this is mutable.</p>
<p>Returns: Returns a successive element of an s-dimensional (s = X::dimension()) vector at each invocation. When all elements are exhausted, X::operator() begins anew with the starting element of a subsequent s-dimensional vector.</p>
<p>Throws: overflow_error. </p>
</li>
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2724447-bb"></a>discard(std::size_t z) ;</pre>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2424841-bb"></a>discard(std::size_t z) ;</pre>
<p>Requirements: *this is mutable.</p>
<p>Effects: Advances *this state as if z consecutive X::operator() invocations were executed. </p>
<pre class="programlisting"> X u = v;
@@ -146,23 +146,23 @@
</ol></div>
</div>
<div class="refsect2" lang="en">
-<a name="id3098564"></a><h3>
-<a name="id2724495-bb"></a><code class="computeroutput">niederreiter_base2</code> friend functions</h3>
+<a name="id2689932"></a><h3>
+<a name="id2424890-bb"></a><code class="computeroutput">niederreiter_base2</code> friend functions</h3>
<div class="orderedlist"><ol type="1">
<li>
<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> CharT, <span class="bold"><strong>typename</strong></span> Traits>
<span class="type"><span class="bold"><strong>friend</strong></span> std::basic_ostream< CharT, Traits > &</span>
- <a name="id2724498-bb"></a><span class="bold"><strong>operator</strong></span><<(std::basic_ostream< CharT, Traits > & os,
+ <a name="id2424893-bb"></a><span class="bold"><strong>operator</strong></span><<(std::basic_ostream< CharT, Traits > & os,
<span class="bold"><strong>const</strong></span> <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> & f) ;</pre>Writes a <code class="computeroutput">niederreiter_base2</code> to a <code class="computeroutput">std::ostream</code>. </li>
<li>
<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> CharT, <span class="bold"><strong>typename</strong></span> Traits>
<span class="type"><span class="bold"><strong>friend</strong></span> std::basic_istream< CharT, Traits > &</span>
- <a name="id2724540-bb"></a><span class="bold"><strong>operator</strong></span>>>(std::basic_istream< CharT, Traits > & is, <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> & f) ;</pre>Reads a <code class="computeroutput">niederreiter_base2</code> from a <code class="computeroutput">std::istream</code>. </li>
+ <a name="id2424933-bb"></a><span class="bold"><strong>operator</strong></span>>>(std::basic_istream< CharT, Traits > & is, <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> & f) ;</pre>Reads a <code class="computeroutput">niederreiter_base2</code> from a <code class="computeroutput">std::istream</code>. </li>
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a name="id2724580-bb"></a><span class="bold"><strong>operator</strong></span>==(<span class="bold"><strong>const</strong></span> <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> & x,
+<pre class="literallayout"><span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a name="id2424974-bb"></a><span class="bold"><strong>operator</strong></span>==(<span class="bold"><strong>const</strong></span> <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> & x,
<span class="bold"><strong>const</strong></span> <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> & y) ;</pre>Returns true if the two generators will produce identical sequences. </li>
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a name="id2724608-bb"></a><span class="bold"><strong>operator</strong></span>!=(<span class="bold"><strong>const</strong></span> <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> & lhs,
+<pre class="literallayout"><span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a name="id2425001-bb"></a><span class="bold"><strong>operator</strong></span>!=(<span class="bold"><strong>const</strong></span> <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> & lhs,
<span class="bold"><strong>const</strong></span> <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> & rhs) ;</pre>Returns true if the two generators will produce different sequences,. </li>
</ol></div>
</div>
@@ -178,7 +178,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="faure.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random_quasi_random_number_generators_extension/reference.html#header.boost.random.niederreiter_base2_hpp"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="sobol.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="faure.html"><img src="../../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_random_quasi_random_number_generators_extension/reference.html#header.boost.random.niederreiter_base2_hpp"><img src="../../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="min.html"><img src="../../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
Modified: sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost/random/sobol.html
==============================================================================
--- sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost/random/sobol.html (original)
+++ sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost/random/sobol.html 2010-07-22 04:32:03 EDT (Thu, 22 Jul 2010)
@@ -30,25 +30,32 @@
<span class="bold"><strong>typedef</strong></span> IntType <a name="boost.random.sobol.result_type"></a>result_type;
<span class="emphasis"><em>// <a class="link" href="sobol.html#boost.random.sobolconstruct-copy-destruct">construct/copy/destruct</a></em></span>
- <a class="link" href="sobol.html#id2725073-bb">sobol</a>();
- <a class="link" href="sobol.html#id2725080-bb">sobol</a>(std::size_t);
+ <a class="link" href="sobol.html#id2620099-bb">sobol</a>();
+ <a class="link" href="sobol.html#id2620107-bb">sobol</a>(std::size_t);
- <span class="emphasis"><em>// <a class="link" href="sobol.html#id2724824-bb">public static functions</a></em></span>
- <span class="type"><span class="bold"><strong>static</strong></span> result_type min</span> <a class="link" href="sobol.html#id2724827-bb">BOOST_PREVENT_MACRO_SUBSTITUTION</a>() ;
- <span class="type"><span class="bold"><strong>static</strong></span> result_type max</span> <a class="link" href="sobol.html#id2724844-bb">BOOST_PREVENT_MACRO_SUBSTITUTION</a>() ;
- <span class="type"><span class="bold"><strong>static</strong></span> std::size_t</span> <a class="link" href="sobol.html#id2724862-bb">dimension</a>() ;
+ <span class="emphasis"><em>// <a class="link" href="sobol.html#id2619944-bb">public static functions</a></em></span>
+ <span class="type"><span class="bold"><strong>static</strong></span> result_type</span> <a class="link" href="sobol.html#id2619948-bb">min</a>() ;
+ <span class="type"><span class="bold"><strong>static</strong></span> result_type</span> <a class="link" href="sobol.html#id2619964-bb">max</a>() ;
+ <span class="type"><span class="bold"><strong>static</strong></span> std::size_t</span> <a class="link" href="sobol.html#id2619980-bb">dimension</a>() ;
- <span class="emphasis"><em>// <a class="link" href="sobol.html#id2724877-bb">public member functions</a></em></span>
- <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="sobol.html#id2724881-bb">seed</a>() ;
- <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="sobol.html#id2724901-bb">seed</a>(std::size_t) ;
- <span class="type">result_type</span> <a class="link" href="sobol.html#id2724933-bb"><span class="bold"><strong>operator</strong></span>()</a>() ;
- <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="sobol.html#id2724952-bb">discard</a>(std::size_t) ;
- <span class="type"></span> <a class="link" href="sobol.html#id2724981-bb">BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR</a>(os, <a class="link" href="sobol.html" title="Class template sobol">sobol</a>, f) ;
- <span class="type"></span> <a class="link" href="sobol.html#id2725013-bb">BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR</a>(is, <a class="link" href="sobol.html" title="Class template sobol">sobol</a>, f) ;
- <span class="type"></span> <a class="link" href="sobol.html#id2725046-bb">BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR</a>(<a class="link" href="sobol.html" title="Class template sobol">sobol</a>, x, y) ;
+ <span class="emphasis"><em>// <a class="link" href="sobol.html#id2619995-bb">public member functions</a></em></span>
+ <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="sobol.html#id2619999-bb">seed</a>() ;
+ <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="sobol.html#id2620019-bb">seed</a>(std::size_t) ;
+ <span class="type">result_type</span> <a class="link" href="sobol.html#id2620051-bb"><span class="bold"><strong>operator</strong></span>()</a>() ;
+ <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="sobol.html#id2620071-bb">discard</a>(std::size_t) ;
+
+ <span class="emphasis"><em>// <a class="link" href="sobol.html#id2620121-bb">friend functions</a></em></span>
+ <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> CharT, <span class="bold"><strong>typename</strong></span> Traits>
+ <span class="type"><span class="bold"><strong>friend</strong></span> std::basic_ostream< CharT, Traits > &</span>
+ <a class="link" href="sobol.html#id2620124-bb"><span class="bold"><strong>operator</strong></span><<</a>(std::basic_ostream< CharT, Traits > &, <span class="bold"><strong>const</strong></span> <a class="link" href="sobol.html" title="Class template sobol">sobol</a> &) ;
+ <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> CharT, <span class="bold"><strong>typename</strong></span> Traits>
+ <span class="type"><span class="bold"><strong>friend</strong></span> std::basic_istream< CharT, Traits > &</span>
+ <a class="link" href="sobol.html#id2620166-bb"><span class="bold"><strong>operator</strong></span>>></a>(std::basic_istream< CharT, Traits > &, <a class="link" href="sobol.html" title="Class template sobol">sobol</a> &) ;
+ <span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a class="link" href="sobol.html#id2620206-bb"><span class="bold"><strong>operator</strong></span>==</a>(<span class="bold"><strong>const</strong></span> <a class="link" href="sobol.html" title="Class template sobol">sobol</a> &, <span class="bold"><strong>const</strong></span> <a class="link" href="sobol.html" title="Class template sobol">sobol</a> &) ;
+ <span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a class="link" href="sobol.html#id2620233-bb"><span class="bold"><strong>operator</strong></span>!=</a>(<span class="bold"><strong>const</strong></span> <a class="link" href="sobol.html" title="Class template sobol">sobol</a> &, <span class="bold"><strong>const</strong></span> <a class="link" href="sobol.html" title="Class template sobol">sobol</a> &) ;
};</pre></div>
<div class="refsect1" lang="en">
-<a name="id3099219"></a><h2>Description</h2>
+<a name="id2639508"></a><h2>Description</h2>
<p>class template sobol implements a quasi-random number generator as described in </p>
<div class="blockquote"><blockquote class="blockquote"><p> [Bratley+Fox, TOMS 14, 88 (1988)] and [Antonov+Saleev, USSR Comput. Maths. Math. Phys. 19, 252 (1980)] </p></blockquote></div>
<p> </p>
@@ -56,43 +63,43 @@
In the following documentation <code class="computeroutput">X</code> denotes the concrete class of the template sobol returning objects of type <code class="computeroutput">IntType</code>, u and v are the values of <code class="computeroutput">X</code>.</p>
<p>Some member functions may throw exceptions of type <code class="computeroutput">std::overflow_error</code>. This happens when the quasi-random domain is exhausted and the generator cannot produce any more values. The length of the low discrepancy sequence is given by <span class="inlinemediaobject"><img src="../../images/random/form_1.png"></span>, where digits = std::numeric_limits<IntType>::digits. </p>
<div class="refsect2" lang="en">
-<a name="id3099285"></a><h3>
+<a name="id2639573"></a><h3>
<a name="boost.random.sobolconstruct-copy-destruct"></a><code class="computeroutput">sobol</code>
public
construct/copy/destruct</h3>
<div class="orderedlist"><ol type="1">
<li>
-<pre class="literallayout"><a name="id2725073-bb"></a>sobol();</pre>
+<pre class="literallayout"><a name="id2620099-bb"></a>sobol();</pre>
<p>Effects: Constructs the default Sobol quasi-random number generator.</p>
<p>Throws: nothing. </p>
</li>
<li>
-<pre class="literallayout"><a name="id2725080-bb"></a>sobol(std::size_t init);</pre>
+<pre class="literallayout"><a name="id2620107-bb"></a>sobol(std::size_t init);</pre>
<p>Effects: Constructs the Sobol quasi-random number generator, equivalent to X u; u.seed(init).</p>
<p>Throws: overflow_error. </p>
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
-<a name="id3099338"></a><h3>
-<a name="id2724824-bb"></a><code class="computeroutput">sobol</code> public static functions</h3>
+<a name="id2639626"></a><h3>
+<a name="id2619944-bb"></a><code class="computeroutput">sobol</code> public static functions</h3>
<div class="orderedlist"><ol type="1">
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> result_type min</span> <a name="id2724827-bb"></a>BOOST_PREVENT_MACRO_SUBSTITUTION() ;</pre>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> result_type</span> <a name="id2619948-bb"></a>min() ;</pre>
<p>Returns: Tight lower bound on the set of values returned by operator().</p>
<p>Throws: nothing. </p>
<p>
</p>
</li>
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> result_type max</span> <a name="id2724844-bb"></a>BOOST_PREVENT_MACRO_SUBSTITUTION() ;</pre>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> result_type</span> <a name="id2619964-bb"></a>max() ;</pre>
<p>Returns: Tight upper bound on the set of values returned by operator().</p>
<p>Throws: nothing. </p>
<p>
</p>
</li>
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> std::size_t</span> <a name="id2724862-bb"></a>dimension() ;</pre>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>static</strong></span> std::size_t</span> <a name="id2619980-bb"></a>dimension() ;</pre>
<p>Returns: The dimension of of the quasi-random domain.</p>
<p>Throws: nothing. </p>
<p>
@@ -101,11 +108,11 @@
</ol></div>
</div>
<div class="refsect2" lang="en">
-<a name="id3099433"></a><h3>
-<a name="id2724877-bb"></a><code class="computeroutput">sobol</code> public member functions</h3>
+<a name="id2639721"></a><h3>
+<a name="id2619995-bb"></a><code class="computeroutput">sobol</code> public member functions</h3>
<div class="orderedlist"><ol type="1">
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2724881-bb"></a>seed() ;</pre>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2619999-bb"></a>seed() ;</pre>
<p>Throws: nothing. </p>
<p>Requirements: *this is mutable.</p>
<p>Effects: Resets the quasi-random number generator state to the one given by the default construction. Equivalent to u.seed(0). </p>
@@ -113,7 +120,7 @@
</p>
</li>
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2724901-bb"></a>seed(std::size_t init) ;</pre>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2620019-bb"></a>seed(std::size_t init) ;</pre>
<p>Throws: overflow_error. </p>
<p>Requirements: *this is mutable.</p>
<p>Effects: Effectively sets the quasi-random number generator state to the init-th vector in the s-dimensional quasi-random domain, where s == X::dimension(). </p>
@@ -129,13 +136,13 @@
</p>
</li>
<li>
-<pre class="literallayout"><span class="type">result_type</span> <a name="id2724933-bb"></a><span class="bold"><strong>operator</strong></span>()() ;</pre>
+<pre class="literallayout"><span class="type">result_type</span> <a name="id2620051-bb"></a><span class="bold"><strong>operator</strong></span>()() ;</pre>
<p>Requirements: *this is mutable.</p>
<p>Returns: Returns a successive element of an s-dimensional (s = X::dimension()) vector at each invocation. When all elements are exhausted, X::operator() begins anew with the starting element of a subsequent s-dimensional vector.</p>
<p>Throws: overflow_error. </p>
</li>
<li>
-<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2724952-bb"></a>discard(std::size_t z) ;</pre>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>void</strong></span></span> <a name="id2620071-bb"></a>discard(std::size_t z) ;</pre>
<p>Requirements: *this is mutable.</p>
<p>Effects: Advances *this state as if z consecutive X::operator() invocations were executed. </p>
<pre class="programlisting"> X u = v;
@@ -148,12 +155,24 @@
<p>
</p>
</li>
+</ol></div>
+</div>
+<div class="refsect2" lang="en">
+<a name="id2639871"></a><h3>
+<a name="id2620121-bb"></a><code class="computeroutput">sobol</code> friend functions</h3>
+<div class="orderedlist"><ol type="1">
+<li>
+<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> CharT, <span class="bold"><strong>typename</strong></span> Traits>
+ <span class="type"><span class="bold"><strong>friend</strong></span> std::basic_ostream< CharT, Traits > &</span>
+ <a name="id2620124-bb"></a><span class="bold"><strong>operator</strong></span><<(std::basic_ostream< CharT, Traits > & os, <span class="bold"><strong>const</strong></span> <a class="link" href="sobol.html" title="Class template sobol">sobol</a> & f) ;</pre>Writes a <code class="computeroutput">sobol</code> to a <code class="computeroutput">std::ostream</code>. </li>
<li>
-<pre class="literallayout"><span class="type"></span> <a name="id2724981-bb"></a>BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR(os, <a class="link" href="sobol.html" title="Class template sobol">sobol</a>, f) ;</pre>Writes a <code class="computeroutput">sobol</code> to a <code class="computeroutput">std::ostream</code>. </li>
+<pre class="literallayout"><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> CharT, <span class="bold"><strong>typename</strong></span> Traits>
+ <span class="type"><span class="bold"><strong>friend</strong></span> std::basic_istream< CharT, Traits > &</span>
+ <a name="id2620166-bb"></a><span class="bold"><strong>operator</strong></span>>>(std::basic_istream< CharT, Traits > & is, <a class="link" href="sobol.html" title="Class template sobol">sobol</a> & f) ;</pre>Reads a <code class="computeroutput">niederreiter_base2</code> from a <code class="computeroutput">std::istream</code>. </li>
<li>
-<pre class="literallayout"><span class="type"></span> <a name="id2725013-bb"></a>BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR(is, <a class="link" href="sobol.html" title="Class template sobol">sobol</a>, f) ;</pre>Reads a <code class="computeroutput">niederreiter_base2</code> from a <code class="computeroutput">std::istream</code>. </li>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a name="id2620206-bb"></a><span class="bold"><strong>operator</strong></span>==(<span class="bold"><strong>const</strong></span> <a class="link" href="sobol.html" title="Class template sobol">sobol</a> & x, <span class="bold"><strong>const</strong></span> <a class="link" href="sobol.html" title="Class template sobol">sobol</a> & y) ;</pre>Returns true if the two generators will produce identical sequences. </li>
<li>
-<pre class="literallayout"><span class="type"></span> <a name="id2725046-bb"></a>BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR(<a class="link" href="sobol.html" title="Class template sobol">sobol</a>, x, y) ;</pre>Returns true if the two generators will produce identical sequences. </li>
+<pre class="literallayout"><span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a name="id2620233-bb"></a><span class="bold"><strong>operator</strong></span>!=(<span class="bold"><strong>const</strong></span> <a class="link" href="sobol.html" title="Class template sobol">sobol</a> & lhs, <span class="bold"><strong>const</strong></span> <a class="link" href="sobol.html" title="Class template sobol">sobol</a> & rhs) ;</pre>Returns true if the two generators will produce different sequences,. </li>
</ol></div>
</div>
</div>
Modified: sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost_random_quasi_random_number_generators_extension/reference.html
==============================================================================
--- sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost_random_quasi_random_number_generators_extension/reference.html (original)
+++ sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost_random_quasi_random_number_generators_extension/reference.html 2010-07-22 04:32:03 EDT (Thu, 22 Jul 2010)
@@ -80,23 +80,47 @@
<p>Describes the quasi-random number generator class template sobol.</p>
<p><span class="bold"><strong>Note:</strong></span> it is especially useful in conjunction with class template uniform_real. </p>
<pre class="synopsis"><span class="bold"><strong>namespace</strong></span> boost {
- <span class="bold"><strong>typedef</strong></span> sobol_generator< 1 >::type <a name="boost.sobol_1d"></a>sobol_1d;
- <span class="bold"><strong>typedef</strong></span> sobol_generator< 2 >::type <a name="boost.sobol_2d"></a>sobol_2d;
- <span class="bold"><strong>typedef</strong></span> sobol_generator< 3 >::type <a name="boost.sobol_3d"></a>sobol_3d;
- <span class="bold"><strong>typedef</strong></span> sobol_generator< 4 >::type <a name="boost.sobol_4d"></a>sobol_4d;
- <span class="bold"><strong>typedef</strong></span> sobol_generator< 5 >::type <a name="boost.sobol_5d"></a>sobol_5d;
- <span class="bold"><strong>typedef</strong></span> sobol_generator< 6 >::type <a name="boost.sobol_6d"></a>sobol_6d;
- <span class="bold"><strong>typedef</strong></span> sobol_generator< 7 >::type <a name="boost.sobol_7d"></a>sobol_7d;
- <span class="bold"><strong>typedef</strong></span> sobol_generator< 8 >::type <a name="boost.sobol_8d"></a>sobol_8d;
- <span class="bold"><strong>typedef</strong></span> sobol_generator< 9 >::type <a name="boost.sobol_9d"></a>sobol_9d;
- <span class="bold"><strong>typedef</strong></span> sobol_generator< 10 >::type <a name="boost.sobol_10d"></a>sobol_10d;
- <span class="bold"><strong>typedef</strong></span> sobol_generator< 11 >::type <a name="boost.sobol_11d"></a>sobol_11d;
- <span class="bold"><strong>typedef</strong></span> sobol_generator< 12 >::type <a name="boost.sobol_12d"></a>sobol_12d;
<span class="bold"><strong>namespace</strong></span> random {
- <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> IntType, std::size_t Dimension, IntType c, IntType m>
- <span class="bold"><strong>class</strong></span> <a class="link" href="../boost/random/sobol.html" title="Class template sobol">sobol</a>;
+ <span class="type">result_type</span> <a class="link" href="../boost/random/min.html" title="Function min">min</a>();
+ <span class="type">result_type</span> <a class="link" href="../boost/random/max.html" title="Function max">max</a>();
+ <span class="type">std::size_t</span> <a class="link" href="../boost/random/dimension.html" title="Function dimension">dimension</a>();
+ <span class="type"></span> <a class="link" href="../boost/random/sobol_id2425237.html" title="Function sobol">sobol</a>();
+ <span class="type"></span> <a class="link" href="../boost/random/sobol_id2425248.html" title="Function sobol">sobol</a>(std::size_t);
+ <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="../boost/random/seed_id2425265.html" title="Function seed">seed</a>();
+ <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="../boost/random/seed_id2425282.html" title="Function seed">seed</a>(std::size_t);
+ <span class="type">result_type</span> <a class="link" href="../boost/random/operator__.html" title="Function operator()"><span class="bold"><strong>operator</strong></span>()</a>();
+ <span class="type"><span class="bold"><strong>void</strong></span></span> <a class="link" href="../boost/random/discard.html" title="Function discard">discard</a>(std::size_t);
+
+ <span class="emphasis"><em>// Writes a <code class="computeroutput">sobol</code> to a <code class="computeroutput">std::ostream</code>. </em></span>
+ <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> CharT, <span class="bold"><strong>typename</strong></span> Traits>
+ <span class="type"><span class="bold"><strong>friend</strong></span> std::basic_ostream< CharT, Traits > &</span>
+ <a name="boost.random.operator_id2425357"></a><span class="bold"><strong>operator</strong></span><<(std::basic_ostream< CharT, Traits > & os, <span class="bold"><strong>const</strong></span> sobol & f);
+
+ <span class="emphasis"><em>// Reads a <code class="computeroutput">niederreiter_base2</code> from a <code class="computeroutput">std::istream</code>. </em></span>
+ <span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> CharT, <span class="bold"><strong>typename</strong></span> Traits>
+ <span class="type"><span class="bold"><strong>friend</strong></span> std::basic_istream< CharT, Traits > &</span>
+ <a name="boost.random.operator_id2425393"></a><span class="bold"><strong>operator</strong></span>>>(std::basic_istream< CharT, Traits > & is, sobol & f);
+
+ <span class="emphasis"><em>// Returns true if the two generators will produce identical sequences. </em></span>
+ <span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a name="boost.random.operator=="></a><span class="bold"><strong>operator</strong></span>==(<span class="bold"><strong>const</strong></span> sobol & x, <span class="bold"><strong>const</strong></span> sobol & y);
+
+ <span class="emphasis"><em>// Returns true if the two generators will produce different sequences,. </em></span>
+ <span class="type"><span class="bold"><strong>friend</strong></span> <span class="bold"><strong>bool</strong></span></span> <a name="boost.random.operator!="></a><span class="bold"><strong>operator</strong></span>!=(<span class="bold"><strong>const</strong></span> sobol & lhs, <span class="bold"><strong>const</strong></span> sobol & rhs);
}
-}</pre>
+}
+
+<span class="bold"><strong>typedef</strong></span> sobol_generator< 1 >::type <a name="sobol_1d"></a>sobol_1d;
+<span class="bold"><strong>typedef</strong></span> sobol_generator< 2 >::type <a name="sobol_2d"></a>sobol_2d;
+<span class="bold"><strong>typedef</strong></span> sobol_generator< 3 >::type <a name="sobol_3d"></a>sobol_3d;
+<span class="bold"><strong>typedef</strong></span> sobol_generator< 4 >::type <a name="sobol_4d"></a>sobol_4d;
+<span class="bold"><strong>typedef</strong></span> sobol_generator< 5 >::type <a name="sobol_5d"></a>sobol_5d;
+<span class="bold"><strong>typedef</strong></span> sobol_generator< 6 >::type <a name="sobol_6d"></a>sobol_6d;
+<span class="bold"><strong>typedef</strong></span> sobol_generator< 7 >::type <a name="sobol_7d"></a>sobol_7d;
+<span class="bold"><strong>typedef</strong></span> sobol_generator< 8 >::type <a name="sobol_8d"></a>sobol_8d;
+<span class="bold"><strong>typedef</strong></span> sobol_generator< 9 >::type <a name="sobol_9d"></a>sobol_9d;
+<span class="bold"><strong>typedef</strong></span> sobol_generator< 10 >::type <a name="sobol_10d"></a>sobol_10d;
+<span class="bold"><strong>typedef</strong></span> sobol_generator< 11 >::type <a name="sobol_11d"></a>sobol_11d;
+<span class="bold"><strong>typedef</strong></span> sobol_generator< 12 >::type <a name="sobol_12d"></a>sobol_12d;</pre>
</div>
</div>
</div>
Modified: sandbox/SOC/2010/quasi_random/libs/random/doc/html/index.html
==============================================================================
--- sandbox/SOC/2010/quasi_random/libs/random/doc/html/index.html (original)
+++ sandbox/SOC/2010/quasi_random/libs/random/doc/html/index.html 2010-07-22 04:32:03 EDT (Thu, 22 Jul 2010)
@@ -20,7 +20,7 @@
</h3></div></div>
<div><p class="copyright">Copyright © 2010 Justinas Vygintas Daugmaudis</p></div>
<div><div class="legalnotice">
-<a name="id3048269"></a><p>
+<a name="id2639352"></a><p>
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)
</p>
@@ -147,7 +147,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: July 22, 2010 at 05:41:06 GMT</small></p></td>
+<td align="left"><p><small>Last revised: July 22, 2010 at 08:27:59 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk