internals.html 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Internal Support Code</title>
  5. <link rel="stylesheet" href="../../multiprecision.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
  7. <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Multiprecision">
  8. <link rel="up" href="../ref.html" title="Reference">
  9. <link rel="prev" href="cpp_dec_ref.html" title="cpp_dec_float">
  10. <link rel="next" href="backendconc.html" title="Backend Requirements">
  11. </head>
  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13. <table cellpadding="2" width="100%"><tr>
  14. <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15. <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16. <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17. <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18. <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19. <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20. </tr></table>
  21. <hr>
  22. <div class="spirit-nav">
  23. <a accesskey="p" href="cpp_dec_ref.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.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="backendconc.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24. </div>
  25. <div class="section">
  26. <div class="titlepage"><div><div><h3 class="title">
  27. <a name="boost_multiprecision.ref.internals"></a><a class="link" href="internals.html" title="Internal Support Code">Internal Support
  28. Code</a>
  29. </h3></div></div></div>
  30. <p>
  31. There are some traits classes which authors of new backends should be aware
  32. of:
  33. </p>
  34. <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">multiprecision</span><span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">detail</span><span class="special">{</span>
  35. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">From</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">To</span><span class="special">&gt;</span>
  36. <span class="keyword">struct</span> <span class="identifier">is_explicitly_convertible</span><span class="special">;</span>
  37. <span class="special">}}}</span>
  38. </pre>
  39. <p>
  40. Inherits from <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">integral_constant</span><span class="special">&lt;</span><span class="keyword">bool</span><span class="special">,</span><span class="keyword">true</span><span class="special">&gt;</span></code> if type <code class="computeroutput"><span class="identifier">From</span></code>
  41. has an explicit conversion from <code class="computeroutput"><span class="identifier">To</span></code>.
  42. </p>
  43. <p>
  44. For compilers that support C++11 SFINAE-expressions this trait should "just
  45. work". Otherwise it inherits from <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">is_convertible</span><span class="special">&lt;</span><span class="identifier">From</span><span class="special">,</span> <span class="identifier">To</span><span class="special">&gt;::</span><span class="identifier">type</span></code>, and will need to be specialised for
  46. Backends that have constructors marked as <code class="computeroutput"><span class="keyword">explicit</span></code>.
  47. </p>
  48. <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">From</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">To</span><span class="special">&gt;</span>
  49. <span class="keyword">struct</span> <span class="identifier">is_lossy_conversion</span>
  50. <span class="special">{</span>
  51. <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">bool</span> <span class="identifier">value</span> <span class="special">=</span> <span class="identifier">see</span> <span class="identifier">below</span><span class="special">;</span>
  52. <span class="special">};</span>
  53. </pre>
  54. <p>
  55. Member <code class="computeroutput"><span class="identifier">value</span></code> is true if the
  56. conversion from <code class="computeroutput"><span class="identifier">From</span></code> to
  57. <code class="computeroutput"><span class="identifier">To</span></code> would result in a loss
  58. of precision, and <code class="computeroutput"><span class="keyword">false</span></code> otherwise.
  59. </p>
  60. <p>
  61. The default version of this trait simply checks whether the <span class="emphasis"><em>kind</em></span>
  62. of conversion (for example from a floating-point to an integer type) is inherently
  63. lossy. Note that if either of the types <code class="computeroutput"><span class="identifier">From</span></code>
  64. or <code class="computeroutput"><span class="identifier">To</span></code> are of an unknown number
  65. category (because <code class="computeroutput"><span class="identifier">number_category</span></code>
  66. is not specialised for that type) then this trait will be <code class="computeroutput"><span class="keyword">true</span></code>.
  67. </p>
  68. <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">From</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">To</span><span class="special">&gt;</span>
  69. <span class="keyword">struct</span> <span class="identifier">is_restricted_conversion</span>
  70. <span class="special">{</span>
  71. <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">bool</span> <span class="identifier">value</span> <span class="special">=</span> <span class="identifier">see</span> <span class="identifier">below</span><span class="special">;</span>
  72. <span class="special">};</span>
  73. </pre>
  74. <p>
  75. Member <code class="computeroutput"><span class="identifier">value</span></code> is <code class="computeroutput"><span class="keyword">true</span></code> if <code class="computeroutput"><span class="identifier">From</span></code>
  76. is only explicitly convertible to <code class="computeroutput"><span class="identifier">To</span></code>
  77. and not implicitly convertible, or if <code class="computeroutput"><span class="identifier">is_lossy_conversion</span><span class="special">&lt;</span><span class="identifier">From</span><span class="special">,</span> <span class="identifier">To</span><span class="special">&gt;::</span><span class="identifier">value</span></code> is <code class="computeroutput"><span class="keyword">true</span></code>.
  78. Otherwise <code class="computeroutput"><span class="keyword">false</span></code>.
  79. </p>
  80. <p>
  81. Note that while this trait is the ultimate arbiter of which constructors
  82. are marked as <code class="computeroutput"><span class="keyword">explicit</span></code> in class
  83. <code class="computeroutput"><span class="identifier">number</span></code>, authors of backend
  84. types should generally specialise one of the traits above, rather than this
  85. one directly.
  86. </p>
  87. <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
  88. <span class="identifier">is_signed_number</span><span class="special">;</span>
  89. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
  90. <span class="identifier">is_unsigned_number</span><span class="special">;</span>
  91. </pre>
  92. <p>
  93. These two traits inherit from either <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">true_</span></code>
  94. or <code class="computeroutput"><span class="identifier">mpl</span><span class="special">::</span><span class="identifier">false_</span></code>, by default types are assumed to
  95. be signed unless <code class="computeroutput"><span class="identifier">is_unsigned_number</span></code>
  96. is specialized for that type.
  97. </p>
  98. </div>
  99. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  100. <td align="left"></td>
  101. <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2019 John Maddock
  102. and Christopher Kormanyos<p>
  103. Distributed under the Boost Software License, Version 1.0. (See accompanying
  104. file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  105. </p>
  106. </div></td>
  107. </tr></table>
  108. <hr>
  109. <div class="spirit-nav">
  110. <a accesskey="p" href="cpp_dec_ref.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.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="backendconc.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  111. </div>
  112. </body>
  113. </html>