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

From: pbristow_at_[hidden]
Date: 2007-08-24 12:36:11

Author: pbristow
Date: 2007-08-24 12:36:10 EDT (Fri, 24 Aug 2007)
New Revision: 38909
URL: http://svn.boost.org/trac/boost/changeset/38909

Log:
Removal of coinflip qbk
Removed:
   sandbox/math_toolkit/libs/math/doc/distributions/binomial_coinflip_example.qbk
Text files modified: 
   sandbox/math_toolkit/libs/math/doc/distributions/non_members.qbk |     4 +++-                                    
   sandbox/math_toolkit/libs/math/doc/distributions/normal.qbk      |     8 ++++++--                                
   2 files changed, 9 insertions(+), 3 deletions(-)

Deleted: sandbox/math_toolkit/libs/math/doc/distributions/binomial_coinflip_example.qbk
==============================================================================
--- sandbox/math_toolkit/libs/math/doc/distributions/binomial_coinflip_example.qbk	2007-08-24 12:36:10 EDT (Fri, 24 Aug 2007)
+++ (empty file)
@@ -1,11 +0,0 @@
-[section:binomial_coinflip_example_example Binomial Coin-Flipping Example Example]
-
-[import ../../example/binomial_coinflip_example.cpp]
-[binomial_coinflip_example1]
-
-See [@../../example/binomial_coinflip_example.cpp binomial_coinflip_example.cpp]
-for full source code the program output looks like this:
-
-[binomial_coinflip_example_output]
-
-[endsect] [/section:binomial_coinflip_example_example Binomial Coin-Flipping example]

Modified: sandbox/math_toolkit/libs/math/doc/distributions/non_members.qbk
==============================================================================
--- sandbox/math_toolkit/libs/math/doc/distributions/non_members.qbk	(original)
+++ sandbox/math_toolkit/libs/math/doc/distributions/non_members.qbk	2007-08-24 12:36:10 EDT (Fri, 24 Aug 2007)
@@ -98,11 +98,13 @@
    // print survival function for x=2.0:
    std::cout << cdf(complement(norm, 2.0)) << std::endl;
 
-For example the following graph shows the complement of the cdf for the
+For example the following graph shows the __complement of the cdf for the
 normal distribution:
 
 [$../graphs/survival.png]
 
+See __why_complement for why the complement is useful and when it should be used.
+
 [h4 [#math.dist.hazard]Hazard Function]
 
    template <class RealType, class ``__Policy``>

Modified: sandbox/math_toolkit/libs/math/doc/distributions/normal.qbk
==============================================================================
--- sandbox/math_toolkit/libs/math/doc/distributions/normal.qbk	(original)
+++ sandbox/math_toolkit/libs/math/doc/distributions/normal.qbk	2007-08-24 12:36:10 EDT (Fri, 24 Aug 2007)
@@ -49,12 +49,16 @@
 Requires sd > 0, otherwise __domain_error is called.
 
    RealType mean()const;
+   RealType location()const;   
    
-Returns the /mean/ of this distribution.
+both return the /mean/ of this distribution.
    
    RealType standard_deviation()const;
+   RealType scale()const;
       
-Returns the /standard deviation/ of this distribution.
+both return the /standard deviation/ of this distribution.
+(Redundant location and scale function are provided to match other similar distributions,
+allowing the functions find_location and find_scale to be used generically).
 
 [h4 Non-member Accessors]