Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r63370 - in trunk: boost/random libs/random/doc
From: steven_at_[hidden]
Date: 2010-06-26 16:42:31


Author: steven_watanabe
Date: 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
New Revision: 63370
URL: http://svn.boost.org/trac/boost/changeset/63370

Log:
Some doc cleanup.
Text files modified:
   trunk/boost/random/additive_combine.hpp | 4 +-
   trunk/boost/random/binomial_distribution.hpp | 17 ++++-----
   trunk/boost/random/cauchy_distribution.hpp | 6 +-
   trunk/boost/random/discrete_distribution.hpp | 2
   trunk/boost/random/exponential_distribution.hpp | 4 +-
   trunk/boost/random/extreme_value_distribution.hpp | 2
   trunk/boost/random/gamma_distribution.hpp | 10 ++--
   trunk/boost/random/lognormal_distribution.hpp | 10 ++--
   trunk/boost/random/mersenne_twister.hpp | 9 ++--
   trunk/boost/random/normal_distribution.hpp | 6 +-
   trunk/boost/random/poisson_distribution.hpp | 2
   trunk/boost/random/triangle_distribution.hpp | 4 +-
   trunk/boost/random/uniform_real.hpp | 4 +-
   trunk/boost/random/uniform_smallint.hpp | 71 ++++++++++++++++++++++++---------------
   trunk/boost/random/weibull_distribution.hpp | 2
   trunk/libs/random/doc/Jamfile.v2 | 20 +++++++++++
   16 files changed, 105 insertions(+), 68 deletions(-)

Modified: trunk/boost/random/additive_combine.hpp
==============================================================================
--- trunk/boost/random/additive_combine.hpp (original)
+++ trunk/boost/random/additive_combine.hpp 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
@@ -75,7 +75,7 @@
    */
   additive_combine() : _mlcg1(), _mlcg2() { }
   /**
- * Constructs an \additive_combine generator, using aseed as
+ * Constructs an \additive_combine generator, using seed as
    * the constructor argument for both base generators.
    */
   explicit additive_combine(result_type aseed)
@@ -112,7 +112,7 @@
   }
 
   /**
- * Seeds an \additive_combine generator, using @c aseed as the
+ * Seeds an \additive_combine generator, using @c seed as the
    * seed for both base generators.
    */
   void seed(result_type aseed)

Modified: trunk/boost/random/binomial_distribution.hpp
==============================================================================
--- trunk/boost/random/binomial_distribution.hpp (original)
+++ trunk/boost/random/binomial_distribution.hpp 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
@@ -51,7 +51,8 @@
  * two parameters, @c t and @c p. The values of the distribution
  * are within the range [0,t].
  *
- * The distribution function is \f$P(k) = {t \choose k}p^k(1-p)^{t-k}\f$.
+ * The distribution function is
+ * \f$\displaystyle P(k) = {t \choose k}p^k(1-p)^{t-k}\f$.
  *
  * The algorithm used is the BTRD algorithm described in
  *
@@ -76,8 +77,8 @@
          *
          * Requires: t >=0 && 0 <= p <= 1
          */
- explicit param_type(IntType t = 1, RealType p = RealType (0.5))
- : _t(t), _p(p)
+ explicit param_type(IntType t_arg = 1, RealType p_arg = RealType (0.5))
+ : _t(t_arg), _p(p_arg)
         {}
         /** Returns the @c t parameter of the distribution. */
         IntType t() const { return _t; }
@@ -124,8 +125,9 @@
      *
      * Requires: t >=0 && 0 <= p <= 1
      */
- explicit binomial_distribution(IntType t = 1, RealType p = RealType(0.5))
- : _t(t), _p(p)
+ explicit binomial_distribution(IntType t_arg = 1,
+ RealType p_arg = RealType(0.5))
+ : _t(t_arg), _p(p_arg)
     {
         init();
     }
@@ -133,9 +135,6 @@
     /**
      * Construct an @c binomial_distribution object from the
      * parameters.
- *
- * Requires: @c parm is the result of calling @c param() on
- * another @c binomial_distribution object.
      */
     explicit binomial_distribution(const param_type& parm)
       : _t(parm.t()), _p(parm.p())
@@ -165,7 +164,7 @@
     
     /**
      * Returns a random variate distributed according to the
- * binomial distribution with parameters specified by parm.
+ * binomial distribution with parameters specified by @c param.
      */
     template<class URNG>
     IntType operator()(URNG& urng, const param_type& parm) const

