Imported Upstream version 1.72.0

[platform/upstream/boost.git] / libs / math / doc / distributions / dist_tutorial.qbk

diff --git a/libs/math/doc/distributions/dist_tutorial.qbk b/libs/math/doc/distributions/dist_tutorial.qbk
index 941794e..10037e5 100644 (file)
--- a/libs/math/doc/distributions/dist_tutorial.qbk
+++ b/libs/math/doc/distributions/dist_tutorial.qbk
@@ -14,37 +14,32 @@ This library is centred around statistical distributions, this tutorial
 will give you an overview of what they are, how they can be used, and
 provides a few worked examples of applying the library to statistical tests.
 
-[section:overview Overview of Distributions]
+[section:overview Overview of Statistical Distributions]
 
 [section:headers Headers and Namespaces]
 
-All the code in this library is inside namespace boost::math.
+All the code in this library is inside `namespace boost::math`.
 
 In order to use a distribution /my_distribution/ you will need to include
-either the header <boost/math/my_distribution.hpp> or
-the "include all the distributions" header: <boost/math/distributions.hpp>.
+either the header(s) `<boost/math/my_distribution.hpp>` (quicker compiles), or
+the "include all the distributions" header: `<boost/math/distributions.hpp>`.
 
 For example, to use the Students-t distribution include either
-<boost/math/students_t.hpp> or
-<boost/math/distributions.hpp>
+`<boost/math/students_t.hpp>` or
+`<boost/math/distributions.hpp>`
 
 You also need to bring distribution names into scope,
 perhaps with a `using namespace boost::math;` declaration,
 
 or specific  `using` declarations like `using boost::math::normal;` (*recommended*).
 
-[caution Some math function names are also used in namespace std so including <random> could cause ambiguity!]
+[caution Some math function names are also used in `namespace std` so including `<random>` could cause ambiguity!]
 
 [endsect] [/ section:headers Headers and Namespaces]
 
 [section:objects Distributions are Objects]
 
-Each kind of distribution in this library is a class type - an object.
-
-[link policy Policies] provide fine-grained control
-of the behaviour of these classes, allowing the user to customise
-behaviour such as how errors are handled, or how the quantiles
-of discrete distribtions behave.
+Each kind of distribution in this library is a class type - an object, with member functions.
 
 [tip If you are familiar with statistics libraries using functions,
 and 'Distributions as Objects' seem alien, see
@@ -52,6 +47,11 @@ and 'Distributions as Objects' seem alien, see
 other statistics libraries.]
 ] [/tip]
 
+[link policy Policies] provide optional fine-grained control
+of the behaviour of these classes, allowing the user to customise
+behaviour such as how errors are handled, or how the quantiles
+of discrete distributions behave.
+
 Making distributions class types does two things:
 
 * It encapsulates the kind of distribution in the C++ type system;
@@ -171,7 +171,7 @@ by placing a semi-colon or vertical bar)
 to separate the variate from the parameter(s) that defines the shape of the distribution.
 
 For example, the binomial distribution probability distribution function (PDF) is written as
-['f(k| n, p)] = Pr(K = k|n, p) = probability of observing k successes out of n trials.
+[role serif_italic ['f(k| n, p)] = Pr(K = k|n, p) = ] probability of observing k successes out of n trials.
 K is the __random_variable, k is the __random_variate, 
 the parameters are n (trials) and p (probability).
 ] [/tip Random Variates and Distribution Parameters]