Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r64235 - in sandbox/SOC/2010/quasi_random/libs/random/doc: . html html/boost/random
From: jvd_at_[hidden]
Date: 2010-07-21 16:04:10

Author: qrng
Date: 2010-07-21 16:04:08 EDT (Wed, 21 Jul 2010)
New Revision: 64235
URL: http://svn.boost.org/trac/boost/changeset/64235

Log:
Updated html documentation

Text files modified:
   sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost/random/faure.html | 64 +++++++++++++++++-----------------
   sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost/random/niederreiter_base2.html | 74 ++++++++++++++++++++--------------------
   sandbox/SOC/2010/quasi_random/libs/random/doc/html/boost/random/sobol.html | 64 +++++++++++++++++-----------------
   sandbox/SOC/2010/quasi_random/libs/random/doc/html/index.html | 7 ++-
   sandbox/SOC/2010/quasi_random/libs/random/doc/main.qbk | 2 +
   5 files changed, 107 insertions(+), 104 deletions(-)

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-21 16:04:08 EDT (Wed, 21 Jul 2010)
@@ -31,25 +31,25 @@
 typedef RealType <a name="boost.random.faure.result_type"></a>result_type;

 // <a class="link" href="faure.html#boost.random.faureconstruct-copy-destruct">construct/copy/destruct</a>
- <a class="link" href="faure.html#id364384-bb">faure</a>();
- <a class="link" href="faure.html#id364391-bb">faure</a>(std::size_t);
+ <a class="link" href="faure.html#id297112-bb">faure</a>();
+ <a class="link" href="faure.html#id297120-bb">faure</a>(std::size_t);

- // <a class="link" href="faure.html#id321582-bb">public static functions</a>
- static result_type min <a class="link" href="faure.html#id321585-bb">BOOST_PREVENT_MACRO_SUBSTITUTION</a>();
- static result_type max <a class="link" href="faure.html#id321602-bb">BOOST_PREVENT_MACRO_SUBSTITUTION</a>();
- static std::size_t <a class="link" href="faure.html#id319522-bb">dimension</a>();
+ // <a class="link" href="faure.html#id254311-bb">public static functions</a>
+ static result_type min <a class="link" href="faure.html#id254314-bb">BOOST_PREVENT_MACRO_SUBSTITUTION</a>();
+ static result_type max <a class="link" href="faure.html#id254330-bb">BOOST_PREVENT_MACRO_SUBSTITUTION</a>();
+ static std::size_t <a class="link" href="faure.html#id252246-bb">dimension</a>();

- // <a class="link" href="faure.html#id319538-bb">public member functions</a>
- void <a class="link" href="faure.html#id319541-bb">seed</a>();
- void <a class="link" href="faure.html#id319558-bb">seed</a>(std::size_t);
- result_type <a class="link" href="faure.html#id319587-bb">operator()</a>();
- void <a class="link" href="faure.html#id319605-bb">discard</a>(std::size_t);
- <a class="link" href="faure.html#id319633-bb">BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR</a>(os, <a class="link" href="faure.html" title="Class template faure">faure</a>, f);
- <a class="link" href="faure.html#id319668-bb">BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR</a>(is, <a class="link" href="faure.html" title="Class template faure">faure</a>, f);
- <a class="link" href="faure.html#id319703-bb">BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR</a>(<a class="link" href="faure.html" title="Class template faure">faure</a>, x, y);
+ // <a class="link" href="faure.html#id252261-bb">public member functions</a>
+ void <a class="link" href="faure.html#id252264-bb">seed</a>();
+ void <a class="link" href="faure.html#id252281-bb">seed</a>(std::size_t);
+ result_type <a class="link" href="faure.html#id252310-bb">operator()</a>();
+ void <a class="link" href="faure.html#id252328-bb">discard</a>(std::size_t);
+ <a class="link" href="faure.html#id252356-bb">BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR</a>(os, <a class="link" href="faure.html" title="Class template faure">faure</a>, f);
+ <a class="link" href="faure.html#id252391-bb">BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR</a>(is, <a class="link" href="faure.html" title="Class template faure">faure</a>, f);
+ <a class="link" href="faure.html#id252426-bb">BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR</a>(<a class="link" href="faure.html" title="Class template faure">faure</a>, x, y);
};</pre></div>
<div class="refsect1" lang="en">
-<a name="id644083"></a><h2>Description</h2>
+<a name="id717003"></a><h2>Description</h2>
class template faure implements a quasi-random number generator as described in 
<div class="blockquote"><blockquote class="blockquote"> Henri Faure, Discrepance de suites associees a un systeme de numeration (en dimension s), Acta Arithmetica, Volume 41, 1982, pages 337-351. </blockquote></div>
 