Modified: trunk/boost/random/cauchy_distribution.hpp
==============================================================================
--- trunk/boost/random/cauchy_distribution.hpp (original)
+++ trunk/boost/random/cauchy_distribution.hpp 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
@@ -36,7 +36,7 @@
  * The cauchy distribution is a continuous distribution with two
  * parameters, sigma and median.
  *
- * It has \f$p(x) = \frac{\sigma}{\pi(\sigma^2 + (x-m)^2)}\f$
+ * It has \f$\displaystyle p(x) = \frac{\sigma}{\pi(\sigma^2 + (x-m)^2)}\f$
  */
 template<class RealType = double>
 class cauchy_distribution
@@ -53,8 +53,8 @@
    * Constructs a \cauchy_distribution with the paramters @c median
    * and @c sigma.
    */
- explicit cauchy_distribution(result_type median_arg = result_type(0),
- result_type sigma_arg = result_type(1))
+ explicit cauchy_distribution(result_type median_arg = result_type(0.0),
+ result_type sigma_arg = result_type(1.0))
     : _median(median_arg), _sigma(sigma_arg) { }
 
   // compiler-generated copy ctor and assignment operator are fine

Modified: trunk/boost/random/discrete_distribution.hpp
==============================================================================
--- trunk/boost/random/discrete_distribution.hpp (original)
+++ trunk/boost/random/discrete_distribution.hpp 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
@@ -310,7 +310,7 @@
     
     /**
      * Returns a value distributed according to the parameters
- * specified by parm.
+ * specified by param.
      */
     template<class URNG>
     IntType operator()(URNG& urng, const param_type& parm) const

Modified: trunk/boost/random/exponential_distribution.hpp
==============================================================================
--- trunk/boost/random/exponential_distribution.hpp (original)
+++ trunk/boost/random/exponential_distribution.hpp 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
@@ -29,7 +29,7 @@
 /**
  * The exponential distribution has a single parameter lambda.
  *
- * It has \f$p(x) = \lambda e^{-\lambda x}\f$
+ * It has \f$\displaystyle p(x) = \lambda e^{-\lambda x}\f$
  */
 template<class RealType = double>
 class exponential_distribution
@@ -42,7 +42,7 @@
   BOOST_STATIC_ASSERT(!std::numeric_limits<RealType>::is_integer);
 #endif
 
- explicit exponential_distribution(result_type lambda_arg = result_type(1))
+ explicit exponential_distribution(result_type lambda_arg = result_type(1.0))
     : _lambda(lambda_arg) { assert(_lambda > result_type(0)); }
 
   // compiler-generated copy ctor and assignment operator are fine

Modified: trunk/boost/random/extreme_value_distribution.hpp
==============================================================================
--- trunk/boost/random/extreme_value_distribution.hpp (original)
+++ trunk/boost/random/extreme_value_distribution.hpp 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
@@ -101,7 +101,7 @@
 
     /**
      * Returns a random variate distributed accordint to the extreme
- * value distribution with parameters specified by @c parm.
+ * value distribution with parameters specified by @c param.
      */
     template<class URNG>
     RealType operator()(URNG& urng, const param_type& parm) const

Modified: trunk/boost/random/gamma_distribution.hpp
==============================================================================
--- trunk/boost/random/gamma_distribution.hpp (original)
+++ trunk/boost/random/gamma_distribution.hpp 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
@@ -32,7 +32,7 @@
  * parameters alpha and beta. It produces values > 0.
  *
  * It has
- * \f$p(x) = x^{\alpha-1}\frac{e^{-x/\beta}}{\beta^\alpha\Gamma(\alpha)}\f$.
+ * \f$\displaystyle p(x) = x^{\alpha-1}\frac{e^{-x/\beta}}{\beta^\alpha\Gamma(\alpha)}\f$.
  */
 template<class RealType = double>
 class gamma_distribution
@@ -52,8 +52,8 @@
          *
          * Requires: alpha > 0 && beta > 0
          */
- param_type(const RealType& alpha_arg = RealType(1),
- const RealType& beta_arg = RealType(1))
+ param_type(const RealType& alpha_arg = RealType(1.0),
+ const RealType& beta_arg = RealType(1.0))
           : _alpha(alpha_arg), _beta(beta_arg)
         {
         }
@@ -108,8 +108,8 @@
      *
      * Requires: alpha > 0 && beta > 0
      */
