File: classOpenMS_1_1BinaryComposeFunctionAdapter.html

package info (click to toggle)
openms 1.11.1-5
links: PTS, VCS
area: main
in suites: jessie, jessie-kfreebsd
size: 436,688 kB
ctags: 150,907
sloc: cpp: 387,126; xml: 71,547; python: 7,764; ansic: 2,626; php: 2,499; sql: 737; ruby: 342; sh: 325; makefile: 128
file content (261 lines) | stat: -rw-r--r-- 14,819 bytes
<HTML>
<HEAD>
<TITLE>BinaryComposeFunctionAdapter&lt; OP1, OP2, OP3 &gt; Class Template Reference</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> &nbsp;&middot;
<A href="classes.html">Classes</A> &nbsp;&middot;
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
<A href="modules.html">Modules</A> &nbsp;&middot;
<A href="functions_func.html">Members</A> &nbsp;&middot;
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1BinaryComposeFunctionAdapter.html">BinaryComposeFunctionAdapter</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classOpenMS_1_1BinaryComposeFunctionAdapter-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">BinaryComposeFunctionAdapter&lt; OP1, OP2, OP3 &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Represents the binary compose function object adapter.  
 <a href="classOpenMS_1_1BinaryComposeFunctionAdapter.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="BinaryComposeFunctionAdapter_8h_source.html">OpenMS/CONCEPT/BinaryComposeFunctionAdapter.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for BinaryComposeFunctionAdapter&lt; OP1, OP2, OP3 &gt;:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classOpenMS_1_1BinaryComposeFunctionAdapter.png" usemap="#BinaryComposeFunctionAdapter&lt; OP1, OP2, OP3 &gt;_map" alt=""/>
  <map id="BinaryComposeFunctionAdapter&lt; OP1, OP2, OP3 &gt;_map" name="BinaryComposeFunctionAdapter&lt; OP1, OP2, OP3 &gt;_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a68ef37a4f18020ae8cffb2471e95a0af"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1BinaryComposeFunctionAdapter.html#a68ef37a4f18020ae8cffb2471e95a0af">BinaryComposeFunctionAdapter</a> (const OP1 &amp;o1, const OP2 &amp;o2, const OP3 &amp;o3)</td></tr>
<tr class="memdesc:a68ef37a4f18020ae8cffb2471e95a0af"><td class="mdescLeft">&#160;</td><td class="mdescRight">constructor  <a href="#a68ef37a4f18020ae8cffb2471e95a0af">More...</a><br/></td></tr>
<tr class="separator:a68ef37a4f18020ae8cffb2471e95a0af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae61fc32bfa03306a15c6b2d10338f347"><td class="memItemLeft" align="right" valign="top">OP1::result_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1BinaryComposeFunctionAdapter.html#ae61fc32bfa03306a15c6b2d10338f347">operator()</a> (const typename OP2::argument_type &amp;x, const typename OP3::argument_type &amp;y) const </td></tr>
<tr class="memdesc:ae61fc32bfa03306a15c6b2d10338f347"><td class="mdescLeft">&#160;</td><td class="mdescRight">function call  <a href="#ae61fc32bfa03306a15c6b2d10338f347">More...</a><br/></td></tr>
<tr class="separator:ae61fc32bfa03306a15c6b2d10338f347"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:aea4fa4ca5ca92a1b17f25a85514d1f88"><td class="memItemLeft" align="right" valign="top">OP1&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1BinaryComposeFunctionAdapter.html#aea4fa4ca5ca92a1b17f25a85514d1f88">op1_</a></td></tr>
<tr class="separator:aea4fa4ca5ca92a1b17f25a85514d1f88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38729c5fa9e6b6367e49ac91e08e2f5e"><td class="memItemLeft" align="right" valign="top">OP2&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1BinaryComposeFunctionAdapter.html#a38729c5fa9e6b6367e49ac91e08e2f5e">op2_</a></td></tr>
<tr class="separator:a38729c5fa9e6b6367e49ac91e08e2f5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac01b148dee7207d128298fb209154de"><td class="memItemLeft" align="right" valign="top">OP3&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1BinaryComposeFunctionAdapter.html#aac01b148dee7207d128298fb209154de">op3_</a></td></tr>
<tr class="separator:aac01b148dee7207d128298fb209154de"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class OP1, class OP2, class OP3&gt;<br/>
class OpenMS::BinaryComposeFunctionAdapter&lt; OP1, OP2, OP3 &gt;</h3>