@@ -59,43 +59,43 @@
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>.
Some member functions may throw exceptions of type <code class="computeroutput">std::bad_alloc</code>. 
<div class="refsect2" lang="en">
-<a name="id644126"></a><h3>
+<a name="id717046"></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="id364384-bb"></a>faure();</pre>
+<pre class="literallayout"><a name="id297112-bb"></a>faure();</pre>
Effects: Constructs the default Faure quasi-random number generator.
Throws: bad_alloc. 
</li>
<li>
-<pre class="literallayout"><a name="id364391-bb"></a>faure(std::size_t init);</pre>
+<pre class="literallayout"><a name="id297120-bb"></a>faure(std::size_t init);</pre>
Effects: Constructs the Faure quasi-random number generator, equivalent to X u; u.seed(init).
Throws: bad_alloc. 
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
-<a name="id644221"></a><h3>
-<a name="id321582-bb"></a><code class="computeroutput">faure</code> public static functions</h3>
+<a name="id717141"></a><h3>
+<a name="id254311-bb"></a><code class="computeroutput">faure</code> public static functions</h3>
<div class="orderedlist"><ol type="1">
<li>
-<pre class="literallayout">static result_type min <a name="id321585-bb"></a>BOOST_PREVENT_MACRO_SUBSTITUTION();</pre>
+<pre class="literallayout">static result_type min <a name="id254314-bb"></a>BOOST_PREVENT_MACRO_SUBSTITUTION();</pre>
Returns: Tight lower bound on the set of values returned by operator().
Throws: nothing. 

 
</li>
<li>
-<pre class="literallayout">static result_type max <a name="id321602-bb"></a>BOOST_PREVENT_MACRO_SUBSTITUTION();</pre>
+<pre class="literallayout">static result_type max <a name="id254330-bb"></a>BOOST_PREVENT_MACRO_SUBSTITUTION();</pre>
Returns: Tight upper bound on the set of values returned by operator().
Throws: nothing. 

 
</li>
<li>
-<pre class="literallayout">static std::size_t <a name="id319522-bb"></a>dimension();</pre>
+<pre class="literallayout">static std::size_t <a name="id252246-bb"></a>dimension();</pre>
Returns: The dimension of of the quasi-random domain.
Throws: nothing. 

@@ -104,18 +104,18 @@
</ol></div>
</div>
<div class="refsect2" lang="en">
-<a name="id644386"></a><h3>
-<a name="id319538-bb"></a><code class="computeroutput">faure</code> public member functions</h3>
+<a name="id717306"></a><h3>
+<a name="id252261-bb"></a><code class="computeroutput">faure</code> public member functions</h3>
<div class="orderedlist"><ol type="1">
<li>
-<pre class="literallayout">void <a name="id319541-bb"></a>seed();</pre>
+<pre class="literallayout">void <a name="id252264-bb"></a>seed();</pre>
Requirements: *this is mutable.
Effects: Resets the quasi-random number generator state to the one given by the default construction. Equivalent to u.seed(0). 

 Throws: bad_alloc. 
</li>
<li>
-<pre class="literallayout">void <a name="id319558-bb"></a>seed(std::size_t init);</pre>
+<pre class="literallayout">void <a name="id252281-bb"></a>seed(std::size_t init);</pre>
Requirements: *this is mutable.
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(). 
<pre class="programlisting"> X u, v;
@@ -130,13 +130,13 @@
 Throws: bad_alloc. 