- explicit gamma_distribution(const result_type& alpha_arg = result_type(1),
- const result_type& beta_arg = result_type(1))
+ explicit gamma_distribution(const result_type& alpha_arg = result_type(1.0),
+ const result_type& beta_arg = result_type(1.0))
       : _exp(result_type(1)), _alpha(alpha_arg), _beta(beta_arg)
     {
         assert(_alpha > result_type(0));

Modified: trunk/boost/random/lognormal_distribution.hpp
==============================================================================
--- trunk/boost/random/lognormal_distribution.hpp (original)
+++ trunk/boost/random/lognormal_distribution.hpp 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
@@ -43,9 +43,9 @@
 /**
  * Instantiations of class template lognormal_distribution model a
  * \random_distribution. Such a distribution produces random numbers
- * with \f$p(x) = \frac{1}{x \sigma_N \sqrt{2\pi}} e^{\frac{-\left(\log(x)-\mu_N\right)^2}{2\sigma_N^2}}\f$
- * for x > 0, where \f$\mu_N = \log\left(\frac{\mu^2}{\sqrt{\sigma^2 + \mu^2}}\right)\f$ and
- * \f$\sigma_N = \sqrt{\log\left(1 + \frac{\sigma^2}{\mu^2}\right)}\f$.
+ * with \f$\displaystyle p(x) = \frac{1}{x \sigma_N \sqrt{2\pi}} e^{\frac{-\left(\log(x)-\mu_N\right)^2}{2\sigma_N^2}}\f$
+ * for x > 0, where \f$\displaystyle \mu_N = \log\left(\frac{\mu^2}{\sqrt{\sigma^2 + \mu^2}}\right)\f$ and
+ * \f$\displaystyle \sigma_N = \sqrt{\log\left(1 + \frac{\sigma^2}{\mu^2}\right)}\f$.
  */
 template<class RealType = double>
 class lognormal_distribution
@@ -62,8 +62,8 @@
    * Constructs a lognormal_distribution. @c mean and @c sigma are the
    * mean and standard deviation of the lognormal distribution.
    */
- explicit lognormal_distribution(result_type mean_arg = result_type(1),
- result_type sigma_arg = result_type(1))
+ explicit lognormal_distribution(result_type mean_arg = result_type(1.0),
+ result_type sigma_arg = result_type(1.0))
     : _mean(mean_arg), _sigma(sigma_arg)
   {
     assert(_mean > result_type(0));

Modified: trunk/boost/random/mersenne_twister.hpp
==============================================================================
--- trunk/boost/random/mersenne_twister.hpp (original)
+++ trunk/boost/random/mersenne_twister.hpp 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
@@ -371,6 +371,8 @@
     std::size_t i;
 };
 
+/// \cond
+
 #ifndef BOOST_NO_INCLASS_MEMBER_INITIALIZATION
 // A definition is required even for integral static constants
 #define BOOST_RANDOM_MT_DEFINE_CONSTANT(type, name) \
@@ -403,7 +405,6 @@
 #undef BOOST_RANDOM_MT_DEFINE_CONSTANT
 #endif
 
-/// \cond hide_private_members
 template<class UIntType,
          std::size_t w, std::size_t n, std::size_t m, std::size_t r,
          UIntType a, std::size_t u, UIntType d, std::size_t s,
@@ -483,7 +484,7 @@
  * Generation, Vol. 8, No. 1, January 1998, pp. 3-30.
  * @endblockquote
  */
-typedef random::mersenne_twister_engine<uint32_t,32,351,175,19,0xccab8ee7,
+typedef mersenne_twister_engine<uint32_t,32,351,175,19,0xccab8ee7,
     11,0xffffffff,7,0x31b6ab00,15,0xffe50000,17,1812433253> mt11213b;
 
 /**
@@ -497,11 +498,11 @@
  * Generation, Vol. 8, No. 1, January 1998, pp. 3-30.
  * @endblockquote
  */
-typedef random::mersenne_twister_engine<uint32_t,32,624,397,31,0x9908b0df,
+typedef mersenne_twister_engine<uint32_t,32,624,397,31,0x9908b0df,
     11,0xffffffff,7,0x9d2c5680,15,0xefc60000,18,1812433253> mt19937;
 
 #if !defined(BOOST_NO_INT64_T) && !defined(BOOST_NO_INTEGRAL_INT64_T)
-typedef random::mersenne_twister_engine<uint64_t,64,312,156,31,
+typedef mersenne_twister_engine<uint64_t,64,312,156,31,
     UINT64_C(0xb5026f5aa96619e9),29,UINT64_C(0x5555555555555555),17,
     UINT64_C(0x71d67fffeda60000),37,UINT64_C(0xfff7eee000000000),43,
     UINT64_C(6364136223846793005)> mt19937_64;

Modified: trunk/boost/random/normal_distribution.hpp
==============================================================================
--- trunk/boost/random/normal_distribution.hpp (original)
+++ trunk/boost/random/normal_distribution.hpp 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
@@ -29,7 +29,7 @@
  * Instantiations of class template normal_distribution model a
  * \random_distribution. Such a distribution produces random numbers
  * @c x distributed with probability density function
- * \f$p(x) = \frac{1}{\sqrt{2\pi\sigma}} e^{-\frac{(x-\mu)^2}{2\sigma^2}}\f$,
+ * \f$\displaystyle p(x) = \frac{1}{\sqrt{2\pi\sigma}} e^{-\frac{(x-\mu)^2}{2\sigma^2}}\f$,
  * where mean and sigma are the parameters of the distribution.
  */
 // deterministic Box-Muller method, uses trigonometric functions
@@ -50,8 +50,8 @@
    *
    * Requires: sigma > 0
    */
- explicit normal_distribution(const result_type& mean_arg = result_type(0),
- const result_type& sigma_arg = result_type(1))
+ explicit normal_distribution(const result_type& mean_arg = result_type(0.0),
+ const result_type& sigma_arg = result_type(1.0))
     : _mean(mean_arg), _sigma(sigma_arg),
       _r1(0), _r2(0), _cached_rho(0), _valid(false)
   {

Modified: trunk/boost/random/poisson_distribution.hpp
==============================================================================
--- trunk/boost/random/poisson_distribution.hpp (original)
+++ trunk/boost/random/poisson_distribution.hpp 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
@@ -155,7 +155,7 @@
 
     /**
      * Returns a random variate distributed according to the
- * poisson distribution with parameters specified by parm.
+ * poisson distribution with parameters specified by param.
      */
     template<class URNG>
     IntType operator()(URNG& urng, const param_type& parm) const

Modified: trunk/boost/random/triangle_distribution.hpp
==============================================================================
--- trunk/boost/random/triangle_distribution.hpp (original)
+++ trunk/boost/random/triangle_distribution.hpp 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
@@ -42,9 +42,9 @@
    *
    * Preconditions: a <= b <= c.
    */
- explicit triangle_distribution(result_type a_arg = result_type(0),
+ explicit triangle_distribution(result_type a_arg = result_type(0.0),
                                  result_type b_arg = result_type(0.5),
- result_type c_arg = result_type(1))
+ result_type c_arg = result_type(1.0))
     : _a(a_arg), _b(b_arg), _c(c_arg)
   {
     assert(_a <= _b && _b <= _c);

Modified: trunk/boost/random/uniform_real.hpp
==============================================================================
--- trunk/boost/random/uniform_real.hpp (original)
+++ trunk/boost/random/uniform_real.hpp 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
@@ -50,8 +50,8 @@
    *
    * Requires: min <= max
    */
- explicit uniform_real(RealType min_arg = RealType(0),
- RealType max_arg = RealType(1))
+ explicit uniform_real(RealType min_arg = RealType(0.0),
+ RealType max_arg = RealType(1.0))
     : _min(min_arg), _max(max_arg)
   {
 #ifndef BOOST_NO_LIMITS_COMPILE_TIME_CONSTANTS

Modified: trunk/boost/random/uniform_smallint.hpp
==============================================================================
--- trunk/boost/random/uniform_smallint.hpp (original)
+++ trunk/boost/random/uniform_smallint.hpp 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
@@ -38,43 +38,60 @@
  * underlying source of random numbers and thus makes no attempt to limit
  * quantization errors.
  *
- * Let r<sub>out</sub>=(max-min+1) the desired range of integer numbers, and
- * let r<sub>base</sub> be the range of the underlying source of random
+ * Let \f$r_{\mathtt{out}} = (\mbox{max}-\mbox{min}+1)\f$ the desired range of
+ * integer numbers, and
+ * let \f$r_{\mathtt{base}}\f$ be the range of the underlying source of random
  * numbers. Then, for the uniform distribution, the theoretical probability
- * for any number i in the range r<sub>out</sub> will be p<sub>out</sub>(i) =
- * 1/r<sub>out</sub>. Likewise, assume a uniform distribution on r<sub>base</sub> for
- * the underlying source of random numbers, i.e. p<sub>base</sub>(i) =
- * 1/r<sub>base</sub>. Let p<sub>out_s</sub>(i) denote the random
+ * for any number i in the range \f$r_{\mathtt{out}}\f$ will be
+ * \f$\displaystyle p_{\mathtt{out}}(i) = \frac{1}{r_{\mathtt{out}}}\f$.
+ * Likewise, assume a uniform distribution on \f$r_{\mathtt{base}}\f$ for
+ * the underlying source of random numbers, i.e.
+ * \f$\displaystyle p_{\mathtt{base}}(i) = \frac{1}{r_{\mathtt{base}}}\f$.
+ * Let \f$p_{\mathtt{out\_s}}(i)\f$ denote the random
  * distribution generated by @c uniform_smallint. Then the sum over all
- * i in r<sub>out</sub> of (p<sub>out_s</sub>(i)/p<sub>out</sub>(i) - 1)<sup>2</sup>
- * shall not exceed r<sub>out</sub>/r<sub>base</sub><sup>2</sup>
- * (r<sub>base</sub> mod r<sub>out</sub>)(r<sub>out</sub> -
- * r<sub>base</sub> mod r<sub>out</sub>).
+ * i in \f$r_{\mathtt{out}}\f$ of
+ * \f$\displaystyle
+ * \left(\frac{p_{\mathtt{out\_s}}(i)}{p_{\mathtt{out}}(i)} - 1\right)^2\f$
+ * shall not exceed
+ * \f$\displaystyle \frac{r_{\mathtt{out}}}{r_{\mathtt{base}}^2}
+ * (r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}})
+ * (r_{\mathtt{out}} - r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}})\f$.
  *
  * The template parameter IntType shall denote an integer-like value type.
  *
  * Note: The property above is the square sum of the relative differences
  * in probabilities between the desired uniform distribution
