[Boost-commit] svn:boost r65110 - trunk/libs/math/doc/sf_and_dist

Subject: [Boost-commit] svn:boost r65110 - trunk/libs/math/doc/sf_and_dist
From: pbristow_at_[hidden]
Date: 2010-08-29 14:04:09

Author: pbristow
Date: 2010-08-29 14:04:08 EDT (Sun, 29 Aug 2010)
New Revision: 65110
URL: http://svn.boost.org/trac/boost/changeset/65110

Log:
Added inverse_gamma distribution
Text files modified: 
   trunk/libs/math/doc/sf_and_dist/dist_reference.qbk |     3 ++-                                     
   trunk/libs/math/doc/sf_and_dist/dist_tutorial.qbk  |    12 ++++++++++--                            
   2 files changed, 12 insertions(+), 3 deletions(-)

Modified: trunk/libs/math/doc/sf_and_dist/dist_reference.qbk
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/dist_reference.qbk	(original)
+++ trunk/libs/math/doc/sf_and_dist/dist_reference.qbk	2010-08-29 14:04:08 EDT (Sun, 29 Aug 2010)
@@ -13,6 +13,7 @@
 [include distributions/extreme_value.qbk]
 [include distributions/fisher.qbk]
 [include distributions/gamma.qbk]
+[include distributions/inverse_gamma.qbk]
 [include distributions/hypergeometric.qbk]
 [include distributions/laplace.qbk]
 [include distributions/logistic.qbk]
@@ -121,7 +122,7 @@
 [endsect][/section:future Extras Future Directions]
 
 [/ dist_reference.qbk
-  Copyright 2006 John Maddock and Paul A. Bristow.
+  Copyright 2006, 2010 John Maddock and Paul A. Bristow.
   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).

Modified: trunk/libs/math/doc/sf_and_dist/dist_tutorial.qbk
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/dist_tutorial.qbk	(original)
+++ trunk/libs/math/doc/sf_and_dist/dist_tutorial.qbk	2010-08-29 14:04:08 EDT (Sun, 29 Aug 2010)
@@ -19,6 +19,8 @@
 
 All the code in this library is inside namespace boost::math.
 
+[note Some math function names are also used in namespace std so including <random> could cause ambiguity.]
+
 In order to use a distribution /my_distribution/ you will need to include
 either the header <boost/math/distributions/my_distribution.hpp> or
 the "include everything" header: <boost/math/distributions.hpp>.
@@ -63,7 +65,12 @@
 is nearly as convenient).
 Probably 95% of uses are covered by these typedefs:
 
-   using namespace boost::math;
+   // using namespace boost::math; // Avoid potential ambiguity with names in std <random>
+   // Safer to declare specific functions with using statement(s):
+
+   using boost::math::beta_distribution;
+   using boost::math::binomial_distribution;
+   using boost::math::students_t;
 
    // Construct a students_t distribution with 4 degrees of freedom:
    students_t d1(4);
@@ -412,6 +419,7 @@
 [include distributions/binomial_example.qbk]
 [include distributions/negative_binomial_example.qbk]
 [include distributions/normal_example.qbk]
+[include distributions/inverse_gamma_example.qbk]
 [include distributions/nc_chi_squared_example.qbk]
 [include distributions/error_handling_example.qbk]
 [include distributions/find_location_and_scale.qbk]
@@ -424,7 +432,7 @@
 [endsect] [/ section:stat_tut Statistical Distributions Tutorial]
 
 [/ dist_tutorial.qbk
-  Copyright 2006 John Maddock and Paul A. Bristow.
+  Copyright 2006, 2010 John Maddock and Paul A. Bristow.
   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).