libs/gil/doc/html/reference/basic_8hpp_source.html

   1 <!-- HTML header for doxygen 1.8.13-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4   <head>
   5     <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6     <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   7     <meta name="generator" content="Doxygen 1.8.15"/>
   8     <meta name="viewport" content="width=device-width, initial-scale=1"/>
   9     <title>Generic Image Library: basic.hpp Source File</title>
  10     <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11     <script type="text/javascript" src="jquery.js"></script>
  12     <script type="text/javascript" src="dynsections.js"></script>
  13     <link href="doxygen.css" rel="stylesheet" type="text/css" />
  14     <link href="doxygen-boost.css" rel="stylesheet" type="text/css"/>
  15   </head>
  16   <body>
  17     <div class="boost-header">
  18       <table border="0" cellpadding="7" cellspacing="0" width="100%" summary="header">
  19         <tr>
  20           <td valign="top" width="300">
  21             <h3><a href="../index.html"><img alt="Boost GIL" src="../_static/gil.png" border="0"></a></h3>
  22           </td>
  23           <td ><h1 align="center"><a href="../index.html"></a></h1></td>
  24           <td></td>
  25         </tr>
  26       </table>
  27     </div>
  28     <hr/>
  29     <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  30 <!-- Generated by Doxygen 1.8.15 -->
  31 <script type="text/javascript" src="menudata.js"></script>
  32 <script type="text/javascript" src="menu.js"></script>
  33 <script type="text/javascript">
  34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35 $(function() {
  36   initMenu('',false,false,'search.php','Search');
  37 });
  38 /* @license-end */</script>
  39 <div id="main-nav"></div>
  40 <div id="nav-path" class="navpath">
  41   <ul>
  42 <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><li class="navelem"><a class="el" href="dir_65525b100b86579f1f0652bf33388089.html">concepts</a></li>  </ul>
  43 </div>
  44 </div><!-- top -->
  45 <div class="header">
  46   <div class="headertitle">
  47 <div class="title">basic.hpp</div>  </div>
  48 </div><!--header-->
  49 <div class="contents">
  50 <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">// Copyright 2005-2007 Adobe Systems Incorporated</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// Distributed under the Boost Software License, Version 1.0</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">// See accompanying file LICENSE_1_0.txt or copy at</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">// http://www.boost.org/LICENSE_1_0.txt</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#ifndef BOOST_GIL_CONCEPTS_BASIC_HPP</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#define BOOST_GIL_CONCEPTS_BASIC_HPP</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &lt;boost/config.hpp&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#if defined(BOOST_CLANG)</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#pragma clang diagnostic push</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#pragma clang diagnostic ignored &quot;-Wunused-local-typedefs&quot;</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#pragma clang diagnostic ignored &quot;-Wuninitialized&quot;</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#if defined(BOOST_GCC) &amp;&amp; (BOOST_GCC &gt;= 40900)</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#pragma GCC diagnostic push</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#pragma GCC diagnostic ignored &quot;-Wunused-local-typedefs&quot;</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#pragma GCC diagnostic ignored &quot;-Wuninitialized&quot;</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#include &lt;boost/gil/concepts/concept_check.hpp&gt;</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &lt;type_traits&gt;</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#include &lt;utility&gt;</span> <span class="comment">// std::swap</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">namespace </span>boost { <span class="keyword">namespace </span>gil {</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1_default_constructible.html">   42</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1_default_constructible.html">DefaultConstructible</a></div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;{</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    <span class="keywordtype">void</span> constraints()</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    {</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;        function_requires&lt;boost::DefaultConstructibleConcept&lt;T&gt;&gt;();</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    }</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;};</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1_copy_constructible.html">   61</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1_copy_constructible.html">CopyConstructible</a></div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;{</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    <span class="keywordtype">void</span> constraints()</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    {</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;        function_requires&lt;boost::CopyConstructibleConcept&lt;T&gt;&gt;();</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    }</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;};</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1_assignable.html">   80</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1_assignable.html">Assignable</a></div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;{</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    <span class="keywordtype">void</span> constraints()</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    {</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;        function_requires&lt;boost::AssignableConcept&lt;T&gt;&gt;();</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;    }</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;};</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1_equality_comparable.html">   99</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1_equality_comparable.html">EqualityComparable</a></div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;{</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;    <span class="keywordtype">void</span> constraints()</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;    {</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;        function_requires&lt;boost::EqualityComparableConcept&lt;T&gt;&gt;();</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;    }</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;};</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1_swappable.html">  117</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1_swappable.html">Swappable</a></div><div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;{</div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;    <span class="keywordtype">void</span> constraints()</div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;    {</div><div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;        <span class="keyword">using</span> <a class="code" href="group___packed_channel_reference_model.html#ga70de3c85964650c16afcc42c02bd5df9">std::swap</a>;</div><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;        <a class="code" href="group___packed_channel_reference_model.html#ga70de3c85964650c16afcc42c02bd5df9">swap</a>(x,y);</div><div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;    }</div><div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;    T x,y;</div><div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;};</div><div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;</div><div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00140"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1_regular.html">  140</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1_regular.html">Regular</a></div><div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;{</div><div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;    <span class="keywordtype">void</span> constraints()</div><div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;    {</div><div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;        gil_function_requires&lt; boost::DefaultConstructibleConcept&lt;T&gt;&gt;();</div><div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;        gil_function_requires&lt; boost::CopyConstructibleConcept&lt;T&gt;&gt;();</div><div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;        gil_function_requires&lt; boost::EqualityComparableConcept&lt;T&gt;&gt;(); <span class="comment">// ==, !=</span></div><div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;        gil_function_requires&lt; boost::AssignableConcept&lt;T&gt;&gt;();</div><div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;        gil_function_requires&lt; Swappable&lt;T&gt;&gt;();</div><div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;    }</div><div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;};</div><div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;</div><div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00162"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1_metafunction.html">  162</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1_metafunction.html">Metafunction</a></div><div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;{</div><div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;    <span class="keywordtype">void</span> constraints()</div><div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;    {</div><div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;        <span class="keyword">using</span> type = <span class="keyword">typename</span> T::type;</div><div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;    }</div><div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;};</div><div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;</div><div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T, <span class="keyword">typename</span> U&gt;</div><div class="line"><a name="l00177"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1_same_type.html">  177</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1_same_type.html">SameType</a></div><div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;{</div><div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;    <span class="keywordtype">void</span> constraints()</div><div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;    {</div><div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;        static_assert(std::is_same&lt;T, U&gt;::value, <span class="stringliteral">&quot;&quot;</span>);</div><div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;    }</div><div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;};</div><div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;</div><div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;}} <span class="comment">// namespace boost::gil</span></div><div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;</div><div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;<span class="preprocessor">#if defined(BOOST_CLANG)</span></div><div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;<span class="preprocessor">#pragma clang diagnostic pop</span></div><div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;</div><div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;<span class="preprocessor">#if defined(BOOST_GCC) &amp;&amp; (BOOST_GCC &gt;= 40900)</span></div><div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;<span class="preprocessor">#pragma GCC diagnostic pop</span></div><div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;</div><div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="structboost_1_1gil_1_1_equality_comparable_html"><div class="ttname"><a href="structboost_1_1gil_1_1_equality_comparable.html">boost::gil::EqualityComparable</a></div><div class="ttdoc">Concept of == and != comparability requirement.</div><div class="ttdef"><b>Definition:</b> basic.hpp:99</div></div>
  51 <div class="ttc" id="structboost_1_1gil_1_1_same_type_html"><div class="ttname"><a href="structboost_1_1gil_1_1_same_type.html">boost::gil::SameType</a></div><div class="ttdoc">Concept of types equivalence requirement.</div><div class="ttdef"><b>Definition:</b> basic.hpp:177</div></div>
  52 <div class="ttc" id="structboost_1_1gil_1_1_copy_constructible_html"><div class="ttname"><a href="structboost_1_1gil_1_1_copy_constructible.html">boost::gil::CopyConstructible</a></div><div class="ttdoc">Concept of copy construction requirement.</div><div class="ttdef"><b>Definition:</b> basic.hpp:61</div></div>
  53 <div class="ttc" id="structboost_1_1gil_1_1_swappable_html"><div class="ttname"><a href="structboost_1_1gil_1_1_swappable.html">boost::gil::Swappable</a></div><div class="ttdoc">Concept of swap operation requirement.</div><div class="ttdef"><b>Definition:</b> basic.hpp:117</div></div>
  54 <div class="ttc" id="structboost_1_1gil_1_1_default_constructible_html"><div class="ttname"><a href="structboost_1_1gil_1_1_default_constructible.html">boost::gil::DefaultConstructible</a></div><div class="ttdoc">Concept of default construction requirement.</div><div class="ttdef"><b>Definition:</b> basic.hpp:42</div></div>
  55 <div class="ttc" id="structboost_1_1gil_1_1_metafunction_html"><div class="ttname"><a href="structboost_1_1gil_1_1_metafunction.html">boost::gil::Metafunction</a></div><div class="ttdoc">Concept for type as metafunction requirement.</div><div class="ttdef"><b>Definition:</b> basic.hpp:162</div></div>
  56 <div class="ttc" id="structboost_1_1gil_1_1_assignable_html"><div class="ttname"><a href="structboost_1_1gil_1_1_assignable.html">boost::gil::Assignable</a></div><div class="ttdoc">Concept of copy assignment requirement.</div><div class="ttdef"><b>Definition:</b> basic.hpp:80</div></div>
  57 <div class="ttc" id="group___packed_channel_reference_model_html_ga70de3c85964650c16afcc42c02bd5df9"><div class="ttname"><a href="group___packed_channel_reference_model.html#ga70de3c85964650c16afcc42c02bd5df9">std::swap</a></div><div class="ttdeci">void swap(boost::gil::packed_channel_reference&lt; BF, FB, NB, M &gt; const x, R &amp;y)</div><div class="ttdoc">swap for packed_channel_reference</div><div class="ttdef"><b>Definition:</b> channel.hpp:529</div></div>
  58 <div class="ttc" id="structboost_1_1gil_1_1_regular_html"><div class="ttname"><a href="structboost_1_1gil_1_1_regular.html">boost::gil::Regular</a></div><div class="ttdoc">Concept for type regularity requirement.</div><div class="ttdef"><b>Definition:</b> basic.hpp:140</div></div>
  59 </div><!-- fragment --></div><!-- contents -->
  60      <!-- HTML footer for doxygen 1.8.13-->
  61      <!-- start footer part -->
  62      <hr class="footer"/>
  63      <address class="footer">
  64       <small>
  65         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  66       </small>
  67     </address>
  68   </body>
  69 </html>