[Boost-commit] svn:boost r69986 - trunk/libs/random/doc

Subject: [Boost-commit] svn:boost r69986 - trunk/libs/random/doc
From: steven_at_[hidden]
Date: 2011-03-14 18:05:53

Author: steven_watanabe
Date: 2011-03-14 18:05:52 EDT (Mon, 14 Mar 2011)
New Revision: 69986
URL: http://svn.boost.org/trac/boost/changeset/69986

Log:
Update docs for random_number_generator.
Removed:
   trunk/libs/random/doc/random_number_generator.qbk
Text files modified: 
   trunk/libs/random/doc/Jamfile.v2 |     2 +-                                      
   trunk/libs/random/doc/random.qbk |     4 ++--                                    
   2 files changed, 3 insertions(+), 3 deletions(-)

Modified: trunk/libs/random/doc/Jamfile.v2
==============================================================================
--- trunk/libs/random/doc/Jamfile.v2	(original)
+++ trunk/libs/random/doc/Jamfile.v2	2011-03-14 18:05:52 EDT (Mon, 14 Mar 2011)
@@ -9,7 +9,7 @@
 
 using quickbook ;
 using doxygen ;
-import boostbook ;
+using boostbook ;
 import regex ;
 import os ;
 import path ;

Modified: trunk/libs/random/doc/random.qbk
==============================================================================
--- trunk/libs/random/doc/random.qbk	(original)
+++ trunk/libs/random/doc/random.qbk	2011-03-14 18:05:52 EDT (Mon, 14 Mar 2011)
@@ -27,8 +27,8 @@
 [def __Streamable Streamable]
 
 [def __random_device [classref boost::random::random_device random_device]]
-[def __random_number_generator [classref boost::random_number_generator random_number_generator]]
-[def __variate_generator [classref boost::variate_generator variate_generator]]
+[def __random_number_generator [classref boost::random::random_number_generator random_number_generator]]
+[def __variate_generator [classref boost::random::variate_generator variate_generator]]
 
 [def __minstd_rand0 [classref boost::random::minstd_rand0 minstd_rand0]]
 [def __minstd_rand [classref boost::random::minstd_rand minstd_rand]]

Deleted: trunk/libs/random/doc/random_number_generator.qbk
==============================================================================
--- trunk/libs/random/doc/random_number_generator.qbk	2011-03-14 18:05:52 EDT (Mon, 14 Mar 2011)
+++ (empty file)
@@ -1,61 +0,0 @@
-[/
- / Copyright (c) 2009 Steven Watanabe
- /
- / 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)
-]
-
-[section Synopsis of miscellaneous decorators in header <boost/random.hpp>]
-
-  namespace boost {
-    template<class UniformRandomNumberGenerator, class IntType = long>
-    class random_number_generator;
-  } // namespace boost
-
-[endsect]
-
-[section Class template random_number_generator]
-
-[section Synopsis]
-
-  template<class UniformRandomNumberGenerator, class IntType = long>
-  class random_number_generator
-  {
-  public:
-    typedef UniformRandomNumberGenerator base_type;
-    typedef IntType argument_type;
-    typedef IntType result_type;
-    random_number_generator(base_type & rng);
-    result_type operator()(argument_type n);
-  };
-
-[endsect]
-
-[section Description]
-
-Instantiations of class template random_number_generator model a
-RandomNumberGenerator (std:25.2.11 [lib.alg.random.shuffle]). On each
-invocation, it returns a uniformly distributed integer in the range [0..n).
-
-The template parameter IntType shall denote some integer-like value type.
-
-[note I consider it unfortunate that the C++ Standard uses the name
-RandomNumberGenerator for something rather specific.]
-
-[endsect]
-
-[section Members]
-
-  random_number_generator(base_type & rng)
-
-Effects: Constructs a random_number_generator functor with the given uniform
-random number generator as the underlying source of random numbers.
-
-  result_type operator()(argument_type n)
-
-Returns: The value of uniform_int<base_type>(rng, 0, n-1)().
-
-[endsect]
-
-[endsect]