From 5eaec807ffeff389b0eca541e50cc47792dee70c Mon Sep 17 00:00:00 2001 From: Steven Watanabe Date: Mon, 14 Mar 2011 22:05:52 +0000 Subject: [PATCH] Update docs for random_number_generator. [SVN r69986] --- doc/Jamfile.v2 | 2 +- doc/random.qbk | 4 +-- doc/random_number_generator.qbk | 61 --------------------------------- 3 files changed, 3 insertions(+), 64 deletions(-) delete mode 100644 doc/random_number_generator.qbk diff --git a/doc/Jamfile.v2 b/doc/Jamfile.v2 index 1b0971b..a5db8b7 100644 --- a/doc/Jamfile.v2 +++ b/doc/Jamfile.v2 @@ -9,7 +9,7 @@ using quickbook ; using doxygen ; -import boostbook ; +using boostbook ; import regex ; import os ; import path ; diff --git a/doc/random.qbk b/doc/random.qbk index baede60..3a67ac7 100644 --- a/doc/random.qbk +++ b/doc/random.qbk @@ -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]] diff --git a/doc/random_number_generator.qbk b/doc/random_number_generator.qbk deleted file mode 100644 index 74b1d2b..0000000 --- a/doc/random_number_generator.qbk +++ /dev/null @@ -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 ] - - namespace boost { - template - class random_number_generator; - } // namespace boost - -[endsect] - -[section Class template random_number_generator] - -[section Synopsis] - - template - 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(rng, 0, n-1)(). - -[endsect] - -[endsect]