File: structOpenMS_1_1LexicographicComparator.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 (241 lines) | stat: -rw-r--r-- 12,932 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
<HTML>
<HEAD>
<TITLE>LexicographicComparator&lt; Cmp1, Cmp2 &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_1LexicographicComparator.html">LexicographicComparator</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_1LexicographicComparator-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">LexicographicComparator&lt; Cmp1, Cmp2 &gt; Struct Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A wrapper class that combines two comparators lexicographically. Normally you should use the make-function <a class="el" href="structOpenMS_1_1LexicographicComparator.html#ac4e734db514973176bfe65e0fa9905ae" title="Make-function to create a LexicographicComparator from two other comparators without the need to spec...">lexicographicComparator()</a> because then you do not need to specify the template arguments.  
 <a href="structOpenMS_1_1LexicographicComparator.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 LexicographicComparator&lt; Cmp1, Cmp2 &gt;:</div>
<div class="dyncontent">
 <div class="center">
  <img src="structOpenMS_1_1LexicographicComparator.png" usemap="#LexicographicComparator&lt; Cmp1, Cmp2 &gt;_map" alt=""/>
  <map id="LexicographicComparator&lt; Cmp1, Cmp2 &gt;_map" name="LexicographicComparator&lt; Cmp1, Cmp2 &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:ae666c2289c531cf9255859e3f1115a95"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1LexicographicComparator.html#ae666c2289c531cf9255859e3f1115a95">LexicographicComparator</a> (Cmp1 const &amp;cmp1=Cmp1(), Cmp2 const &amp;cmp2=Cmp2())</td></tr>
<tr class="separator:ae666c2289c531cf9255859e3f1115a95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5028aa50304fa5a39d800f3ed86e4ee"><td class="memTemplParams" colspan="2">template&lt;typename T1 , typename T2 &gt; </td></tr>
<tr class="memitem:ab5028aa50304fa5a39d800f3ed86e4ee"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1LexicographicComparator.html#ab5028aa50304fa5a39d800f3ed86e4ee">operator()</a> (T1 left, T2 right) const </td></tr>
<tr class="separator:ab5028aa50304fa5a39d800f3ed86e4ee"><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:a15e52ecef03046172ffd9e2fc5e6b49a"><td class="memItemLeft" align="right" valign="top">Cmp1 const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1LexicographicComparator.html#a15e52ecef03046172ffd9e2fc5e6b49a">cmp1_</a></td></tr>
<tr class="separator:a15e52ecef03046172ffd9e2fc5e6b49a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a397f3db258acfbbfd044d5949af8cd27"><td class="memItemLeft" align="right" valign="top">Cmp2 const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1LexicographicComparator.html#a397f3db258acfbbfd044d5949af8cd27">cmp2_</a></td></tr>
<tr class="separator:a397f3db258acfbbfd044d5949af8cd27"><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:ac4e734db514973176bfe65e0fa9905ae"><td class="memTemplParams" colspan="2">template&lt;typename Cmp1 , typename Cmp2 &gt; </td></tr>
<tr class="memitem:ac4e734db514973176bfe65e0fa9905ae"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="structOpenMS_1_1LexicographicComparator.html">LexicographicComparator</a>&lt; Cmp1, <br class="typebreak"/>
Cmp2 &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1LexicographicComparator.html#ac4e734db514973176bfe65e0fa9905ae">lexicographicComparator</a> (Cmp1 const &amp;cmp1, Cmp2 const &amp;cmp2)</td></tr>
<tr class="memdesc:ac4e734db514973176bfe65e0fa9905ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make-function to create a <a class="el" href="structOpenMS_1_1LexicographicComparator.html" title="A wrapper class that combines two comparators lexicographically. Normally you should use the make-fun...">LexicographicComparator</a> from two other comparators without the need to specify the template arguments.  <a href="#ac4e734db514973176bfe65e0fa9905ae">More...</a><br/></td></tr>
<tr class="separator:ac4e734db514973176bfe65e0fa9905ae"><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;typename Cmp1, typename Cmp2&gt;<br/>
struct OpenMS::LexicographicComparator&lt; Cmp1, Cmp2 &gt;</h3>

<p>A wrapper class that combines two comparators lexicographically. Normally you should use the make-function <a class="el" href="structOpenMS_1_1LexicographicComparator.html#ac4e734db514973176bfe65e0fa9905ae" title="Make-function to create a LexicographicComparator from two other comparators without the need to spec...">lexicographicComparator()</a> because then you do not need to specify the template arguments. </p>
<p>Both comparators should of course have the same argument types. The result_type is bool, that is, we perform a two-way comparison like <code>less&lt;&gt;</code> and its relatives. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae666c2289c531cf9255859e3f1115a95"></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_1LexicographicComparator.html">LexicographicComparator</a> </td>
          <td>(</td>
          <td class="paramtype">Cmp1 const &amp;&#160;</td>
          <td class="paramname"><em>cmp1</em> = <code>Cmp1()</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Cmp2 const &amp;&#160;</td>
          <td class="paramname"><em>cmp2</em> = <code>Cmp2()</code>&#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">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab5028aa50304fa5a39d800f3ed86e4ee"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool 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_1LexicographicComparator.html#a15e52ecef03046172ffd9e2fc5e6b49a">LexicographicComparator&lt; Cmp1, Cmp2 &gt;::cmp1_</a>, and <a class="el" href="structOpenMS_1_1LexicographicComparator.html#a397f3db258acfbbfd044d5949af8cd27">LexicographicComparator&lt; Cmp1, Cmp2 &gt;::cmp2_</a>.</p>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="ac4e734db514973176bfe65e0fa9905ae"></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_1LexicographicComparator.html">LexicographicComparator</a>&lt; Cmp1, Cmp2 &gt; lexicographicComparator </td>
          <td>(</td>
          <td class="paramtype">Cmp1 const &amp;&#160;</td>
          <td class="paramname"><em>cmp1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Cmp2 const &amp;&#160;</td>
          <td class="paramname"><em>cmp2</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">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Make-function to create a <a class="el" href="structOpenMS_1_1LexicographicComparator.html" title="A wrapper class that combines two comparators lexicographically. Normally you should use the make-fun...">LexicographicComparator</a> from two other comparators without the need to specify the template arguments. </p>
<p>The usage is similar to <a class="el" href="namespaceOpenMS.html#aeb071107569224c672893cd945dff7fe" title="Make-function to create a PointerComparator from another comparator without the need to specify the t...">pointerComparator()</a> or <a class="el" href="namespaceOpenMS.html#a74e80d32be63268d8a46039297e18cc6" title="Make-function to create a ReverseComparator from another comparator without the need to specify the t...">reverseComparator()</a>, which see. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a15e52ecef03046172ffd9e2fc5e6b49a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Cmp1 const&amp; cmp1_</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_1LexicographicComparator.html#ab5028aa50304fa5a39d800f3ed86e4ee">LexicographicComparator&lt; Cmp1, Cmp2 &gt;::operator()()</a>.</p>

</div>
</div>
<a class="anchor" id="a397f3db258acfbbfd044d5949af8cd27"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Cmp2 const&amp; cmp2_</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_1LexicographicComparator.html#ab5028aa50304fa5a39d800f3ed86e4ee">LexicographicComparator&lt; Cmp1, Cmp2 &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>