Update of /cvsroot/boost/boost/libs/random
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv30314
Modified Files:
random-distributions.html
Log Message:
sourceforge bug #1464566: adjust documentation for uniform_01 to reality
Index: random-distributions.html
===================================================================
RCS file: /cvsroot/boost/boost/libs/random/random-distributions.html,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -d -r1.11 -r1.12
--- random-distributions.html 26 Apr 2007 20:04:11 -0000 1.11
+++ random-distributions.html 26 Apr 2007 20:16:33 -0000 1.12
@@ -409,7 +409,7 @@
typedef UniformRandomNumberGenerator base_type;
typedef RealType result_type;
static const bool has_fixed_range = false;
- explicit uniform_01(base_type & rng);
+ explicit uniform_01(base_type rng);
result_type operator()();
result_type min() const;
result_type max() const;
@@ -426,6 +426,13 @@
digits, i.e. the mantissa of the floating-point value is completely filled
with random bits. [<em>Note:</em> Should this be configurable?]</p>
+ <p><em>WARNING:</em> As an exception / historic accident, this class
+ takes a UniformRandomNumberGenerator as its constructor parameter,
+ and BY VALUE. Usually, you want reference semantics so that the
+ state of the passed-in generator is changed in-place and not copied.
+ In that case, explicitly supply a reference type for the template
+ parameter UniformRandomNumberGenerator.</p>
+
<p>The template parameter <code>RealType</code> shall denote a float-like
value type with support for binary operators +, -, and /. It must be large
enough to hold floating-point numbers of value
@@ -442,7 +449,7 @@
<h3>Members</h3>
<pre>
-explicit uniform_01(base_type & rng)
+explicit uniform_01(base_type rng)
</pre>
<p><strong>Effects:</strong> Constructs a <code>uniform_01</code> functor
-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Boost-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/boost-cvs
