Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / gil / doc / html / reference / conversion__policies_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: conversion_policies.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_80930c1173f2c0438c68e99be5d8d1e3.html">io</a></li>  </ul>
43 </div>
44 </div><!-- top -->
45 <div class="header">
46   <div class="headertitle">
47 <div class="title">conversion_policies.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 2007-2008 Christian Henning, Andreas Pokorny</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_IO_CONVERSION_POLICIES_HPP</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#define BOOST_GIL_IO_CONVERSION_POLICIES_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/gil/image_view_factory.hpp&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#include &lt;boost/gil/detail/mp11.hpp&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &lt;boost/gil/io/error.hpp&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#include &lt;algorithm&gt;</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#include &lt;iterator&gt;</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#include &lt;type_traits&gt;</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="keyword">namespace </span>boost{ <span class="keyword">namespace </span>gil { <span class="keyword">namespace </span>detail {</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="keyword">struct </span>read_and_no_convert</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;{</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;    <span class="keyword">using</span> color_converter_type = <span class="keywordtype">void</span> *;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">typename</span> InIterator, <span class="keyword">typename</span> OutIterator&gt;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    <span class="keywordtype">void</span> read(</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;        InIterator <span class="keyword">const</span>&amp; <span class="comment">/*begin*/</span>, InIterator <span class="keyword">const</span>&amp; <span class="comment">/*end*/</span> , OutIterator <span class="comment">/*out*/</span>,</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;        <span class="keyword">typename</span> std::enable_if</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;        &lt;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;            mp11::mp_not</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;            &lt;</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;                pixels_are_compatible</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;                &lt;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;                    <span class="keyword">typename</span> std::iterator_traits&lt;InIterator&gt;::value_type,</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;                    <span class="keyword">typename</span> std::iterator_traits&lt;OutIterator&gt;::value_type</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;                &gt;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;            &gt;::value</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;        &gt;::type* <span class="comment">/*dummy*/</span> = <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    {</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;        io_error(<span class="stringliteral">&quot;Data cannot be copied because the pixels are incompatible.&quot;</span>);</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    }</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="keyword">template</span> &lt;<span class="keyword">typename</span> InIterator, <span class="keyword">typename</span> OutIterator&gt;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <span class="keywordtype">void</span> read(InIterator <span class="keyword">const</span>&amp; begin, InIterator <span class="keyword">const</span>&amp; end, OutIterator out,</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;        <span class="keyword">typename</span> std::enable_if</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;        &lt;</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;            pixels_are_compatible</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;            &lt;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;                <span class="keyword">typename</span> std::iterator_traits&lt;InIterator&gt;::value_type,</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;                <span class="keyword">typename</span> std::iterator_traits&lt;OutIterator&gt;::value_type</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;            &gt;::value</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;        &gt;::type* <span class="comment">/*dummy*/</span> = <span class="keyword">nullptr</span>)</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    {</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;        <a class="code" href="group___s_t_l_optimizations.html#ga8e23fe06d31c7cce605e4bf8255e1ee9">std::copy</a>(begin, end, out);</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    }</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;};</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> CC&gt;</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="keyword">struct </span>read_and_convert</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;{</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    <span class="keyword">using</span> color_converter_type = default_color_converter;</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    CC _cc;</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    read_and_convert()</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="l00069"></a><span class="lineno">   69</span>&#160;    read_and_convert( <span class="keyword">const</span> color_converter_type&amp; cc )</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    : _cc( cc )</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    {}</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <span class="keyword">template</span>&lt; <span class="keyword">typename</span> InIterator</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;            , <span class="keyword">typename</span> OutIterator</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;            &gt;</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    <span class="keywordtype">void</span> read( <span class="keyword">const</span> InIterator&amp; begin</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;             , <span class="keyword">const</span> InIterator&amp; end</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;             , OutIterator       out</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;             )</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    {</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;        <span class="keyword">using</span> deref_t = color_convert_deref_fn&lt;typename std::iterator_traits&lt;InIterator&gt;::reference</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;                                      , <span class="keyword">typename</span> std::iterator_traits&lt;OutIterator&gt;::value_type <span class="comment">//reference?</span></div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;                                      , CC</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;                                      &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;        std::transform( begin</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;                      , end</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;                      , out</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;                      , deref_t( _cc )</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;                      );</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    }</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;};</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="keyword">template</span>&lt; <span class="keyword">typename</span> Conversion_Policy &gt;</div><div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="structboost_1_1gil_1_1detail_1_1is__read__only.html">   97</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1detail_1_1is__read__only.html">is_read_only</a> : std::false_type {};</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="keyword">template</span>&lt;&gt;</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="keyword">struct </span><a class="code" href="structboost_1_1gil_1_1detail_1_1is__read__only.html">is_read_only</a>&lt;detail::read_and_no_convert&gt; : std::true_type {};</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;} <span class="comment">// namespace detail</span></div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;} <span class="comment">// namespace gil</span></div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;} <span class="comment">// namespace boost</span></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;<span class="preprocessor">#endif</span></div><div class="ttc" id="structboost_1_1gil_1_1detail_1_1is__read__only_html"><div class="ttname"><a href="structboost_1_1gil_1_1detail_1_1is__read__only.html">boost::gil::detail::is_read_only</a></div><div class="ttdoc">Determines if reader type is read only ( no conversion ).</div><div class="ttdef"><b>Definition:</b> conversion_policies.hpp:97</div></div>
51 <div class="ttc" id="group___s_t_l_optimizations_html_ga8e23fe06d31c7cce605e4bf8255e1ee9"><div class="ttname"><a href="group___s_t_l_optimizations.html#ga8e23fe06d31c7cce605e4bf8255e1ee9">std::copy</a></div><div class="ttdeci">BOOST_FORCEINLINE auto copy(boost::gil::pixel&lt; T, CS &gt; *first, boost::gil::pixel&lt; T, CS &gt; *last, boost::gil::pixel&lt; T, CS &gt; *dst) -&gt; boost::gil::pixel&lt; T, CS &gt; *</div><div class="ttdoc">Copy when both src and dst are interleaved and of the same type can be just memmove.</div><div class="ttdef"><b>Definition:</b> algorithm.hpp:139</div></div>
52 </div><!-- fragment --></div><!-- contents -->
53      <!-- HTML footer for doxygen 1.8.13-->
54      <!-- start footer part -->
55      <hr class="footer"/>
56      <address class="footer">
57       <small>
58         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
59       </small>
60     </address>
61   </body>
62 </html>