- * p<sub>out</sub>(i) and the generated distribution p<sub>out_s</sub>(i).
+ * \f$p_{\mathtt{out}}(i)\f$ and the generated distribution
+ * \f$p_{\mathtt{out\_s}}(i)\f$.
  * The property can be fulfilled with the calculation
- * (base_rng mod r<sub>out</sub>), as follows: Let r = r<sub>base</sub> mod
- * r<sub>out</sub>. The base distribution on r<sub>base</sub> is folded onto the
- * range r<sub>out</sub>. The numbers i < r have assigned (r<sub>base</sub>
- * div r<sub>out</sub>)+1 numbers of the base distribution, the rest has
- * only (r<sub>base</sub> div r<sub>out</sub>). Therefore,
- * p<sub>out_s</sub>(i) = ((r<sub>base</sub> div r<sub>out</sub>)+1) /
- * r<sub>base</sub> for i < r and p<sub>out_s</sub>(i) = (r<sub>base</sub>
- * div r<sub>out</sub>)/r<sub>base</sub> otherwise. Substituting this in the
+ * \f$(\mbox{base\_rng} \mbox{ mod } r_{\mathtt{out}})\f$, as follows:
+ * Let \f$r = r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}}\f$.
+ * The base distribution on \f$r_{\mathtt{base}}\f$ is folded onto the
+ * range \f$r_{\mathtt{out}}\f$. The numbers i < r have assigned
+ * \f$\displaystyle
+ * \left\lfloor\frac{r_{\mathtt{base}}}{r_{\mathtt{out}}}\right\rfloor+1\f$
+ * numbers of the base distribution, the rest has only \f$\displaystyle
+ * \left\lfloor\frac{r_{\mathtt{base}}}{r_{\mathtt{out}}}\right\rfloor\f$.
+ * Therefore,
+ * \f$\displaystyle p_{\mathtt{out\_s}}(i) =
+ * \left(\left\lfloor\frac{r_{\mathtt{base}}}
+ * {r_{\mathtt{out}}}\right\rfloor+1\right) /
+ * r_{\mathtt{base}}\f$ for i < r and \f$\displaystyle p_{\mathtt{out\_s}}(i) =
+ * \left\lfloor\frac{r_{\mathtt{base}}}
+ * {r_{\mathtt{out}}}\right\rfloor/r_{\mathtt{base}}\f$ otherwise.
+ * Substituting this in the
  * above sum formula leads to the desired result.
  *
