File: structOpenMS_1_1PointerComparator.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 (230 lines) | stat: -rw-r--r-- 12,218 bytes
<HTML>
<HEAD>
<TITLE>PointerComparator&lt; Cmp &gt; Struct 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="structOpenMS_1_1PointerComparator.html">PointerComparator</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#related">Related Functions</a> &#124;
<a href="structOpenMS_1_1PointerComparator-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">PointerComparator&lt; Cmp &gt; Struct Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Wrapper that takes a comparator for `something' and makes a comparator for <em>pointers</em> to `something' out of it. Normally you should use the make-function <a class="el" href="structOpenMS_1_1PointerComparator.html#aeb071107569224c672893cd945dff7fe" title="Make-function to create a PointerComparator from another comparator without the need to specify the t...">pointerComparator()</a> because then you do not need to specify the template arguments.  
 <a href="structOpenMS_1_1PointerComparator.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="ComparatorUtils_8h_source.html">OpenMS/KERNEL/ComparatorUtils.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PointerComparator&lt; Cmp &gt;:</div>
<div class="dyncontent">
 <div class="center">
  <img src="structOpenMS_1_1PointerComparator.png" usemap="#PointerComparator&lt; Cmp &gt;_map" alt=""/>
  <map id="PointerComparator&lt; Cmp &gt;_map" name="PointerComparator&lt; Cmp &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:ad5e23cd93d6c4542dda28ad4a41d0738"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PointerComparator.html#ad5e23cd93d6c4542dda28ad4a41d0738">PointerComparator</a> (<a class="el" href="structOpenMS_1_1PointerComparator.html">PointerComparator</a> const &amp;pCmp)</td></tr>
<tr class="separator:ad5e23cd93d6c4542dda28ad4a41d0738"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae11bdaed29f2767b97abc7a71098eb43"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PointerComparator.html#ae11bdaed29f2767b97abc7a71098eb43">PointerComparator</a> (Cmp const &amp;cmp=Cmp())</td></tr>
<tr class="separator:ae11bdaed29f2767b97abc7a71098eb43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8c7477711ba9cfd1e7a03e723f2f23a"><td class="memTemplParams" colspan="2">template&lt;typename T1 , typename T2 &gt; </td></tr>
<tr class="memitem:ab8c7477711ba9cfd1e7a03e723f2f23a"><td class="memTemplItemLeft" align="right" valign="top">Cmp::result_type&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PointerComparator.html#ab8c7477711ba9cfd1e7a03e723f2f23a">operator()</a> (T1 left, T2 right) const </td></tr>
<tr class="separator:ab8c7477711ba9cfd1e7a03e723f2f23a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a71a3a4d33c6922914dd7a52a00ff3d5b"><td class="memItemLeft" align="right" valign="top">Cmp const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PointerComparator.html#a71a3a4d33c6922914dd7a52a00ff3d5b">cmp_</a></td></tr>
<tr class="separator:a71a3a4d33c6922914dd7a52a00ff3d5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:aeb071107569224c672893cd945dff7fe"><td class="memTemplParams" colspan="2">template&lt;class Cmp &gt; </td></tr>
<tr class="memitem:aeb071107569224c672893cd945dff7fe"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structOpenMS_1_1PointerComparator.html">PointerComparator</a>&lt; Cmp &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1PointerComparator.html#aeb071107569224c672893cd945dff7fe">pointerComparator</a> (Cmp const &amp;cmp)</td></tr>
<tr class="memdesc:aeb071107569224c672893cd945dff7fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make-function to create a <a class="el" href="structOpenMS_1_1PointerComparator.html" title="Wrapper that takes a comparator for `something&#39; and makes a comparator for pointers to `something&#39; ou...">PointerComparator</a> from another comparator without the need to specify the template arguments.  <a href="#aeb071107569224c672893cd945dff7fe">More...</a><br/></td></tr>
<tr class="separator:aeb071107569224c672893cd945dff7fe"><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 Cmp&gt;<br/>
struct OpenMS::PointerComparator&lt; Cmp &gt;</h3>

<p>Wrapper that takes a comparator for `something' and makes a comparator for <em>pointers</em> to `something' out of it. Normally you should use the make-function <a class="el" href="structOpenMS_1_1PointerComparator.html#aeb071107569224c672893cd945dff7fe" title="Make-function to create a PointerComparator from another comparator without the need to specify the t...">pointerComparator()</a> because then you do not need to specify the template arguments. </p>
<p>This works by dereferencing the arguments (unary operator*) before comparing them. <br/>
 E.g. you can use</p>
<p><code><a class="el" href="structOpenMS_1_1PointerComparator.html#ad5e23cd93d6c4542dda28ad4a41d0738">PointerComparator&lt;Peak1D::IntensityLess&gt;</a></code> to compare <code>Peak1D*</code> in the same way as <code><a class="el" href="structOpenMS_1_1Peak1D_1_1IntensityLess.html">Peak1D::IntensityLess</a></code> works for <code><a class="el" href="classOpenMS_1_1Peak1D.html" title="A 1-dimensional raw data point or peak. ">Peak1D</a></code> . </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ad5e23cd93d6c4542dda28ad4a41d0738"></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="structOpenMS_1_1PointerComparator.html">PointerComparator</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structOpenMS_1_1PointerComparator.html">PointerComparator</a>&lt; Cmp &gt; const &amp;&#160;</td>
          <td class="paramname"><em>pCmp</em></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">

</div>
</div>
<a class="anchor" id="ae11bdaed29f2767b97abc7a71098eb43"></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="structOpenMS_1_1PointerComparator.html">PointerComparator</a> </td>
          <td>(</td>
          <td class="paramtype">Cmp const &amp;&#160;</td>
          <td class="paramname"><em>cmp</em> = <code>Cmp()</code></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">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab8c7477711ba9cfd1e7a03e723f2f23a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Cmp::result_type operator() </td>
          <td>(</td>
          <td class="paramtype">T1&#160;</td>
          <td class="paramname"><em>left</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">T2&#160;</td>
          <td class="paramname"><em>right</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>References <a class="el" href="structOpenMS_1_1PointerComparator.html#a71a3a4d33c6922914dd7a52a00ff3d5b">PointerComparator&lt; Cmp &gt;::cmp_</a>.</p>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="aeb071107569224c672893cd945dff7fe"></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="structOpenMS_1_1PointerComparator.html">PointerComparator</a>&lt; Cmp &gt; pointerComparator </td>
          <td>(</td>
          <td class="paramtype">Cmp const &amp;&#160;</td>
          <td class="paramname"><em>cmp</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Make-function to create a <a class="el" href="structOpenMS_1_1PointerComparator.html" title="Wrapper that takes a comparator for `something&#39; and makes a comparator for pointers to `something&#39; ou...">PointerComparator</a> from another comparator without the need to specify the template arguments. </p>
<p>For example, </p>
<pre>
    int i = 88, j = 99;
    if ( pointerComparator(std::less&lt;int&gt;())(&amp;i,&amp;j) )
    {
&#160;   // yes, 88 &lt; 99.
    }
    </pre> 
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a71a3a4d33c6922914dd7a52a00ff3d5b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Cmp const&amp; cmp_</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Referenced by <a class="el" href="structOpenMS_1_1PointerComparator.html#ab8c7477711ba9cfd1e7a03e723f2f23a">PointerComparator&lt; Cmp &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:31 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>