libs/gil/doc/html/reference/structboost_1_1gil_1_1binary__operation__obj.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: binary_operation_obj&lt; Derived, Result &gt; Struct Template Reference</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"><b>boost</b></li><li class="navelem"><b>gil</b></li><li class="navelem"><a class="el" href="structboost_1_1gil_1_1binary__operation__obj.html">binary_operation_obj</a></li>  </ul>
  43 </div>
  44 </div><!-- top -->
  45 <div class="header">
  46   <div class="summary">
  47 <a href="#pub-types">Public Types</a> &#124;
  48 <a href="#pub-methods">Public Member Functions</a> &#124;
  49 <a href="structboost_1_1gil_1_1binary__operation__obj-members.html">List of all members</a>  </div>
  50   <div class="headertitle">
  51 <div class="title">binary_operation_obj&lt; Derived, Result &gt; Struct Template Reference<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> &raquo; <a class="el" href="group___image_view_s_t_l_algorithms.html">STL-like Algorithms</a></div></div>  </div>
  52 </div><!--header-->
  53 <div class="contents">
  54
  55 <p>A generic binary operation on viewsUse this class as a convenience superclass when defining an operation for any image views. Many operations have different behavior when the two views are compatible. This class checks for compatibility and invokes apply_compatible(V1,V2) or apply_incompatible(V1,V2) of the subclass. You must provide apply_compatible(V1,V2) method in your subclass, but apply_incompatible(V1,V2) is not required and the default throws std::bad_cast.
  56  <a href="structboost_1_1gil_1_1binary__operation__obj.html#details">More...</a></p>
  57
  58 <p><code>#include &lt;<a class="el" href="algorithm_8hpp_source.html">algorithm.hpp</a>&gt;</code></p>
  59 <table class="memberdecls">
  60 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  61 Public Types</h2></td></tr>
  62 <tr class="memitem:a735c5016bc01e98819966555d22d3a08"><td class="memItemLeft" align="right" valign="top"><a id="a735c5016bc01e98819966555d22d3a08"></a>
  63 using&#160;</td><td class="memItemRight" valign="bottom"><b>result_type</b> = Result</td></tr>
  64 <tr class="separator:a735c5016bc01e98819966555d22d3a08"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65 </table><table class="memberdecls">
  66 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  67 Public Member Functions</h2></td></tr>
  68 <tr class="memitem:a86dc76fc5e5b58a33109d188fc3af66c"><td class="memTemplParams" colspan="2"><a id="a86dc76fc5e5b58a33109d188fc3af66c"></a>
  69 template&lt;typename V1 , typename V2 &gt; </td></tr>
  70 <tr class="memitem:a86dc76fc5e5b58a33109d188fc3af66c"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE result_type&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator()</b> (const std::pair&lt; const V1 *, const V2 * &gt; &amp;p) const</td></tr>
  71 <tr class="separator:a86dc76fc5e5b58a33109d188fc3af66c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 <tr class="memitem:a30d4f310fde3dfe2ccb987bd0d57716a"><td class="memTemplParams" colspan="2"><a id="a30d4f310fde3dfe2ccb987bd0d57716a"></a>
  73 template&lt;typename V1 , typename V2 &gt; </td></tr>
  74 <tr class="memitem:a30d4f310fde3dfe2ccb987bd0d57716a"><td class="memTemplItemLeft" align="right" valign="top">BOOST_FORCEINLINE result_type&#160;</td><td class="memTemplItemRight" valign="bottom"><b>operator()</b> (const V1 &amp;v1, const V2 &amp;v2) const</td></tr>
  75 <tr class="separator:a30d4f310fde3dfe2ccb987bd0d57716a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 <tr class="memitem:ab0faadf3e12a1fff886b724ac69b7c60"><td class="memItemLeft" align="right" valign="top"><a id="ab0faadf3e12a1fff886b724ac69b7c60"></a>
  77 result_type&#160;</td><td class="memItemRight" valign="bottom"><b>operator()</b> (const error_t &amp;) const</td></tr>
  78 <tr class="separator:ab0faadf3e12a1fff886b724ac69b7c60"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79 </table>
  80 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  81 <div class="textblock"><h3>template&lt;typename Derived, typename Result = void&gt;<br />
  82 struct boost::gil::binary_operation_obj&lt; Derived, Result &gt;</h3>
  83
  84 <p>A generic binary operation on views</p>
  85 <p>Use this class as a convenience superclass when defining an operation for any image views. Many operations have different behavior when the two views are compatible. This class checks for compatibility and invokes apply_compatible(V1,V2) or apply_incompatible(V1,V2) of the subclass. You must provide apply_compatible(V1,V2) method in your subclass, but apply_incompatible(V1,V2) is not required and the default throws std::bad_cast. </p>
  86 </div><hr/>The documentation for this struct was generated from the following file:<ul>
  87 <li><a class="el" href="algorithm_8hpp_source.html">algorithm.hpp</a></li>
  88 </ul>
  89 </div><!-- contents -->
  90      <!-- HTML footer for doxygen 1.8.13-->
  91      <!-- start footer part -->
  92      <hr class="footer"/>
  93      <address class="footer">
  94       <small>
  95         Generated by &#160;<a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.15
  96       </small>
  97     </address>
  98   </body>
  99 </html>