</li>
<li>
-<pre class="literallayout">result_type <a name="id319587-bb"></a>operator()();</pre>
+<pre class="literallayout">result_type <a name="id252310-bb"></a>operator()();</pre>
Requirements: *this is mutable.
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.
Throws: bad_alloc. 
</li>
<li>
-<pre class="literallayout">void <a name="id319605-bb"></a>discard(std::size_t z);</pre>
+<pre class="literallayout">void <a name="id252328-bb"></a>discard(std::size_t z);</pre>
Requirements: *this is mutable.
Effects: Advances *this state as if z consecutive X::operator() invocations were executed. 
<pre class="programlisting"> X u = v;
@@ -150,11 +150,11 @@
 Throws: bad_alloc. 
</li>
<li>
-<pre class="literallayout"> <a name="id319633-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>
+<pre class="literallayout"> <a name="id252356-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"> <a name="id319668-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>
+<pre class="literallayout"> <a name="id252391-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"> <a name="id319703-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>
+<pre class="literallayout"> <a name="id252426-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-21 16:04:08 EDT (Wed, 21 Jul 2010)
@@ -31,36 +31,36 @@
 typedef IntType <a name="boost.random.niederreiter_base2.result_type"></a>result_type;

 // <a class="link" href="niederreiter_base2.html#boost.random.niederreiter_base2construct-copy-destruct">construct/copy/destruct</a>
- <a class="link" href="niederreiter_base2.html#id364691-bb">niederreiter_base2</a>();
- <a class="link" href="niederreiter_base2.html#id364698-bb">niederreiter_base2</a>(std::size_t);
+ <a class="link" href="niederreiter_base2.html#id297419-bb">niederreiter_base2</a>();
+ <a class="link" href="niederreiter_base2.html#id297427-bb">niederreiter_base2</a>(std::size_t);

- // <a class="link" href="niederreiter_base2.html#id364563-bb">public static functions</a>
- static result_type <a class="link" href="niederreiter_base2.html#id364566-bb">min</a>();
- static result_type <a class="link" href="niederreiter_base2.html#id364580-bb">max</a>();
- static std::size_t <a class="link" href="niederreiter_base2.html#id364593-bb">dimension</a>();
+ // <a class="link" href="niederreiter_base2.html#id297292-bb">public static functions</a>
+ static result_type <a class="link" href="niederreiter_base2.html#id297295-bb">min</a>();
+ static result_type <a class="link" href="niederreiter_base2.html#id297308-bb">max</a>();
+ static std::size_t <a class="link" href="niederreiter_base2.html#id297321-bb">dimension</a>();

- // <a class="link" href="niederreiter_base2.html#id364605-bb">public member functions</a>
- void <a class="link" href="niederreiter_base2.html#id364608-bb">seed</a>();
- void <a class="link" href="niederreiter_base2.html#id364624-bb">seed</a>(std::size_t);
- result_type <a class="link" href="niederreiter_base2.html#id364650-bb">operator()</a>();
- void <a class="link" href="niederreiter_base2.html#id364667-bb">discard</a>(std::size_t);
+ // <a class="link" href="niederreiter_base2.html#id297334-bb">public member functions</a>
+ void <a class="link" href="niederreiter_base2.html#id297337-bb">seed</a>();
+ void <a class="link" href="niederreiter_base2.html#id297353-bb">seed</a>(std::size_t);
+ result_type <a class="link" href="niederreiter_base2.html#id297379-bb">operator()</a>();
+ void <a class="link" href="niederreiter_base2.html#id297395-bb">discard</a>(std::size_t);

- // <a class="link" href="niederreiter_base2.html#id364711-bb">friend functions</a>
+ // <a class="link" href="niederreiter_base2.html#id297439-bb">friend functions</a>
 template<typename CharT, typename Traits>
 friend std::basic_ostream< CharT, Traits > &
