libs/gil/doc/html/reference/group___s_t_l_optimizations.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: Performance overloads of STL algorithms</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><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#func-members">Functions</a>  </div>
  44   <div class="headertitle">
  45 <div class="title">Performance overloads of STL algorithms<div class="ingroups"><a class="el" href="group___image_view.html">Image View</a> &raquo; <a class="el" href="group___image_view_algorithm.html">Algorithms and Utility Functions</a></div></div>  </div>
  46 </div><!--header-->
  47 <div class="contents">
  48
  49 <p>overloads of STL algorithms allowing more efficient implementation when used with GIL constructs
  50 <a href="#details">More...</a></p>
  51 <table class="memberdecls">
  52 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  53 Functions</h2></td></tr>
  54 <tr class="memitem:ga8e23fe06d31c7cce605e4bf8255e1ee9"><td class="memTemplParams" colspan="2"><a id="ga8e23fe06d31c7cce605e4bf8255e1ee9"></a>
  55 template&lt;typename T , typename CS &gt; </td></tr>
  56 <tr class="memitem:ga8e23fe06d31c7cce605e4bf8255e1ee9"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___s_t_l_optimizations.html#ga8e23fe06d31c7cce605e4bf8255e1ee9">copy</a> (<a class="el" href="structboost_1_1gil_1_1pixel.html">boost::gil::pixel</a>&lt; T, CS &gt; *first, <a class="el" href="structboost_1_1gil_1_1pixel.html">boost::gil::pixel</a>&lt; T, CS &gt; *last, <a class="el" href="structboost_1_1gil_1_1pixel.html">boost::gil::pixel</a>&lt; T, CS &gt; *dst) -&gt; <a class="el" href="structboost_1_1gil_1_1pixel.html">boost::gil::pixel</a>&lt; T, CS &gt; *</td></tr>
  57 <tr class="memdesc:ga8e23fe06d31c7cce605e4bf8255e1ee9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy when both src and dst are interleaved and of the same type can be just memmove. <br /></td></tr>
  58 <tr class="separator:ga8e23fe06d31c7cce605e4bf8255e1ee9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59 <tr class="memitem:ga7f5c40052f8914c1713b7a57ff23544a"><td class="memTemplParams" colspan="2"><a id="ga7f5c40052f8914c1713b7a57ff23544a"></a>
  60 template&lt;typename T , typename CS &gt; </td></tr>
  61 <tr class="memitem:ga7f5c40052f8914c1713b7a57ff23544a"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE <a class="el" href="structboost_1_1gil_1_1pixel.html">boost::gil::pixel</a>&lt; T, CS &gt; *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___s_t_l_optimizations.html#ga7f5c40052f8914c1713b7a57ff23544a">copy</a> (const <a class="el" href="structboost_1_1gil_1_1pixel.html">boost::gil::pixel</a>&lt; T, CS &gt; *first, const <a class="el" href="structboost_1_1gil_1_1pixel.html">boost::gil::pixel</a>&lt; T, CS &gt; *last, <a class="el" href="structboost_1_1gil_1_1pixel.html">boost::gil::pixel</a>&lt; T, CS &gt; *dst)</td></tr>
  62 <tr class="memdesc:ga7f5c40052f8914c1713b7a57ff23544a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy when both src and dst are interleaved and of the same type can be just memmove. <br /></td></tr>
  63 <tr class="separator:ga7f5c40052f8914c1713b7a57ff23544a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64 <tr class="memitem:ga445b366c1ef9e7cf58824395f65cce60"><td class="memTemplParams" colspan="2"><a id="ga445b366c1ef9e7cf58824395f65cce60"></a>
  65 template&lt;typename CS , typename IC1 , typename IC2 &gt; </td></tr>
  66 <tr class="memitem:ga445b366c1ef9e7cf58824395f65cce60"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE <a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">boost::gil::planar_pixel_iterator</a>&lt; IC2, CS &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___s_t_l_optimizations.html#ga445b366c1ef9e7cf58824395f65cce60">copy</a> (<a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">boost::gil::planar_pixel_iterator</a>&lt; IC1, CS &gt; first, <a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">boost::gil::planar_pixel_iterator</a>&lt; IC1, CS &gt; last, <a class="el" href="structboost_1_1gil_1_1planar__pixel__iterator.html">boost::gil::planar_pixel_iterator</a>&lt; IC2, CS &gt; dst)</td></tr>
  67 <tr class="memdesc:ga445b366c1ef9e7cf58824395f65cce60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy when both src and dst are planar pointers is copy for each channel. <br /></td></tr>
  68 <tr class="separator:ga445b366c1ef9e7cf58824395f65cce60"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <tr class="memitem:ga5aa989f3992b09c1f2d00eb9a98cbf1f"><td class="memTemplParams" colspan="2"><a id="ga5aa989f3992b09c1f2d00eb9a98cbf1f"></a>
  70 template&lt;typename IL , typename OL &gt; </td></tr>
  71 <tr class="memitem:ga5aa989f3992b09c1f2d00eb9a98cbf1f"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE <a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">boost::gil::iterator_from_2d</a>&lt; OL &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___s_t_l_optimizations.html#ga5aa989f3992b09c1f2d00eb9a98cbf1f">copy1</a> (<a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">boost::gil::iterator_from_2d</a>&lt; IL &gt; first, <a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">boost::gil::iterator_from_2d</a>&lt; IL &gt; last, <a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">boost::gil::iterator_from_2d</a>&lt; OL &gt; dst)</td></tr>
  72 <tr class="memdesc:ga5aa989f3992b09c1f2d00eb9a98cbf1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">std::copy(I1,I1,I2) with I1 and I2 being a iterator_from_2d <br /></td></tr>
  73 <tr class="separator:ga5aa989f3992b09c1f2d00eb9a98cbf1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74 <tr class="memitem:gaab999be608ae006f1127b8bb5145a227"><td class="memTemplParams" colspan="2">template&lt;typename IL , typename V &gt; </td></tr>
  75 <tr class="memitem:gaab999be608ae006f1127b8bb5145a227"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___s_t_l_optimizations.html#gaab999be608ae006f1127b8bb5145a227">fill</a> (<a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">boost::gil::iterator_from_2d</a>&lt; IL &gt; first, <a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">boost::gil::iterator_from_2d</a>&lt; IL &gt; last, const V &amp;val)</td></tr>
  76 <tr class="memdesc:gaab999be608ae006f1127b8bb5145a227"><td class="mdescLeft">&#160;</td><td class="mdescRight">std::fill(I,I,V) with I being a iterator_from_2d  <a href="group___s_t_l_optimizations.html#gaab999be608ae006f1127b8bb5145a227">More...</a><br /></td></tr>
  77 <tr class="separator:gaab999be608ae006f1127b8bb5145a227"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 <tr class="memitem:ga2902a23650ef266e80874ce5df076079"><td class="memTemplParams" colspan="2">template&lt;typename Loc1 , typename Loc2 &gt; </td></tr>
  79 <tr class="memitem:ga2902a23650ef266e80874ce5df076079"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___s_t_l_optimizations.html#ga2902a23650ef266e80874ce5df076079">equal</a> (<a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">boost::gil::iterator_from_2d</a>&lt; Loc1 &gt; first, <a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">boost::gil::iterator_from_2d</a>&lt; Loc1 &gt; last, <a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">boost::gil::iterator_from_2d</a>&lt; Loc2 &gt; first2)</td></tr>
  80 <tr class="memdesc:ga2902a23650ef266e80874ce5df076079"><td class="mdescLeft">&#160;</td><td class="mdescRight">std::equal(I1,I1,I2) with I1 and I2 being a iterator_from_2d  <a href="group___s_t_l_optimizations.html#ga2902a23650ef266e80874ce5df076079">More...</a><br /></td></tr>
  81 <tr class="separator:ga2902a23650ef266e80874ce5df076079"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 </table>
  83 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  84 <p>overloads of STL algorithms allowing more efficient implementation when used with GIL constructs </p>
  85 <h2 class="groupheader">Function Documentation</h2>
  86 <a id="ga2902a23650ef266e80874ce5df076079"></a>
  87 <h2 class="memtitle"><span class="permalink"><a href="#ga2902a23650ef266e80874ce5df076079">&#9670;&nbsp;</a></span>equal()</h2>
  88
  89 <div class="memitem">
  90 <div class="memproto">
  91       <table class="memname">
  92         <tr>
  93           <td class="memname">BOOST_FORCEINLINE bool std::equal </td>
  94           <td>(</td>
  95           <td class="paramtype"><a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">boost::gil::iterator_from_2d</a>&lt; Loc1 &gt;&#160;</td>
  96           <td class="paramname"><em>first</em>, </td>
  97         </tr>
  98         <tr>
  99           <td class="paramkey"></td>
 100           <td></td>
 101           <td class="paramtype"><a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">boost::gil::iterator_from_2d</a>&lt; Loc1 &gt;&#160;</td>
 102           <td class="paramname"><em>last</em>, </td>
 103         </tr>
 104         <tr>
 105           <td class="paramkey"></td>
 106           <td></td>
 107           <td class="paramtype"><a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">boost::gil::iterator_from_2d</a>&lt; Loc2 &gt;&#160;</td>
 108           <td class="paramname"><em>first2</em>&#160;</td>
 109         </tr>
 110         <tr>
 111           <td></td>
 112           <td>)</td>
 113           <td></td><td></td>
 114         </tr>
 115       </table>
 116 </div><div class="memdoc">
 117
 118 <p>std::equal(I1,I1,I2) with I1 and I2 being a iterator_from_2d </p>
 119 <p>Invoked when one calls std::equal(I1,I1,I2) with I1 and I2 being a iterator_from_2d (which is a 1D iterator over the pixels in an image). Attempts to demote the source and destination iterators to simpler/faster types if the corresponding range is contiguous. For contiguous images (i.e. images that have no alignment gap at the end of each row) it is more efficient to use the underlying pixel iterator that does not check for the end of rows. If the underlying pixel iterator happens to be a fundamental planar/interleaved pointer, the call may further resolve to memcmp. Otherwise it resolves to copying each row using the underlying pixel iterator </p>
 120
 121 </div>
 122 </div>
 123 <a id="gaab999be608ae006f1127b8bb5145a227"></a>
 124 <h2 class="memtitle"><span class="permalink"><a href="#gaab999be608ae006f1127b8bb5145a227">&#9670;&nbsp;</a></span>fill()</h2>
 125
 126 <div class="memitem">
 127 <div class="memproto">
 128       <table class="memname">
 129         <tr>
 130           <td class="memname">void std::fill </td>
 131           <td>(</td>
 132           <td class="paramtype"><a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">boost::gil::iterator_from_2d</a>&lt; IL &gt;&#160;</td>
 133           <td class="paramname"><em>first</em>, </td>
 134         </tr>
 135         <tr>
 136           <td class="paramkey"></td>
 137           <td></td>
 138           <td class="paramtype"><a class="el" href="classboost_1_1gil_1_1iterator__from__2d.html">boost::gil::iterator_from_2d</a>&lt; IL &gt;&#160;</td>
 139           <td class="paramname"><em>last</em>, </td>
 140         </tr>
 141         <tr>
 142           <td class="paramkey"></td>
 143           <td></td>
 144           <td class="paramtype">const V &amp;&#160;</td>
 145           <td class="paramname"><em>val</em>&#160;</td>
 146         </tr>
 147         <tr>
 148           <td></td>
 149           <td>)</td>
 150           <td></td><td></td>
 151         </tr>
 152       </table>
 153 </div><div class="memdoc">
 154
 155 <p>std::fill(I,I,V) with I being a iterator_from_2d </p>
 156 <p>Invoked when one calls std::fill(I,I,V) with I being a iterator_from_2d (which is a 1D iterator over the pixels in an image). For contiguous images (i.e. images that have no alignment gap at the end of each row) it is more efficient to use the underlying pixel iterator that does not check for the end of rows. For non-contiguous images fill resolves to fill of each row using the underlying pixel iterator, which is still faster </p>
 157
 158 </div>
 159 </div>
 160 </div><!-- contents -->
 161      <!-- HTML footer for doxygen 1.8.13-->
 162      <!-- start footer part -->
 163      <hr class="footer"/>
 164      <address class="footer">
 165       <small>
 166         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
 167       </small>
 168     </address>
 169   </body>
 170 </html>