62 lines
25 KiB
HTML
62 lines
25 KiB
HTML
<!-- HTML header for doxygen 1.8.13-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.15"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Generic Image Library: promote_integral.hpp Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div class="boost-header">
|
|
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
|
|
<tr>
|
|
<td valign="top" width="300">
|
|
<h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
|
|
</td>
|
|
<td ><h1 align="center"><a href="../index.html"></a></h1></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<hr/>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search');
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1878a3f4746a95c6aad317458cc7ef80.html">boost</a></li><li class="navelem"><a class="el" href="dir_df4750f408086f9b9c1b5ee4251365ff.html">gil</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">promote_integral.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Boost.GIL (Generic Image Library)</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">//</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// Copyright (c) 2015, Oracle and/or its affiliates.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Contributed and/or modified by Menelaos Karavelas, on behalf of Oracle</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// </span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// Copyright (c) 2020, Debabrata Mandal <mandaldebabrata123@gmail.com></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// Licensed under the Boost Software License version 1.0.</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// http://www.boost.org/users/license.html</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Source: Boost.Geometry (aka GGL, Generic Geometry Library)</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// Modifications: adapted for Boost.GIL</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// - Rename namespace boost::geometry to boost::gil</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// - Rename include guards</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// - Remove support for boost::multiprecision types</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// - Remove support for 128-bit integer types</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// - Replace mpl meta functions with mp11 equivalents</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef BOOST_GIL_PROMOTE_INTEGRAL_HPP</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define BOOST_GIL_PROMOTE_INTEGRAL_HPP</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <boost/mp11/list.hpp></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <climits></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <cstddef></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <type_traits></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span>boost { <span class="keyword">namespace </span>gil</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span>detail { <span class="keyword">namespace </span>promote_integral</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// meta-function that returns the bit size of a type</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">template</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">typename</span> T,</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">bool</span> IsFundamental = std::is_fundamental<T>::value</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> ></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">struct </span>bit_size {};</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// for fundamental types, just return CHAR_BIT * sizeof(T)</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">struct </span>bit_size<T, true> : std::integral_constant<std::size_t, (CHAR_BIT * sizeof(T))> {};</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">template</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">typename</span> T,</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">typename</span> IntegralTypes,</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  std::size_t MinSize</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> ></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">struct </span>promote_to_larger</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">using</span> current_type = boost::mp11::mp_first<IntegralTypes>;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">using</span> list_after_front = boost::mp11::mp_rest<IntegralTypes>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">using</span> type = <span class="keyword">typename</span> std::conditional</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  (bit_size<current_type>::value >= MinSize),</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  current_type,</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">typename</span> promote_to_larger</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  T,</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  list_after_front,</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  MinSize</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  >::type</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  >::type;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> };</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// The following specialization is required to finish the loop over</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">// all list elements</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T, std::<span class="keywordtype">size_t</span> MinSize></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">struct </span>promote_to_larger<T, boost::mp11::mp_list<>, MinSize></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> {</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// if promotion fails, keep the number T</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// (and cross fingers that overflow will not occur)</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">using</span> type = T;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> };</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> }} <span class="comment">// namespace detail::promote_integral</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">template</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">typename</span> T,</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">bool</span> PromoteUnsignedToUnsigned = <span class="keyword">false</span>,</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordtype">bool</span> UseCheckedInteger = <span class="keyword">false</span>,</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">bool</span> IsIntegral = std::is_integral<T>::value</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> ></div><div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="classboost_1_1gil_1_1promote__integral.html"> 121</a></span> <span class="keyword">class </span><a class="code" href="classboost_1_1gil_1_1promote__integral.html">promote_integral</a></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> {</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <span class="keyword">const</span> is_unsigned = std::is_unsigned<T>::value;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keyword">using</span> bit_size_type = detail::promote_integral::bit_size<T>;</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="comment">// Define the minimum size (in bits) needed for the promoted type</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="comment">// If T is the input type and P the promoted type, then the</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="comment">// minimum number of bits for P are (below b stands for the number</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="comment">// of bits of T):</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="comment">// * if T is unsigned and P is unsigned: 2 * b</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="comment">// * if T is signed and P is signed: 2 * b - 1</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="comment">// * if T is unsigned and P is signed: 2 * b + 1</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keyword">using</span> min_bit_size_type = <span class="keyword">typename</span> std::conditional</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  (PromoteUnsignedToUnsigned && is_unsigned),</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  std::integral_constant<std::size_t, (2 * bit_size_type::value)>,</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keyword">typename</span> std::conditional</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  is_unsigned,</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  std::integral_constant<std::size_t, (2 * bit_size_type::value + 1)>,</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  std::integral_constant<std::size_t, (2 * bit_size_type::value - 1)></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  >::type</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  >::type;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="comment">// Define the list of signed integral types we are going to use</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="comment">// for promotion</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keyword">using</span> signed_integral_types = boost::mp11::mp_list</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  short, int, <span class="keywordtype">long</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="preprocessor">#if defined(BOOST_HAS_LONG_LONG)</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  , boost::long_long_type</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  >;</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="comment">// Define the list of unsigned integral types we are going to use</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="comment">// for promotion</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keyword">using</span> unsigned_integral_types = boost::mp11::mp_list</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordtype">unsigned</span> short, <span class="keywordtype">unsigned</span> int, <span class="keywordtype">unsigned</span> long, std::size_t</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="preprocessor">#if defined(BOOST_HAS_LONG_LONG)</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  , boost::ulong_long_type</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  >;</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="comment">// Define the list of integral types that will be used for</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="comment">// promotion (depending in whether we was to promote unsigned to</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="comment">// unsigned or not)</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keyword">using</span> integral_types = <span class="keyword">typename</span> std::conditional</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  (is_unsigned && PromoteUnsignedToUnsigned),</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  unsigned_integral_types,</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  signed_integral_types</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  >::type;</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keyword">using</span> type = <span class="keyword">typename</span> detail::promote_integral::promote_to_larger</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  <</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  T,</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  integral_types,</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  min_bit_size_type::value</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  >::type;</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> };</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="keyword">template</span> <<span class="keyword">typename</span> T, <span class="keywordtype">bool</span> PromoteUn<span class="keywordtype">signed</span>ToUn<span class="keywordtype">signed</span>, <span class="keywordtype">bool</span> UseCheckedInteger></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="keyword">class </span><a class="code" href="classboost_1_1gil_1_1promote__integral.html">promote_integral</a></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  T, PromoteUnsignedToUnsigned, UseCheckedInteger, false</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  ></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> {</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="keyword">using</span> type = T;</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> };</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> </div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> }} <span class="comment">// namespace boost::gil</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="preprocessor">#endif // BOOST_GIL_PROMOTE_INTEGRAL_HPP</span></div><div class="ttc" id="classboost_1_1gil_1_1promote__integral_html"><div class="ttname"><a href="classboost_1_1gil_1_1promote__integral.html">boost::gil::promote_integral</a></div><div class="ttdoc">Meta-function to define an integral type with size than is (roughly) twice the bit size of T.</div><div class="ttdef"><b>Definition:</b> promote_integral.hpp:121</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- HTML footer for doxygen 1.8.13-->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/>
|
|
<address class="footer">
|
|
<small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
|
|
</small>
|
|
</address>
|
|
</body>
|
|
</html>
|