[Boost-commit] svn:boost r38569 - sandbox/math_toolkit/libs/math/doc

From: pbristow_at_[hidden]
Date: 2007-08-10 11:46:56

Author: pbristow
Date: 2007-08-10 11:46:54 EDT (Fri, 10 Aug 2007)
New Revision: 38569
URL: http://svn.boost.org/trac/boost/changeset/38569

Log:
Added two links to policy and used them once, but some still todo.
Text files modified: 
   sandbox/math_toolkit/libs/math/doc/dist_tutorial.qbk |     5 ++++-                                   
   sandbox/math_toolkit/libs/math/doc/math.qbk          |     5 +++--                                   
   2 files changed, 7 insertions(+), 3 deletions(-)

Modified: sandbox/math_toolkit/libs/math/doc/dist_tutorial.qbk
==============================================================================
--- sandbox/math_toolkit/libs/math/doc/dist_tutorial.qbk	(original)
+++ sandbox/math_toolkit/libs/math/doc/dist_tutorial.qbk	2007-08-10 11:46:54 EDT (Fri, 10 Aug 2007)
@@ -189,13 +189,16 @@
 or `ceil` functions on the random variate prior to calling the distribution 
 function.
 
-TODO: this is out of date, rewrite when we have a tutorial to link to.
 Likewise the `quantile` function will return a real value: users should use
 either the `floor` or `ceil` functions to convert the result to the nearest
 integer.  However, whether it makes more sense to take the floor or the 
 ceiling of the result, depends both on the distribution, and the particular 
 use case.  So some common sense needs to be applied as well!
 
+[link __Policy Policies] provide a specific method of controlling
+the behaviour of any or all the discrete distributions using
+[link __math_discrete policies].
+
 For similar reasons continuous distributions with parameters like "degrees of freedom"
 that might appear to be integral, are treated as real values
 (and are promoted from integer to floating-point if necessary).

Modified: sandbox/math_toolkit/libs/math/doc/math.qbk
==============================================================================
--- sandbox/math_toolkit/libs/math/doc/math.qbk	(original)
+++ sandbox/math_toolkit/libs/math/doc/math.qbk	2007-08-10 11:46:54 EDT (Fri, 10 Aug 2007)
@@ -40,10 +40,10 @@
 [def __godfrey [link godfrey Godfrey]]
 [def __pugh [link pugh Pugh]]
 
-[def __caution This is an official Boost library, but remains a library under 
+[def __caution This is now an official Boost library, but remains a library under 
                construction, the code is fully functional and robust, but 
                interfaces, library structure, and function and distribution names
-               may be changed without notice.]
+               may still be changed without notice.]
                
 [template tr1[] [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2005/n1836.pdf Technical Report on C++ Library Extensions]]
 [template jm_rationals[] [link math_toolkit.backgrounders.implementation.rational_approximations_used devised by JM]]
@@ -183,6 +183,7 @@
 [def __Policy [link math_toolkit.policy Policy]]
 [def __policy_class [link math_toolkit.policy.pol_ref.pol_ref_ref policies::policy<>]]
 [def __math_undefined [link math_toolkit.policy.pol_ref.assert_undefined mathematically undefined function]]
+[def __math_discrete [link math_toolkit.policy.pol_ref.discrete_quant_ref Discrete Quantile Policies function]]
 
 [def __usual_accessors __cdf, __pdf, __quantile, __hazard, 
    __chf, __mean, __median, __mode, __variance, __sd, __skewness,