Subject: [Boost-commit] svn:boost r65172 - trunk/libs/math/doc/sf_and_dist
From: pbristow_at_[hidden]
Date: 2010-09-01 14:04:46
Author: pbristow
Date: 2010-09-01 14:04:34 EDT (Wed, 01 Sep 2010)
New Revision: 65172
URL: http://svn.boost.org/trac/boost/changeset/65172
Log:
Minor editorial updates.
Text files modified:
trunk/libs/math/doc/sf_and_dist/math.qbk | 12 ++++++------
trunk/libs/math/doc/sf_and_dist/policy.qbk | 4 ++--
trunk/libs/math/doc/sf_and_dist/policy_tutorial.qbk | 4 ++--
trunk/libs/math/doc/sf_and_dist/references.qbk | 8 ++++++--
trunk/libs/math/doc/sf_and_dist/roadmap.qbk | 7 ++++++-
trunk/libs/math/doc/sf_and_dist/structure.qbk | 4 ++++
6 files changed, 26 insertions(+), 13 deletions(-)
Modified: trunk/libs/math/doc/sf_and_dist/math.qbk
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/math.qbk (original)
+++ trunk/libs/math/doc/sf_and_dist/math.qbk 2010-09-01 14:04:34 EDT (Wed, 01 Sep 2010)
@@ -1,15 +1,13 @@
[article Math Toolkit
- [quickbook 1.4]
- [copyright 2006, 2007, 2008, 2009 John Maddock, Paul A. Bristow, Hubert Holin, Xiaogang Zhang, Bruno Lalande, Johan Råde, Gautam Sewani and Thijs van den Berg]
- [purpose ISBN 0-9504833-2-X 978-0-9504833-2-0, Classification 519.2-dc22]
+ [quickbook 1.5]
+ [copyright 2006, 2007, 2008, 2009, 2010 John Maddock, Paul A. Bristow, Hubert Holin, Xiaogang Zhang, Bruno Lalande, Johan RÃ¥de, Gautam Sewani and Thijs van den Berg]
+ [/purpose ISBN 0-9504833-2-X 978-0-9504833-2-0, Classification 519.2-dc22]
[license
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])
]
- [authors [Maddock, John], [Bristow, Paul A.], [Holin, Hubert], [Zhang, Xiaogang], [Lalande, Bruno], [Råde, Johan], [Sewani, Gautam], [van den Berg, Thijs]]
- [category math]
- [purpose mathematics]
+ [authors [Maddock, John], [Bristow, Paul A.], [Holin, Hubert], [Zhang, Xiaogang], [Lalande, Bruno], [RÃ¥de, Johan], [Sewani, Gautam], [van den Berg, Thijs]]
[/last-revision $Date$]
]
@@ -59,6 +57,8 @@
[def __NTL_RR [@http://shoup.net/ntl/doc/RR.txt NTL::RR]]
[def __NTL_quad_float [@http://shoup.net/ntl/doc/quad_float.txt NTL::quad_float]]
+[def __R [@http://www.r-project.org/ The R Project for Statistical Computing]]
+
[def __godfrey [link godfrey Godfrey]]
[def __pugh [link pugh Pugh]]
Modified: trunk/libs/math/doc/sf_and_dist/policy.qbk
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/policy.qbk (original)
+++ trunk/libs/math/doc/sf_and_dist/policy.qbk 2010-09-01 14:04:34 EDT (Wed, 01 Sep 2010)
@@ -878,8 +878,8 @@
[endsect][/section:pol_ref Policy Reference]
[endsect][/section:policy Policies]
-[/ math.qbk
- Copyright 2007 John Maddock and Paul A. Bristow.
+[/ policy.qbk
+ Copyright 2007, 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/policy_tutorial.qbk
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/policy_tutorial.qbk (original)
+++ trunk/libs/math/doc/sf_and_dist/policy_tutorial.qbk 2010-09-01 14:04:34 EDT (Wed, 01 Sep 2010)
@@ -288,7 +288,7 @@
[policy_eg_5]
-Handling the statistical distributions is very similar except that now
+Handling policies for the statistical distributions is very similar except that now
the macro BOOST_MATH_DECLARE_DISTRIBUTIONS accepts two parameters: the
floating point type to use, and the policy type to apply. For example:
@@ -306,7 +306,7 @@
[policy_eg_6]
[note
-There is an important limitation to note: you can not use the macros
+There is an important limitation to note: you can [*not*] use the macros
BOOST_MATH_DECLARE_DISTRIBUTIONS and BOOST_MATH_DECLARE_SPECIAL_FUNCTIONS
['in the same namespace], as doing so creates ambiguities between functions
and distributions of the same name.
Modified: trunk/libs/math/doc/sf_and_dist/references.qbk
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/references.qbk (original)
+++ trunk/libs/math/doc/sf_and_dist/references.qbk 2010-09-01 14:04:34 EDT (Wed, 01 Sep 2010)
@@ -31,7 +31,7 @@
Statistical Distributions (Wiley Series in Probability & Statistics) (Paperback)
by N.A.J. Hastings, Brian Peacock, Merran Evans, ISBN: 0471371246, Wiley 2000.
-[@http://www.worldscibooks.com/mathematics/p191.html EXTREME VALUE DISTRIBUTIONS, Theory and Applications]
+[@http://www.worldscibooks.com/mathematics/p191.html Extreme Value Distributions, Theory and Applications]
Samuel Kotz & Saralees Nadarajah, ISBN 978-1-86094-224-2 & 1-86094-224-5 Oct 2000,
Chapter 1.2 discusses the various extreme value distributions.
@@ -61,7 +61,7 @@
[@http://www.softintegration.com/docs/package/chnagstat/ http://www.softintegration.com/docs/package/chnagstat/]
-[@http://www.nag.com/numeric/numerical_libraries.asp NAG ]libraries.
+[@http://www.nag.com/numeric/numerical_libraries.asp NAG] libraries.
[@http://www.mathcad.com MathCAD]
@@ -75,6 +75,10 @@
[@http://www.cas.lancs.ac.uk/glossary_v1.1/prob.html#probdistn Statistics Glossary], Valerie Easton and John H. McColl.
+[__R]
+
+For use of R, Jim Albert, Bayesian Computation with R, ISBN 978-0-387-71384-7.
+
[endsect] [/section:references References]
[/
Copyright 2006 John Maddock and Paul A. Bristow.
Modified: trunk/libs/math/doc/sf_and_dist/roadmap.qbk
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/roadmap.qbk (original)
+++ trunk/libs/math/doc/sf_and_dist/roadmap.qbk 2010-09-01 14:04:34 EDT (Wed, 01 Sep 2010)
@@ -1,5 +1,10 @@
[template history[]
+[h4 Boost-1.45.0]
+
+* Added warnings about potential ambiguity with std random library in distribution and function names.
+* Added inverse gamma distribution at request of Thomas Mang.
+
[h4 Boost-1.44.0]
* Fixed incorrect range and support for Rayleigh distribution.
@@ -8,7 +13,7 @@
[h4 Boost-1.41.0]
-* Significantly improved performance for the incomplete gamma function and it's inverse.
+* Significantly improved performance for the incomplete gamma function and its inverse.
[h4 Boost-1.40.0]
Modified: trunk/libs/math/doc/sf_and_dist/structure.qbk
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/structure.qbk (original)
+++ trunk/libs/math/doc/sf_and_dist/structure.qbk 2010-09-01 14:04:34 EDT (Wed, 01 Sep 2010)
@@ -109,6 +109,10 @@
student_t mydist(10);
+[note Some distribution names are also used in std random library,
+so to avoid the risk of ambiguity it is better to make explicit using declarations,
+for example: `using boost::math::students_t_distribution`]
+
Functions not intended for use by applications are in `boost::math::detail`.
Functions that may have more general use, like `digits`