|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r77846 - in trunk/libs/math/doc/sf_and_dist: . html html/index html/math_toolkit/constants
From: john_at_[hidden]
Date: 2012-04-09 04:38:09
Author: johnmaddock
Date: 2012-04-09 04:38:05 EDT (Mon, 09 Apr 2012)
New Revision: 77846
URL: http://svn.boost.org/trac/boost/changeset/77846
Log:
Fix bad value of constants.
Update intro to highlight use of constants with UDT's
Fix some formatting issues in the FAQ.
Text files modified:
trunk/libs/math/doc/sf_and_dist/constants.qbk | 15 ++++++++-------
trunk/libs/math/doc/sf_and_dist/html/index.html | 2 +-
trunk/libs/math/doc/sf_and_dist/html/index/s13.html | 4 ++--
trunk/libs/math/doc/sf_and_dist/html/index/s14.html | 4 ++--
trunk/libs/math/doc/sf_and_dist/html/index/s15.html | 4 ++--
trunk/libs/math/doc/sf_and_dist/html/index/s16.html | 4 ++--
trunk/libs/math/doc/sf_and_dist/html/index/s17.html | 4 ++--
trunk/libs/math/doc/sf_and_dist/html/math_toolkit/constants/FAQ.html | 12 ++++++------
trunk/libs/math/doc/sf_and_dist/html/math_toolkit/constants/constants.html | 4 ++--
trunk/libs/math/doc/sf_and_dist/html/math_toolkit/constants/intro.html | 8 ++++++--
10 files changed, 33 insertions(+), 28 deletions(-)
Modified: trunk/libs/math/doc/sf_and_dist/constants.qbk
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/constants.qbk (original)
+++ trunk/libs/math/doc/sf_and_dist/constants.qbk 2012-04-09 04:38:05 EDT (Mon, 09 Apr 2012)
@@ -10,9 +10,10 @@
``double area = pi * r * r;``
(If that's all you want, jump direct to [link math_toolkit.constants.tutorial.non_templ use in non-template code]!)
* Effortless - avoiding a search of reference sources.
+* Usable with both builtin floating point types, and user-defined, possibly extended precision, types such as
+NTL, MPFR/GMP, mp_float: in the latter case the constants are computed to the necessary precision and then cached.
* Accurate - ensuring that the values are as accurate as possible for the
-chosen floating-point type (both built-in and multiprecision user-defined type (UDT)
-floating-point like NTL, MPFR/GMP, mp_float).
+chosen floating-point type
* No loss of accuracy from repeated rounding of intermediate computations.
* Result is computed with higher precision and only rounded once.
* Less risk of inaccurate result from functions pow, trig and log at [@http://en.wikipedia.org/wiki/Corner_case corner cases].
@@ -282,8 +283,8 @@
[[root_two] [[radic]2] [1.41421] [] ]
[[root_three] [[radic]3] [1.73205] [] ]
[[half_root_two] [[radic]2 /2] [0.707106] [] ]
-[[ln_two] [ln(2)] [6.93147] [] ]
-[[ln_ln_two] [ln(ln(2))] [-3.66512] [Gumbel distribution median] ]
+[[ln_two] [ln(2)] [0.693147] [] ]
+[[ln_ln_two] [ln(ln(2))] [-0.366512] [Gumbel distribution median] ]
[[root_ln_four] [[radic]ln(4)] [1.177410] [] ]
[[one_div_root_two] [1/[radic]2] [0.707106] [] ]
@@ -641,7 +642,7 @@
but are licensed under the [@http://www.gnu.org/copyleft/lesser.html Lesser GPL license]
and are [*not licensed for commercial use].
-[h5 What happened to a previous collection of constants proposed for Boost?]
+[h4 What happened to a previous collection of constants proposed for Boost?]
A review concluded that the way in which the constants were presented did not meet many peoples needs.
None of the methods proposed met many users' essential requirement to allow writing simply `pi` rather than `pi()`.
@@ -654,14 +655,14 @@
but combined with template struct and functions to allow simultaneous use
with other non-built-in floating-point types.
-[h5 Why do the constants (internally) have a struct rather than a simple function?]
+[h4 Why do the constants (internally) have a struct rather than a simple function?]
A function mechanism was provided by in previous versions of Boost.Math.
The new mechanism is to permit partial specialization. See Custom Specializing a constant above.
It should also allow use with other packages like [@http://www.ttmath.org/ ttmath Bignum C++ library.]
-[h5 Where can I find other high precision constants?]
+[h4 Where can I find other high precision constants?]
# Constants with very high precision and good accuracy (>40 decimal digits)
from Simon Plouffe's web based collection [@http://pi.lacim.uqam.ca/eng/].
Modified: trunk/libs/math/doc/sf_and_dist/html/index.html
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/html/index.html (original)
+++ trunk/libs/math/doc/sf_and_dist/html/index.html 2012-04-09 04:38:05 EDT (Mon, 09 Apr 2012)
@@ -527,7 +527,7 @@
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: March 24, 2012 at 11:48:31 GMT</small></p></td>
+<td align="left"><p><small>Last revised: April 09, 2012 at 08:30:08 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
Modified: trunk/libs/math/doc/sf_and_dist/html/index/s13.html
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/html/index/s13.html (original)
+++ trunk/libs/math/doc/sf_and_dist/html/index/s13.html 2012-04-09 04:38:05 EDT (Mon, 09 Apr 2012)
@@ -22,9 +22,9 @@
<div class="spirit-nav">
<a accesskey="p" href="../math_toolkit/status/credits.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="s14.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section id1487367">
+<div class="section id1486108">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id1487367"></a>Function Index</h2></div></div></div>
+<a name="id1486108"></a>Function Index</h2></div></div></div>
<p><a class="link" href="s13.html#idx_id_0">A</a> <a class="link" href="s13.html#idx_id_1">B</a> <a class="link" href="s13.html#idx_id_2">C</a> <a class="link" href="s13.html#idx_id_3">D</a> <a class="link" href="s13.html#idx_id_4">E</a> <a class="link" href="s13.html#idx_id_5">F</a> <a class="link" href="s13.html#idx_id_6">G</a> <a class="link" href="s13.html#idx_id_7">H</a> <a class="link" href="s13.html#idx_id_8">I</a> <a class="link" href="s13.html#idx_id_9">K</a> <a class="link" href="s13.html#idx_id_10">L</a> <a class="link" href="s13.html#idx_id_11">M</a> <a class="link" href="s13.html#idx_id_12">N</a> <a class="link" href="s13.html#idx_id_14">P</a> <a class="link" href="s13.html#idx_id_15">Q</a> <a class="link" href="s13.html#idx_id_16">R</a> <a class="link" href="s13.html#idx_id_17">S</a> <a class="link" href="s13.html#idx_id_18">T</a> <a class="link" href="s13.html#idx_id_19">U</a> <a class="link" href="s13.html#idx_id_20">V</a> <a class="link" href="s13.html#idx_id_21">W</a> <a class="link" href=
"s13.html#idx_id_22">Z</a></p>
<div class="variablelist"><dl>
<dt>
Modified: trunk/libs/math/doc/sf_and_dist/html/index/s14.html
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/html/index/s14.html (original)
+++ trunk/libs/math/doc/sf_and_dist/html/index/s14.html 2012-04-09 04:38:05 EDT (Mon, 09 Apr 2012)
@@ -22,9 +22,9 @@
<div class="spirit-nav">
<a accesskey="p" href="s13.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="s15.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section id1502492">
+<div class="section id1501232">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id1502492"></a>Class Index</h2></div></div></div>
+<a name="id1501232"></a>Class Index</h2></div></div></div>
<p><a class="link" href="s14.html#idx_id_24">B</a> <a class="link" href="s14.html#idx_id_25">C</a> <a class="link" href="s14.html#idx_id_26">D</a> <a class="link" href="s14.html#idx_id_27">E</a> <a class="link" href="s14.html#idx_id_28">F</a> <a class="link" href="s14.html#idx_id_29">G</a> <a class="link" href="s14.html#idx_id_30">H</a> <a class="link" href="s14.html#idx_id_31">I</a> <a class="link" href="s14.html#idx_id_33">L</a> <a class="link" href="s14.html#idx_id_34">M</a> <a class="link" href="s14.html#idx_id_35">N</a> <a class="link" href="s14.html#idx_id_37">P</a> <a class="link" href="s14.html#idx_id_39">R</a> <a class="link" href="s14.html#idx_id_40">S</a> <a class="link" href="s14.html#idx_id_41">T</a> <a class="link" href="s14.html#idx_id_42">U</a> <a class="link" href="s14.html#idx_id_44">W</a></p>
<div class="variablelist"><dl>
<dt>
Modified: trunk/libs/math/doc/sf_and_dist/html/index/s15.html
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/html/index/s15.html (original)
+++ trunk/libs/math/doc/sf_and_dist/html/index/s15.html 2012-04-09 04:38:05 EDT (Mon, 09 Apr 2012)
@@ -22,9 +22,9 @@
<div class="spirit-nav">
<a accesskey="p" href="s14.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="s16.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section id1503424">
+<div class="section id1502165">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id1503424"></a>Typedef Index</h2></div></div></div>
+<a name="id1502165"></a>Typedef Index</h2></div></div></div>
<p><a class="link" href="s15.html#idx_id_46">A</a> <a class="link" href="s15.html#idx_id_47">B</a> <a class="link" href="s15.html#idx_id_48">C</a> <a class="link" href="s15.html#idx_id_49">D</a> <a class="link" href="s15.html#idx_id_50">E</a> <a class="link" href="s15.html#idx_id_51">F</a> <a class="link" href="s15.html#idx_id_52">G</a> <a class="link" href="s15.html#idx_id_53">H</a> <a class="link" href="s15.html#idx_id_54">I</a> <a class="link" href="s15.html#idx_id_56">L</a> <a class="link" href="s15.html#idx_id_58">N</a> <a class="link" href="s15.html#idx_id_59">O</a> <a class="link" href="s15.html#idx_id_60">P</a> <a class="link" href="s15.html#idx_id_62">R</a> <a class="link" href="s15.html#idx_id_63">S</a> <a class="link" href="s15.html#idx_id_64">T</a> <a class="link" href="s15.html#idx_id_65">U</a> <a class="link" href="s15.html#idx_id_66">V</a> <a class="link" href="s15.html#idx_id_67">W</a></p>
<div class="variablelist"><dl>
<dt>
Modified: trunk/libs/math/doc/sf_and_dist/html/index/s16.html
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/html/index/s16.html (original)
+++ trunk/libs/math/doc/sf_and_dist/html/index/s16.html 2012-04-09 04:38:05 EDT (Mon, 09 Apr 2012)
@@ -22,9 +22,9 @@
<div class="spirit-nav">
<a accesskey="p" href="s15.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="s17.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
-<div class="section id1506991">
+<div class="section id1506278">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id1506991"></a>Macro Index</h2></div></div></div>
+<a name="id1506278"></a>Macro Index</h2></div></div></div>
<p><a class="link" href="s16.html#idx_id_70">B</a> <a class="link" href="s16.html#idx_id_74">F</a></p>
<div class="variablelist"><dl>
<dt>
Modified: trunk/libs/math/doc/sf_and_dist/html/index/s17.html
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/html/index/s17.html (original)
+++ trunk/libs/math/doc/sf_and_dist/html/index/s17.html 2012-04-09 04:38:05 EDT (Mon, 09 Apr 2012)
@@ -21,9 +21,9 @@
<div class="spirit-nav">
<a accesskey="p" href="s16.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a>
</div>
-<div class="section id1508218">
+<div class="section id1507504">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
-<a name="id1508218"></a>Index</h2></div></div></div>
+<a name="id1507504"></a>Index</h2></div></div></div>
<p><a class="link" href="s17.html#idx_id_92">A</a> <a class="link" href="s17.html#idx_id_93">B</a> <a class="link" href="s17.html#idx_id_94">C</a> <a class="link" href="s17.html#idx_id_95">D</a> <a class="link" href="s17.html#idx_id_96">E</a> <a class="link" href="s17.html#idx_id_97">F</a> <a class="link" href="s17.html#idx_id_98">G</a> <a class="link" href="s17.html#idx_id_99">H</a> <a class="link" href="s17.html#idx_id_100">I</a> <a class="link" href="s17.html#idx_id_101">K</a> <a class="link" href="s17.html#idx_id_102">L</a> <a class="link" href="s17.html#idx_id_103">M</a> <a class="link" href="s17.html#idx_id_104">N</a> <a class="link" href="s17.html#idx_id_105">O</a> <a class="link" href="s17.html#idx_id_106">P</a> <a class="link" href="s17.html#idx_id_107">Q</a> <a class="link" href="s17.html#idx_id_108">R</a> <a class="link" href="s17.html#idx_id_109">S</a> <a class="link" href="s17.html#idx_id_110">T</a> <a class="link" href="s17.html#idx_id_111">U</a> <a class="link" href="s17.html#idx_id_112">V</a
> <a class="link" href="s17.html#idx_id_113">W</a> <a class="link" href="s17.html#idx_id_114">Z</a></p>
<div class="variablelist"><dl>
<dt>
Modified: trunk/libs/math/doc/sf_and_dist/html/math_toolkit/constants/FAQ.html
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/html/math_toolkit/constants/FAQ.html (original)
+++ trunk/libs/math/doc/sf_and_dist/html/math_toolkit/constants/FAQ.html 2012-04-09 04:38:05 EDT (Mon, 09 Apr 2012)
@@ -357,11 +357,11 @@
have also been used to compute constants, but are licensed under the Lesser GPL license
and are <span class="bold"><strong>not licensed for commercial use</strong></span>.
</p>
-<h6>
+<h5>
<a name="math_toolkit.constants.FAQ.h13"></a>
<span><a name="math_toolkit.constants.FAQ.what_happened_to_a_previous_collection_of_constants_proposed_for_boost_"></a></span><a class="link" href="FAQ.html#math_toolkit.constants.FAQ.what_happened_to_a_previous_collection_of_constants_proposed_for_boost_">What
happened to a previous collection of constants proposed for Boost?</a>
- </h6>
+ </h5>
<p>
A review concluded that the way in which the constants were presented did
not meet many peoples needs. None of the methods proposed met many users'
@@ -380,11 +380,11 @@
functions to allow simultaneous use with other non-built-in floating-point
types.
</p>
-<h6>
+<h5>
<a name="math_toolkit.constants.FAQ.h14"></a>
<span><a name="math_toolkit.constants.FAQ.why_do_the_constants__internally__have_a_struct_rather_than_a_simple_function_"></a></span><a class="link" href="FAQ.html#math_toolkit.constants.FAQ.why_do_the_constants__internally__have_a_struct_rather_than_a_simple_function_">Why
do the constants (internally) have a struct rather than a simple function?</a>
- </h6>
+ </h5>
<p>
A function mechanism was provided by in previous versions of Boost.Math.
</p>
@@ -392,11 +392,11 @@
The new mechanism is to permit partial specialization. See Custom Specializing
a constant above. It should also allow use with other packages like ttmath Bignum C++ library.
</p>
-<h6>
+<h5>
<a name="math_toolkit.constants.FAQ.h15"></a>
<span><a name="math_toolkit.constants.FAQ.where_can_i_find_other_high_precision_constants_"></a></span><a class="link" href="FAQ.html#math_toolkit.constants.FAQ.where_can_i_find_other_high_precision_constants_">Where
can I find other high precision constants?</a>
- </h6>
+ </h5>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
Constants with very high precision and good accuracy (>40 decimal
Modified: trunk/libs/math/doc/sf_and_dist/html/math_toolkit/constants/constants.html
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/html/math_toolkit/constants/constants.html (original)
+++ trunk/libs/math/doc/sf_and_dist/html/math_toolkit/constants/constants.html 2012-04-09 04:38:05 EDT (Mon, 09 Apr 2012)
@@ -234,7 +234,7 @@
</td>
<td>
<p>
- 6.93147
+ 0.693147
</p>
</td>
<td>
@@ -253,7 +253,7 @@
</td>
<td>
<p>
- -3.66512
+ -0.366512
</p>
</td>
<td>
Modified: trunk/libs/math/doc/sf_and_dist/html/math_toolkit/constants/intro.html
==============================================================================
--- trunk/libs/math/doc/sf_and_dist/html/math_toolkit/constants/intro.html (original)
+++ trunk/libs/math/doc/sf_and_dist/html/math_toolkit/constants/intro.html 2012-04-09 04:38:05 EDT (Mon, 09 Apr 2012)
@@ -46,9 +46,13 @@
Effortless - avoiding a search of reference sources.
</li>
<li class="listitem">
+ Usable with both builtin floating point types, and user-defined, possibly
+ extended precision, types such as NTL, MPFR/GMP, mp_float: in the latter
+ case the constants are computed to the necessary precision and then cached.
+ </li>
+<li class="listitem">
Accurate - ensuring that the values are as accurate as possible for the
- chosen floating-point type (both built-in and multiprecision user-defined
- type (UDT) floating-point like NTL, MPFR/GMP, mp_float).
+ chosen floating-point type
<div class="itemizedlist"><ul class="itemizedlist" type="circle">
<li class="listitem">
No loss of accuracy from repeated rounding of intermediate computations.
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk