Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r85356 - in trunk/libs/multiprecision/doc: . html html/boost_multiprecision/indexes html/boost_multiprecision/tut/floats
From: john_at_[hidden]
Date: 2013-08-15 07:55:21


Author: johnmaddock
Date: 2013-08-15 07:55:21 EDT (Thu, 15 Aug 2013)
New Revision: 85356
URL: http://svn.boost.org/trac/boost/changeset/85356

Log:
Update float128 docs.

Text files modified:
   trunk/libs/multiprecision/doc/html/boost_multiprecision/indexes/s01.html | 2 +-
   trunk/libs/multiprecision/doc/html/boost_multiprecision/indexes/s02.html | 2 +-
   trunk/libs/multiprecision/doc/html/boost_multiprecision/indexes/s03.html | 2 +-
   trunk/libs/multiprecision/doc/html/boost_multiprecision/indexes/s04.html | 12 +++++++++++-
   trunk/libs/multiprecision/doc/html/boost_multiprecision/tut/floats/float128.html | 16 ++++++++++++++--
   trunk/libs/multiprecision/doc/html/index.html | 2 +-
   trunk/libs/multiprecision/doc/multiprecision.qbk | 7 +++++--
   7 files changed, 34 insertions(+), 9 deletions(-)

Modified: trunk/libs/multiprecision/doc/html/boost_multiprecision/indexes/s01.html
==============================================================================
--- trunk/libs/multiprecision/doc/html/boost_multiprecision/indexes/s01.html Thu Aug 15 07:21:20 2013 (r85355)
+++ trunk/libs/multiprecision/doc/html/boost_multiprecision/indexes/s01.html 2013-08-15 07:55:21 EDT (Thu, 15 Aug 2013) (r85356)
@@ -24,7 +24,7 @@
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h3 class="title">
-<a name="id991805"></a>Function Index</h3></div></div></div>
+<a name="id990781"></a>Function Index</h3></div></div></div>
 <p><a class="link" href="s01.html#idx_id_0">A</a> <a class="link" href="s01.html#idx_id_1">B</a> <a class="link" href="s01.html#idx_id_2">C</a> <a class="link" href="s01.html#idx_id_3">D</a> <a class="link" href="s01.html#idx_id_4">E</a> <a class="link" href="s01.html#idx_id_5">F</a> <a class="link" href="s01.html#idx_id_7">I</a> <a class="link" href="s01.html#idx_id_8">L</a> <a class="link" href="s01.html#idx_id_9">M</a> <a class="link" href="s01.html#idx_id_11">O</a> <a class="link" href="s01.html#idx_id_12">P</a> <a class="link" href="s01.html#idx_id_13">R</a> <a class="link" href="s01.html#idx_id_14">S</a> <a class="link" href="s01.html#idx_id_15">T</a> <a class="link" href="s01.html#idx_id_17">V</a> <a class="link" href="s01.html#idx_id_18">Z</a></p>
 <div class="variablelist"><dl class="variablelist">
 <dt>

Modified: trunk/libs/multiprecision/doc/html/boost_multiprecision/indexes/s02.html
==============================================================================
--- trunk/libs/multiprecision/doc/html/boost_multiprecision/indexes/s02.html Thu Aug 15 07:21:20 2013 (r85355)
+++ trunk/libs/multiprecision/doc/html/boost_multiprecision/indexes/s02.html 2013-08-15 07:55:21 EDT (Thu, 15 Aug 2013) (r85356)
@@ -24,7 +24,7 @@
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h3 class="title">
-<a name="id995984"></a>Class Index</h3></div></div></div>
+<a name="id996273"></a>Class Index</h3></div></div></div>
 <p><a class="link" href="s02.html#idx_id_21">C</a> <a class="link" href="s02.html#idx_id_22">D</a> <a class="link" href="s02.html#idx_id_23">E</a> <a class="link" href="s02.html#idx_id_24">F</a> <a class="link" href="s02.html#idx_id_25">G</a> <a class="link" href="s02.html#idx_id_26">I</a> <a class="link" href="s02.html#idx_id_27">L</a> <a class="link" href="s02.html#idx_id_28">M</a> <a class="link" href="s02.html#idx_id_29">N</a> <a class="link" href="s02.html#idx_id_34">T</a></p>
 <div class="variablelist"><dl class="variablelist">
 <dt>

Modified: trunk/libs/multiprecision/doc/html/boost_multiprecision/indexes/s03.html
==============================================================================
--- trunk/libs/multiprecision/doc/html/boost_multiprecision/indexes/s03.html Thu Aug 15 07:21:20 2013 (r85355)
+++ trunk/libs/multiprecision/doc/html/boost_multiprecision/indexes/s03.html 2013-08-15 07:55:21 EDT (Thu, 15 Aug 2013) (r85356)
@@ -24,7 +24,7 @@
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h3 class="title">
-<a name="id997596"></a>Typedef Index</h3></div></div></div>
+<a name="id996793"></a>Typedef Index</h3></div></div></div>
 <p><a class="link" href="s03.html#idx_id_40">C</a> <a class="link" href="s03.html#idx_id_43">F</a> <a class="link" href="s03.html#idx_id_45">I</a> <a class="link" href="s03.html#idx_id_46">L</a> <a class="link" href="s03.html#idx_id_47">M</a> <a class="link" href="s03.html#idx_id_52">S</a> <a class="link" href="s03.html#idx_id_53">T</a> <a class="link" href="s03.html#idx_id_54">U</a></p>
 <div class="variablelist"><dl class="variablelist">
 <dt>

Modified: trunk/libs/multiprecision/doc/html/boost_multiprecision/indexes/s04.html
==============================================================================
--- trunk/libs/multiprecision/doc/html/boost_multiprecision/indexes/s04.html Thu Aug 15 07:21:20 2013 (r85355)
+++ trunk/libs/multiprecision/doc/html/boost_multiprecision/indexes/s04.html 2013-08-15 07:55:21 EDT (Thu, 15 Aug 2013) (r85356)
@@ -23,7 +23,7 @@
 </div>
 <div class="section">
 <div class="titlepage"><div><div><h3 class="title">
-<a name="id998666"></a>Index</h3></div></div></div>
+<a name="id997863"></a>Index</h3></div></div></div>
 <p><a class="link" href="s04.html#idx_id_57">A</a> <a class="link" href="s04.html#idx_id_58">B</a> <a class="link" href="s04.html#idx_id_59">C</a> <a class="link" href="s04.html#idx_id_60">D</a> <a class="link" href="s04.html#idx_id_61">E</a> <a class="link" href="s04.html#idx_id_62">F</a> <a class="link" href="s04.html#idx_id_63">G</a> <a class="link" href="s04.html#idx_id_64">I</a> <a class="link" href="s04.html#idx_id_65">L</a> <a class="link" href="s04.html#idx_id_66">M</a> <a class="link" href="s04.html#idx_id_67">N</a> <a class="link" href="s04.html#idx_id_68">O</a> <a class="link" href="s04.html#idx_id_69">P</a> <a class="link" href="s04.html#idx_id_70">R</a> <a class="link" href="s04.html#idx_id_71">S</a> <a class="link" href="s04.html#idx_id_72">T</a> <a class="link" href="s04.html#idx_id_73">U</a> <a class="link" href="s04.html#idx_id_74">V</a> <a class="link" href="s04.html#idx_id_75">Z</a></p>
 <div class="variablelist"><dl class="variablelist">
 <dt>
@@ -92,6 +92,14 @@
 <p><span class="index-entry-level-0">BOOST_MP_DEFINE_SIZED_CPP_INT_LITERAL</span></p>
 <div class="index"><ul class="index" style="list-style-type: none; "><li class="listitem" style="list-style-type: none"><p><a class="link" href="../tut/lits.html" title="Literal Types and constexpr Support"><span class="index-entry-level-1">Literal Types and constexpr Support</span></a></p></li></ul></div>
 </li>
+<li class="listitem" style="list-style-type: none">
+<p><span class="index-entry-level-0">BOOST_MP_USE_FLOAT128</span></p>
+<div class="index"><ul class="index" style="list-style-type: none; "><li class="listitem" style="list-style-type: none"><p><a class="link" href="../tut/floats/float128.html" title="float128"><span class="index-entry-level-1">float128</span></a></p></li></ul></div>
+</li>
+<li class="listitem" style="list-style-type: none">
+<p><span class="index-entry-level-0">BOOST_MP_USE_QUAD</span></p>
+<div class="index"><ul class="index" style="list-style-type: none; "><li class="listitem" style="list-style-type: none"><p><a class="link" href="../tut/floats/float128.html" title="float128"><span class="index-entry-level-1">float128</span></a></p></li></ul></div>
+</li>
 </ul></div></dd>
 <dt>
 <a name="idx_id_59"></a><span class="term">C</span>
@@ -534,6 +542,8 @@
 <li class="listitem" style="list-style-type: none">
 <p><span class="index-entry-level-0">float128</span></p>
 <div class="index"><ul class="index" style="list-style-type: none; ">
+<li class="listitem" style="list-style-type: none"><p><a class="link" href="../tut/floats/float128.html" title="float128"><span class="index-entry-level-1">BOOST_MP_USE_FLOAT128</span></a></p></li>
+<li class="listitem" style="list-style-type: none"><p><a class="link" href="../tut/floats/float128.html" title="float128"><span class="index-entry-level-1">BOOST_MP_USE_QUAD</span></a></p></li>
 <li class="listitem" style="list-style-type: none"><p><a class="link" href="../tut/floats/float128.html" title="float128"><span class="index-entry-level-1">data</span></a></p></li>
 <li class="listitem" style="list-style-type: none"><p><span class="bold"><strong><a class="link" href="../tut/floats/float128.html" title="float128"><span class="index-entry-level-1">float128</span></a></strong></span></p></li>
 <li class="listitem" style="list-style-type: none"><p><a class="link" href="../tut/floats/float128.html" title="float128"><span class="index-entry-level-1">float128_backend</span></a></p></li>

Modified: trunk/libs/multiprecision/doc/html/boost_multiprecision/tut/floats/float128.html
==============================================================================
--- trunk/libs/multiprecision/doc/html/boost_multiprecision/tut/floats/float128.html Thu Aug 15 07:21:20 2013 (r85355)
+++ trunk/libs/multiprecision/doc/html/boost_multiprecision/tut/floats/float128.html 2013-08-15 07:55:21 EDT (Thu, 15 Aug 2013) (r85356)
@@ -80,8 +80,10 @@
 <li class="listitem">
               It is not possible to round-trip objects of this type to and from a
               string and get back exactly the same value when compiled with Intel's
- C++ compiler: this is a current limitation of our code. Round tripping
- when using GCC is possible.
+ C++ compiler and using <code class="computeroutput"><span class="identifier">_Quad</span></code>
+ as the underlying type: this is a current limitation of our code. Round
+ tripping when using <code class="computeroutput"><span class="identifier">__float128</span></code>
+ as the underlying type is possible (both for GCC and Intel).
             </li>
 <li class="listitem">
               Conversion from a string results in a <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">runtime_error</span></code>
@@ -95,6 +97,16 @@
               Type <code class="computeroutput"><span class="identifier">float128</span></code> can be
               used as a literal type (constexpr support).
             </li>
+<li class="listitem">
+ When using the Intel compiler, the underlying type defaults to <code class="computeroutput"><span class="identifier">__float128</span></code> if it's available and
+ <code class="computeroutput"><span class="identifier">_Quad</span></code> if not. You can
+ override the default by defining either <code class="computeroutput"><span class="identifier">BOOST_MP_USE_FLOAT128</span></code>
+ or <code class="computeroutput"><span class="identifier">BOOST_MP_USE_QUAD</span></code>.
+ </li>
+<li class="listitem">
+ When the underlying type is Intel's <code class="computeroutput"><span class="identifier">_Quad</span></code>
+ type, the code must be compiled with the compiler option <code class="computeroutput"><span class="special">-</span><span class="identifier">Qoption</span><span class="special">,</span><span class="identifier">cpp</span><span class="special">,--</span><span class="identifier">extended_float_type</span></code>.
+ </li>
 </ul></div>
 <h6>
 <a name="boost_multiprecision.tut.floats.float128.h0"></a>

Modified: trunk/libs/multiprecision/doc/html/index.html
==============================================================================
--- trunk/libs/multiprecision/doc/html/index.html Thu Aug 15 07:21:20 2013 (r85355)
+++ trunk/libs/multiprecision/doc/html/index.html 2013-08-15 07:55:21 EDT (Thu, 15 Aug 2013) (r85356)
@@ -147,7 +147,7 @@
 </div>
 </div>
 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: August 01, 2013 at 15:58:28 GMT</small></p></td>
+<td align="left"><p><small>Last revised: August 15, 2013 at 11:52:53 GMT</small></p></td>
 <td align="right"><div class="copyright-footer"></div></td>
 </tr></table>
 <hr>

Modified: trunk/libs/multiprecision/doc/multiprecision.qbk
==============================================================================
--- trunk/libs/multiprecision/doc/multiprecision.qbk Thu Aug 15 07:21:20 2013 (r85355)
+++ trunk/libs/multiprecision/doc/multiprecision.qbk 2013-08-15 07:55:21 EDT (Thu, 15 Aug 2013) (r85356)
@@ -879,12 +879,15 @@
 * Default constructed `float128`s have the value zero.
 * This backend supports rvalue-references and is move-aware, making instantiations of `number` on this backend move aware.
 * It is not possible to round-trip objects of this type to and from a string and get back
-exactly the same value when compiled with Intel's C++ compiler: this is a current limitation of our code. Round tripping
-when using GCC is possible.
+exactly the same value when compiled with Intel's C++ compiler and using `_Quad` as the underlying type: this is a current limitation of
+our code. Round tripping when using `__float128` as the underlying type is possible (both for GCC and Intel).
 * Conversion from a string results in a `std::runtime_error` being thrown if the string can not be interpreted
 as a valid floating point number.
 * Division by zero results in an infinity being produced.
 * Type `float128` can be used as a literal type (constexpr support).
+* When using the Intel compiler, the underlying type defaults to `__float128` if it's available and `_Quad` if not. You can override
+the default by defining either `BOOST_MP_USE_FLOAT128` or `BOOST_MP_USE_QUAD`.
+* When the underlying type is Intel's `_Quad` type, the code must be compiled with the compiler option `-Qoption,cpp,--extended_float_type`.
 
 [h5 float128 example:]
 


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