- * Note: The upper bound for (r<sub>base</sub> mod r<sub>out</sub>)
- * (r<sub>out</sub> - r<sub>base</sub> mod r<sub>out</sub>) is
- * r<sub>out</sub><sup>2</sup>/4. Regarding the upper bound for the
- * square sum of the relative quantization error of
- * r<sub>out</sub><sup>3</sup>/(4*r<sub>base</sub><sup>2</sup>), it
- * seems wise to either choose r<sub>base</sub> so that r<sub>base</sub> >
- * 10*r<sub>out</sub><sup>2</sup> or ensure that r<sub>base</sub> is
- * divisible by r<sub>out</sub>.
+ * Note: The upper bound for
+ * \f$(r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}})
+ * (r_{\mathtt{out}} - r_{\mathtt{base}} \mbox{ mod } r_{\mathtt{out}})\f$ is
+ * \f$\displaystyle \frac{r_{\mathtt{out}}^2}{4}\f$. Regarding the upper bound
+ * for the square sum of the relative quantization error of
+ * \f$\displaystyle \frac{r_\mathtt{out}^3}{4r_{\mathtt{base}}^2}\f$, it
+ * seems wise to either choose \f$r_{\mathtt{base}}\f$ so that
+ * \f$r_{\mathtt{base}} > 10r_{\mathtt{out}}^2\f$ or ensure that
+ * \f$r_{\mathtt{base}}\f$ is
+ * divisible by \f$r_{\mathtt{out}}\f$.
  */
 template<class IntType = int>
 class uniform_smallint

Modified: trunk/boost/random/weibull_distribution.hpp
==============================================================================
--- trunk/boost/random/weibull_distribution.hpp (original)
+++ trunk/boost/random/weibull_distribution.hpp 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
@@ -102,7 +102,7 @@
 
     /**
      * Returns a random variate distributed accordint to the Weibull
- * distribution with parameters specified by @c parm.
+ * distribution with parameters specified by @c param.
      */
     template<class URNG>
     RealType operator()(URNG& urng, const param_type& parm) const

Modified: trunk/libs/random/doc/Jamfile.v2
==============================================================================
--- trunk/libs/random/doc/Jamfile.v2 (original)
+++ trunk/libs/random/doc/Jamfile.v2 2010-06-26 16:42:30 EDT (Sat, 26 Jun 2010)
@@ -102,11 +102,31 @@
     <doxygen:param>ENABLE_PREPROCESSING=YES
     <doxygen:param>MACRO_EXPANSION=YES
     <doxygen:param>SEARCH_INCLUDES=NO
+ # Expand macros and clean up a bunch of ugly names
     <doxygen:param>"PREDEFINED= \\
         \"BOOST_RANDOM_DOXYGEN=1\" \\
         \"BOOST_PREVENT_MACRO_SUBSTITUTION=\" \\
         \"BOOST_STATIC_ASSERT(x)=\" \\
         \"BOOST_STATIC_CONSTANT(type,value)=static const type value\" \\
+ \"UINT64_C(value)=value ## ull\" \\
+ \"BOOST_RANDOM_DECL=\" \\
+ \"RealType(x)=x\" \\
+ \"result_type(x)=x\" \\
+ \"p_arg=p\" \\
+ \"median_arg=median\" \\
+ \"mean_arg=mean\" \\
+ \"sigma_arg=sigma\" \\
+ \"lambda_arg=lambda\" \\
+ \"alpha_arg=alpha\" \\
+ \"beta_arg=beta\" \\
+ \"a_arg=a\" \\
+ \"b_arg=b\" \\
+ \"c_arg=c\" \\
+ \"t_arg=t\" \\
+ \"min_arg=min\" \\
+ \"max_arg=max\" \\
+ \"parm=param\" \\
+ \"aseed=seed\" \\
         \"BOOST_RANDOM_DETAIL_OSTREAM_OPERATOR(os,T,t)=template<class CharT, class Traits> friend std::basic_ostream<CharT,Traits>& operator<<(std::basic_ostream<CharT,Traits>& os, const T& t)\" \\
         \"BOOST_RANDOM_DETAIL_ISTREAM_OPERATOR(is,T,t)=template<class CharT, class Traits> friend std::basic_istream<CharT,Traits>& operator>>(std::basic_istream<CharT,Traits>& is, const T& t)\" \\
         \"BOOST_RANDOM_DETAIL_EQUALITY_OPERATOR(T,lhs,rhs)=friend bool operator==(const T& rhs, const T& rhs)\" \\


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