<p>Represents the binary compose function object adapter. </p>
<p><code>compose_f_gx_hy_t</code> compose function adapter processes the result of two unary operations that use different elements as parameters. For more details, please refer to the book "The C++ Standart Library" by Nicolay Josuttis. This class is implemented in order to reduce (substitute) the usage of user defined functors.</p>
<p>Here is the example of <code>compose_f_gx_hy_t</code> usage with <code>std::mem_ref_fun</code> function. to sort elements in container based on the certain element's property. </p>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><span class="keyword">using namespace </span>std;</div>
<div class="line"></div>
<div class="line"><span class="keyword">class </span>Element {</div>
<div class="line"><span class="keyword">public</span>:</div>
<div class="line">  Element(<span class="keyword">const</span> <span class="keywordtype">string</span>&amp; a) : _a(a) {}</div>
<div class="line">  <span class="keyword">const</span> <span class="keywordtype">string</span>&amp; getA()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _a; }</div>
<div class="line"><span class="keyword">private</span>:</div>
<div class="line">  <span class="keywordtype">string</span> _a;</div>
<div class="line">};</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">int</span> <a class="code" href="RNPxl_8C.html#a217dbf8b442f20279ea00b898af96f52">main</a>(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv) {</div>
<div class="line"></div>
<div class="line">  Element a(<span class="stringliteral">&quot;Matthias&quot;</span>), b(<span class="stringliteral">&quot;Marcel&quot;</span>), <a class="code" href="namespaceOpenMS_1_1Constants.html#a8fc6defe4e499b1b9b9c275689e44352">c</a>(<span class="stringliteral">&quot;Anton&quot;</span>), d(<span class="stringliteral">&quot;Henner&quot;</span>);</div>
<div class="line"></div>
<div class="line">  vector&lt;Element&gt; elements;</div>
<div class="line">  elements.push_back(a);</div>
<div class="line">  elements.push_back(b);</div>
<div class="line">  elements.push_back(c);</div>
<div class="line">  elements.push_back(d);</div>
<div class="line"></div>
<div class="line">  <span class="comment">// the below function sorts elements based on the &amp;Element::getA result value</span></div>
<div class="line">  sort(elements.begin(), elements.end(),</div>
<div class="line">              <a class="code" href="namespaceOpenMS.html#a71e5c86bce4ccbafc24c756049eb1cac">binaryCompose</a>(</div>
<div class="line">                      less&lt;string&gt;(),</div>
<div class="line">                      mem_fun_ref(&amp;Element::getA),</div>
<div class="line">                      mem_fun_ref(&amp;Element::getA)));</div>
<div class="line">  <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
</div><!-- fragment --><p>Copyright 1999 by Addison Wesley Longman, Inc. and Nicolai M. Josuttis. All rights reserved.</p>
<p>Permission to use, copy, modify and distribute this software for personal and educational use is hereby granted without fee, provided that the above copyright notice appears in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the names of Addison Wesley Longman or the author are not used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. Addison Wesley Longman and the author make no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.</p>
<p>ADDISON WESLEY LONGMAN AND THE AUTHOR DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ADDISON WESLEY LONGMAN OR THE AUTHOR BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a68ef37a4f18020ae8cffb2471e95a0af"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOpenMS_1_1BinaryComposeFunctionAdapter.html">BinaryComposeFunctionAdapter</a> </td>
          <td>(</td>
          <td class="paramtype">const OP1 &amp;&#160;</td>
          <td class="paramname"><em>o1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const OP2 &amp;&#160;</td>
          <td class="paramname"><em>o2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const OP3 &amp;&#160;</td>
          <td class="paramname"><em>o3</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>constructor </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae61fc32bfa03306a15c6b2d10338f347"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">OP1::result_type operator() </td>
          <td>(</td>
          <td class="paramtype">const typename OP2::argument_type &amp;&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const typename OP3::argument_type &amp;&#160;</td>
          <td class="paramname"><em>y</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>function call </p>

<p>References <a class="el" href="classOpenMS_1_1BinaryComposeFunctionAdapter.html#aea4fa4ca5ca92a1b17f25a85514d1f88">BinaryComposeFunctionAdapter&lt; OP1, OP2, OP3 &gt;::op1_</a>, <a class="el" href="classOpenMS_1_1BinaryComposeFunctionAdapter.html#a38729c5fa9e6b6367e49ac91e08e2f5e">BinaryComposeFunctionAdapter&lt; OP1, OP2, OP3 &gt;::op2_</a>, and <a class="el" href="classOpenMS_1_1BinaryComposeFunctionAdapter.html#aac01b148dee7207d128298fb209154de">BinaryComposeFunctionAdapter&lt; OP1, OP2, OP3 &gt;::op3_</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aea4fa4ca5ca92a1b17f25a85514d1f88"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">OP1 op1_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Referenced by <a class="el" href="classOpenMS_1_1BinaryComposeFunctionAdapter.html#ae61fc32bfa03306a15c6b2d10338f347">BinaryComposeFunctionAdapter&lt; OP1, OP2, OP3 &gt;::operator()()</a>.</p>

</div>
</div>
<a class="anchor" id="a38729c5fa9e6b6367e49ac91e08e2f5e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">OP2 op2_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Referenced by <a class="el" href="classOpenMS_1_1BinaryComposeFunctionAdapter.html#ae61fc32bfa03306a15c6b2d10338f347">BinaryComposeFunctionAdapter&lt; OP1, OP2, OP3 &gt;::operator()()</a>.</p>

</div>
</div>
<a class="anchor" id="aac01b148dee7207d128298fb209154de"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">OP3 op3_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Referenced by <a class="el" href="classOpenMS_1_1BinaryComposeFunctionAdapter.html#ae61fc32bfa03306a15c6b2d10338f347">BinaryComposeFunctionAdapter&lt; OP1, OP2, OP3 &gt;::operator()()</a>.</p>

</div>
</div>
</div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:28 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>