- <a class="link" href="niederreiter_base2.html#id364714-bb">operator<<</a>(std::basic_ostream< CharT, Traits > &,
+ <a class="link" href="niederreiter_base2.html#id297442-bb">operator<<</a>(std::basic_ostream< CharT, Traits > &,
 const <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &);
 template<typename CharT, typename Traits>
 friend std::basic_istream< CharT, Traits > &
- <a class="link" href="niederreiter_base2.html#id364754-bb">operator>></a>(std::basic_istream< CharT, Traits > &,
+ <a class="link" href="niederreiter_base2.html#id297482-bb">operator>></a>(std::basic_istream< CharT, Traits > &,
 const <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &);
- friend bool <a class="link" href="niederreiter_base2.html#id364793-bb">operator==</a>(const <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &,
+ friend bool <a class="link" href="niederreiter_base2.html#id297522-bb">operator==</a>(const <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &,
 const <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &);
- friend bool <a class="link" href="niederreiter_base2.html#id364820-bb">operator!=</a>(const <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &,
+ friend bool <a class="link" href="niederreiter_base2.html#id297549-bb">operator!=</a>(const <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &,
 const <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> &);
};</pre></div>
<div class="refsect1" lang="en">
-<a name="id646413"></a><h2>Description</h2>
+<a name="id719332"></a><h2>Description</h2>
class template niederreiter_base2 implements a quasi-random number generator as described in 
<div class="blockquote"><blockquote class="blockquote"> Bratley, Fox, Niederreiter, ACM Trans. Model. Comp. Sim. 2, 195 (1992). </blockquote></div>
 
@@ -68,54 +68,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>.
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 <img src="../../images/form_0.png">, where digits = std::numeric_limits<IntType>::digits. 
<div class="refsect2" lang="en">
-<a name="id646466"></a><h3>
+<a name="id719385"></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="id364691-bb"></a>niederreiter_base2();</pre>
+<pre class="literallayout"><a name="id297419-bb"></a>niederreiter_base2();</pre>
Effects: Constructs the default Niederreiter base 2 quasi-random number generator.
Throws: nothing. 
</li>
<li>
-<pre class="literallayout"><a name="id364698-bb"></a>niederreiter_base2(std::size_t init);</pre>
+<pre class="literallayout"><a name="id297427-bb"></a>niederreiter_base2(std::size_t init);</pre>
Effects: Constructs the Niederreiter base 2 quasi-random number generator, equivalent to X u; u.seed(init).
Throws: overflow_error. 
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
-<a name="id646559"></a><h3>
-<a name="id364563-bb"></a><code class="computeroutput">niederreiter_base2</code> public static functions</h3>
+<a name="id719478"></a><h3>
+<a name="id297292-bb"></a><code class="computeroutput">niederreiter_base2</code> public static functions</h3>
<div class="orderedlist"><ol type="1">
<li>
-<pre class="literallayout">static result_type <a name="id364566-bb"></a>min();</pre>
+<pre class="literallayout">static result_type <a name="id297295-bb"></a>min();</pre>
Returns: Tight lower bound on the set of values returned by operator().
Throws: nothing. 
</li>
<li>
-<pre class="literallayout">static result_type <a name="id364580-bb"></a>max();</pre>
+<pre class="literallayout">static result_type <a name="id297308-bb"></a>max();</pre>
Returns: Tight upper bound on the set of values returned by operator().
Throws: nothing. 
</li>
<li>
-<pre class="literallayout">static std::size_t <a name="id364593-bb"></a>dimension();</pre>
+<pre class="literallayout">static std::size_t <a name="id297321-bb"></a>dimension();</pre>
Returns: The dimension of of the quasi-random domain.
Throws: nothing. 
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
-<a name="id646708"></a><h3>
-<a name="id364605-bb"></a><code class="computeroutput">niederreiter_base2</code> public member functions</h3>
+<a name="id719628"></a><h3>
+<a name="id297334-bb"></a><code class="computeroutput">niederreiter_base2</code> public member functions</h3>
<div class="orderedlist"><ol type="1">
<li>
-<pre class="literallayout">void <a name="id364608-bb"></a>seed();</pre>Throws: nothing. Requirements: *this is mutable.
+<pre class="literallayout">void <a name="id297337-bb"></a>seed();</pre>Throws: nothing. Requirements: *this is mutable.
Effects: Resets the quasi-random number generator state to the one given by the default construction. Equivalent to u.seed(0). 
</li>
<li>
-<pre class="literallayout">void <a name="id364624-bb"></a>seed(std::size_t init);</pre>Throws: overflow_error. Requirements: *this is mutable.
+<pre class="literallayout">void <a name="id297353-bb"></a>seed(std::size_t init);</pre>Throws: overflow_error. Requirements: *this is mutable.
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(). 
<pre class="programlisting"> X u, v;
 for(int i = 0; i < N; ++i)
@@ -127,13 +127,13 @@
 
</li>
<li>
-<pre class="literallayout">result_type <a name="id364650-bb"></a>operator()();</pre>
+<pre class="literallayout">result_type <a name="id297379-bb"></a>operator()();</pre>
Requirements: *this is mutable.
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.
Throws: overflow_error. 
</li>
<li>
-<pre class="literallayout">void <a name="id364667-bb"></a>discard(std::size_t z);</pre>
+<pre class="literallayout">void <a name="id297395-bb"></a>discard(std::size_t z);</pre>
Requirements: *this is mutable.
Effects: Advances *this state as if z consecutive X::operator() invocations were executed. 
<pre class="programlisting"> X u = v;
@@ -147,24 +147,24 @@
</ol></div>
</div>
<div class="refsect2" lang="en">
-<a name="id646930"></a><h3>
-<a name="id364711-bb"></a><code class="computeroutput">niederreiter_base2</code> friend functions</h3>
+<a name="id719850"></a><h3>
+<a name="id297439-bb"></a><code class="computeroutput">niederreiter_base2</code> friend functions</h3>
<div class="orderedlist"><ol type="1">
<li>
<pre class="literallayout">template<typename CharT, typename Traits>
 friend std::basic_ostream< CharT, Traits > &
- <a name="id364714-bb"></a>operator<<(std::basic_ostream< CharT, Traits > & os,
+ <a name="id297442-bb"></a>operator<<(std::basic_ostream< CharT, Traits > & os,
 const <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">template<typename CharT, typename Traits>
 friend std::basic_istream< CharT, Traits > &
- <a name="id364754-bb"></a>operator>>(std::basic_istream< CharT, Traits > & is,
+ <a name="id297482-bb"></a>operator>>(std::basic_istream< CharT, Traits > & is,
 const <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">friend bool <a name="id364793-bb"></a>operator==(const <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> & x,
+<pre class="literallayout">friend bool <a name="id297522-bb"></a>operator==(const <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> & x,
 const <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">friend bool <a name="id364820-bb"></a>operator!=(const <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> & lhs,
+<pre class="literallayout">friend bool <a name="id297549-bb"></a>operator!=(const <a class="link" href="niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a> & lhs,
 const <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>

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-21 16:04:08 EDT (Wed, 21 Jul 2010)
@@ -30,25 +30,25 @@
 typedef IntType <a name="boost.random.sobol.result_type"></a>result_type;

 // <a class="link" href="sobol.html#boost.random.sobolconstruct-copy-destruct">construct/copy/destruct</a>
- <a class="link" href="sobol.html#id365238-bb">sobol</a>();
- <a class="link" href="sobol.html#id365245-bb">sobol</a>(std::size_t);
+ <a class="link" href="sobol.html#id297966-bb">sobol</a>();
+ <a class="link" href="sobol.html#id297973-bb">sobol</a>(std::size_t);

- // <a class="link" href="sobol.html#id365009-bb">public static functions</a>
- static result_type min <a class="link" href="sobol.html#id365012-bb">BOOST_PREVENT_MACRO_SUBSTITUTION</a>();
- static result_type max <a class="link" href="sobol.html#id365028-bb">BOOST_PREVENT_MACRO_SUBSTITUTION</a>();
- static std::size_t <a class="link" href="sobol.html#id365043-bb">dimension</a>();
+ // <a class="link" href="sobol.html#id297738-bb">public static functions</a>
+ static result_type min <a class="link" href="sobol.html#id297741-bb">BOOST_PREVENT_MACRO_SUBSTITUTION</a>();
+ static result_type max <a class="link" href="sobol.html#id297756-bb">BOOST_PREVENT_MACRO_SUBSTITUTION</a>();
+ static std::size_t <a class="link" href="sobol.html#id297771-bb">dimension</a>();

- // <a class="link" href="sobol.html#id365058-bb">public member functions</a>
- void <a class="link" href="sobol.html#id365061-bb">seed</a>();
- void <a class="link" href="sobol.html#id365079-bb">seed</a>(std::size_t);
- result_type <a class="link" href="sobol.html#id365107-bb">operator()</a>();
- void <a class="link" href="sobol.html#id365123-bb">discard</a>(std::size_t);
- <a class="link" href="sobol.html#id365150-bb">BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR</a>(os, <a class="link" href="sobol.html" title="Class template sobol">sobol</a>, f);
- <a class="link" href="sobol.html#id365181-bb">BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR</a>(is, <a class="link" href="sobol.html" title="Class template sobol">sobol</a>, f);
- <a class="link" href="sobol.html#id365212-bb">BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR</a>(<a class="link" href="sobol.html" title="Class template sobol">sobol</a>, x, y);
+ // <a class="link" href="sobol.html#id297786-bb">public member functions</a>
+ void <a class="link" href="sobol.html#id297789-bb">seed</a>();
+ void <a class="link" href="sobol.html#id297807-bb">seed</a>(std::size_t);
+ result_type <a class="link" href="sobol.html#id297835-bb">operator()</a>();
+ void <a class="link" href="sobol.html#id297852-bb">discard</a>(std::size_t);
+ <a class="link" href="sobol.html#id297878-bb">BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR</a>(os, <a class="link" href="sobol.html" title="Class template sobol">sobol</a>, f);
+ <a class="link" href="sobol.html#id297909-bb">BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR</a>(is, <a class="link" href="sobol.html" title="Class template sobol">sobol</a>, f);
+ <a class="link" href="sobol.html#id297941-bb">BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR</a>(<a class="link" href="sobol.html" title="Class template sobol">sobol</a>, x, y);
};</pre></div>
<div class="refsect1" lang="en">
-<a name="id648760"></a><h2>Description</h2>
+<a name="id721680"></a><h2>Description</h2>
class template sobol implements a quasi-random number generator as described in 
<div class="blockquote"><blockquote class="blockquote"> [Bratley+Fox, TOMS 14, 88 (1988)] and [Antonov+Saleev, USSR Comput. Maths. Math. Phys. 19, 252 (1980)] </blockquote></div>
 
@@ -56,43 +56,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>.
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 <img src="../../images/form_1.png">, where digits = std::numeric_limits<IntType>::digits. 
<div class="refsect2" lang="en">
-<a name="id648817"></a><h3>
+<a name="id721737"></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="id365238-bb"></a>sobol();</pre>
+<pre class="literallayout"><a name="id297966-bb"></a>sobol();</pre>
Effects: Constructs the default Sobol quasi-random number generator.
Throws: nothing. 
</li>
<li>
-<pre class="literallayout"><a name="id365245-bb"></a>sobol(std::size_t init);</pre>
+<pre class="literallayout"><a name="id297973-bb"></a>sobol(std::size_t init);</pre>
Effects: Constructs the Sobol quasi-random number generator, equivalent to X u; u.seed(init).
Throws: overflow_error. 
</li>
</ol></div>
</div>
<div class="refsect2" lang="en">
-<a name="id648910"></a><h3>
-<a name="id365009-bb"></a><code class="computeroutput">sobol</code> public static functions</h3>
+<a name="id721830"></a><h3>
+<a name="id297738-bb"></a><code class="computeroutput">sobol</code> public static functions</h3>
<div class="orderedlist"><ol type="1">
<li>
-<pre class="literallayout">static result_type min <a name="id365012-bb"></a>BOOST_PREVENT_MACRO_SUBSTITUTION();</pre>
+<pre class="literallayout">static result_type min <a name="id297741-bb"></a>BOOST_PREVENT_MACRO_SUBSTITUTION();</pre>
Returns: Tight lower bound on the set of values returned by operator().
Throws: nothing. 

 
</li>
<li>
-<pre class="literallayout">static result_type max <a name="id365028-bb"></a>BOOST_PREVENT_MACRO_SUBSTITUTION();</pre>
+<pre class="literallayout">static result_type max <a name="id297756-bb"></a>BOOST_PREVENT_MACRO_SUBSTITUTION();</pre>
Returns: Tight upper bound on the set of values returned by operator().
Throws: nothing. 

 
</li>
<li>
-<pre class="literallayout">static std::size_t <a name="id365043-bb"></a>dimension();</pre>
+<pre class="literallayout">static std::size_t <a name="id297771-bb"></a>dimension();</pre>
Returns: The dimension of of the quasi-random domain.
Throws: nothing. 

@@ -101,11 +101,11 @@
</ol></div>
</div>
<div class="refsect2" lang="en">
-<a name="id649076"></a><h3>
-<a name="id365058-bb"></a><code class="computeroutput">sobol</code> public member functions</h3>
+<a name="id721996"></a><h3>
+<a name="id297786-bb"></a><code class="computeroutput">sobol</code> public member functions</h3>
<div class="orderedlist"><ol type="1">
<li>
-<pre class="literallayout">void <a name="id365061-bb"></a>seed();</pre>
+<pre class="literallayout">void <a name="id297789-bb"></a>seed();</pre>
Throws: nothing. 
Requirements: *this is mutable.
Effects: Resets the quasi-random number generator state to the one given by the default construction. Equivalent to u.seed(0). 
@@ -113,7 +113,7 @@
 
</li>
<li>
-<pre class="literallayout">void <a name="id365079-bb"></a>seed(std::size_t init);</pre>
+<pre class="literallayout">void <a name="id297807-bb"></a>seed(std::size_t init);</pre>
Throws: overflow_error. 
Requirements: *this is mutable.
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(). 
@@ -129,13 +129,13 @@
 
</li>
<li>
-<pre class="literallayout">result_type <a name="id365107-bb"></a>operator()();</pre>
+<pre class="literallayout">result_type <a name="id297835-bb"></a>operator()();</pre>
Requirements: *this is mutable.
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.
Throws: overflow_error. 
</li>
<li>
-<pre class="literallayout">void <a name="id365123-bb"></a>discard(std::size_t z);</pre>
+<pre class="literallayout">void <a name="id297852-bb"></a>discard(std::size_t z);</pre>
Requirements: *this is mutable.
Effects: Advances *this state as if z consecutive X::operator() invocations were executed. 
<pre class="programlisting"> X u = v;
@@ -149,11 +149,11 @@
 
</li>
<li>
-<pre class="literallayout"> <a name="id365150-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"> <a name="id297878-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>
<li>
-<pre class="literallayout"> <a name="id365181-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"> <a name="id297909-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>
<li>
-<pre class="literallayout"> <a name="id365212-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"> <a name="id297941-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>
</ol></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-21 16:04:08 EDT (Wed, 21 Jul 2010)
@@ -20,7 +20,7 @@
</h3></div></div>
<div>Copyright © 2010 Justinas Vygintas Daugmaudis</div>
<div><div class="legalnotice">
-<a name="id633781"></a>
+<a name="id706690"></a>
 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)
 
@@ -141,12 +141,13 @@
 </td></tr>
</table></div>

- The class __niederreiter_base2 is a model for a quasi-random number generator.
+ The class <code class="computeroutput"><a class="link" href="boost/random/niederreiter_base2.html" title="Class template niederreiter_base2">niederreiter_base2</a></code>
+ is a model for a quasi-random number generator.
 
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: July 21, 2010 at 19:13:43 GMT</td>
+<td align="left">Last revised: July 21, 2010 at 20:02:41 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Modified: sandbox/SOC/2010/quasi_random/libs/random/doc/main.qbk
==============================================================================
--- sandbox/SOC/2010/quasi_random/libs/random/doc/main.qbk (original)
+++ sandbox/SOC/2010/quasi_random/libs/random/doc/main.qbk 2010-07-21 16:04:08 EDT (Wed, 21 Jul 2010)
@@ -17,6 +17,8 @@
[authors [Daugmaudis, Justinas]]
]

+[def __QuasiRandomNumberGenerator [link boost_random.reference.concepts.quasi_random_number_generator QuasiRandomNumberGenerator]]
+[def __niederreiter_base2 [classref boost::random::niederreiter_base2 niederreiter_base2]]

[section Quasi-Random Number Generator]

Date view	Thread view	Subject view	Author view

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