~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to doc/html/classOpenMS_1_1MapAlignmentAlgorithmSpectrumAlignment_1_1Compare.html

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2013-12-20 11:30:16 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131220113016-wre5g9bteeheq6he
Tags: 1.11.1-3
* remove version number from libbost development package names;
* ensure that AUTHORS is correctly shipped in all packages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<HTML>
 
2
<HEAD>
 
3
<TITLE>MapAlignmentAlgorithmSpectrumAlignment::Compare Class Reference</TITLE>
 
4
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
 
5
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
 
6
</HEAD>
 
7
<BODY BGCOLOR="#FFFFFF">
 
8
<A href="index.html">Home</A> &nbsp;&middot;
 
9
<A href="classes.html">Classes</A> &nbsp;&middot;
 
10
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
 
11
<A href="modules.html">Modules</A> &nbsp;&middot;
 
12
<A href="functions_func.html">Members</A> &nbsp;&middot;
 
13
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
 
14
<A href="pages.html">Related Pages</A>
 
15
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
16
<!-- Generated by Doxygen 1.8.5 -->
 
17
<div id="nav-path" class="navpath">
 
18
  <ul>
 
19
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1MapAlignmentAlgorithmSpectrumAlignment.html">MapAlignmentAlgorithmSpectrumAlignment</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1MapAlignmentAlgorithmSpectrumAlignment_1_1Compare.html">Compare</a></li>  </ul>
 
20
</div>
 
21
</div><!-- top -->
 
22
<div class="header">
 
23
  <div class="summary">
 
24
<a href="#pub-methods">Public Member Functions</a> &#124;
 
25
<a href="#pro-attribs">Protected Attributes</a> &#124;
 
26
<a href="classOpenMS_1_1MapAlignmentAlgorithmSpectrumAlignment_1_1Compare-members.html">List of all members</a>  </div>
 
27
  <div class="headertitle">
 
28
<div class="title">MapAlignmentAlgorithmSpectrumAlignment::Compare Class Reference</div>  </div>
 
29
</div><!--header-->
 
30
<div class="contents">
 
31
 
 
32
<p>innerclass necessary for using the sort algo.  
 
33
 <a href="classOpenMS_1_1MapAlignmentAlgorithmSpectrumAlignment_1_1Compare.html#details">More...</a></p>
 
34
<table class="memberdecls">
 
35
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 
36
Public Member Functions</h2></td></tr>
 
37
<tr class="memitem:a73903d9b2ec03887bcf011b913248c51"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MapAlignmentAlgorithmSpectrumAlignment_1_1Compare.html#a73903d9b2ec03887bcf011b913248c51">Compare</a> (bool b=false)</td></tr>
 
38
<tr class="memdesc:a73903d9b2ec03887bcf011b913248c51"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor with an order flag.  <a href="#a73903d9b2ec03887bcf011b913248c51">More...</a><br/></td></tr>
 
39
<tr class="separator:a73903d9b2ec03887bcf011b913248c51"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
40
<tr class="memitem:a4134b184bb1ace0daa488516a620fc8e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MapAlignmentAlgorithmSpectrumAlignment_1_1Compare.html#a4134b184bb1ace0daa488516a620fc8e">operator()</a> (const std::pair&lt; std::pair&lt; <a class="el" href="group__Concept.html#ga7cc214a236ad3bb6ad435bdcf5262a3f">Int</a>, <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a> &gt;, <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a> &gt; &amp;c1, const std::pair&lt; std::pair&lt; <a class="el" href="group__Concept.html#ga7cc214a236ad3bb6ad435bdcf5262a3f">Int</a>, <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a> &gt;, <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a> &gt; &amp;c2)</td></tr>
 
41
<tr class="memdesc:a4134b184bb1ace0daa488516a620fc8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">overloaded operator() for comparing maps of maps std::pair&lt;std::pair&lt;Int,Real&gt;,Real&gt;. If flag is false the second argument of the outer map is selected. The output is an ascending order. If the order flag is true, the first argument of the inner class is selected to get a descending oder.  <a href="#a4134b184bb1ace0daa488516a620fc8e">More...</a><br/></td></tr>
 
42
<tr class="separator:a4134b184bb1ace0daa488516a620fc8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
43
<tr class="memitem:a41a09dd2e9375b9816c28893156bfd28"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MapAlignmentAlgorithmSpectrumAlignment_1_1Compare.html#a41a09dd2e9375b9816c28893156bfd28">operator()</a> (const std::pair&lt; <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a>, <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a> &gt; &amp;c1, const std::pair&lt; <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a>, <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a> &gt; &amp;c2)</td></tr>
 
44
<tr class="memdesc:a41a09dd2e9375b9816c28893156bfd28"><td class="mdescLeft">&#160;</td><td class="mdescRight">overloaded operator() for comparing pairs of Real, Real std::pair&lt;Real,Real&gt;. If the order flag is false, an ascending order are returned else a descending. The comparison is done by the first argument of the map.  <a href="#a41a09dd2e9375b9816c28893156bfd28">More...</a><br/></td></tr>
 
45
<tr class="separator:a41a09dd2e9375b9816c28893156bfd28"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
46
</table><table class="memberdecls">
 
47
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
 
48
Protected Attributes</h2></td></tr>
 
49
<tr class="memitem:a8b3ab54ed3e81c69863d65e4e6c424a0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MapAlignmentAlgorithmSpectrumAlignment_1_1Compare.html#a8b3ab54ed3e81c69863d65e4e6c424a0">flag</a></td></tr>
 
50
<tr class="separator:a8b3ab54ed3e81c69863d65e4e6c424a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
51
</table>
 
52
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 
53
<div class="textblock"><p>innerclass necessary for using the sort algo. </p>
 
54
<p>Defines serveral overloaded operator() for using the std::sort algorithm</p>
 
55
<dl class="experimental"><dt><b><a class="el" href="experimental.html#_experimental000002">Experimental classes:</a></b></dt><dd>This algorithm is work in progress and might change.</dd></dl>
 
56
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 
57
<a class="anchor" id="a73903d9b2ec03887bcf011b913248c51"></a>
 
58
<div class="memitem">
 
59
<div class="memproto">
 
60
<table class="mlabels">
 
61
  <tr>
 
62
  <td class="mlabels-left">
 
63
      <table class="memname">
 
64
        <tr>
 
65
          <td class="memname"><a class="el" href="classOpenMS_1_1MapAlignmentAlgorithmSpectrumAlignment_1_1Compare.html">Compare</a> </td>
 
66
          <td>(</td>
 
67
          <td class="paramtype">bool&#160;</td>
 
68
          <td class="paramname"><em>b</em> = <code>false</code></td><td>)</td>
 
69
          <td></td>
 
70
        </tr>
 
71
      </table>
 
72
  </td>
 
73
  <td class="mlabels-right">
 
74
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
75
  </tr>
 
76
</table>
 
77
</div><div class="memdoc">
 
78
 
 
79
<p>Default constructor with an order flag. </p>
 
80
 
 
81
</div>
 
82
</div>
 
83
<h2 class="groupheader">Member Function Documentation</h2>
 
84
<a class="anchor" id="a4134b184bb1ace0daa488516a620fc8e"></a>
 
85
<div class="memitem">
 
86
<div class="memproto">
 
87
<table class="mlabels">
 
88
  <tr>
 
89
  <td class="mlabels-left">
 
90
      <table class="memname">
 
91
        <tr>
 
92
          <td class="memname">bool operator() </td>
 
93
          <td>(</td>
 
94
          <td class="paramtype">const std::pair&lt; std::pair&lt; <a class="el" href="group__Concept.html#ga7cc214a236ad3bb6ad435bdcf5262a3f">Int</a>, <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a> &gt;, <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a> &gt; &amp;&#160;</td>
 
95
          <td class="paramname"><em>c1</em>, </td>
 
96
        </tr>
 
97
        <tr>
 
98
          <td class="paramkey"></td>
 
99
          <td></td>
 
100
          <td class="paramtype">const std::pair&lt; std::pair&lt; <a class="el" href="group__Concept.html#ga7cc214a236ad3bb6ad435bdcf5262a3f">Int</a>, <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a> &gt;, <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a> &gt; &amp;&#160;</td>
 
101
          <td class="paramname"><em>c2</em>&#160;</td>
 
102
        </tr>
 
103
        <tr>
 
104
          <td></td>
 
105
          <td>)</td>
 
106
          <td></td><td></td>
 
107
        </tr>
 
108
      </table>
 
109
  </td>
 
110
  <td class="mlabels-right">
 
111
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
112
  </tr>
 
113
</table>
 
114
</div><div class="memdoc">
 
115
 
 
116
<p>overloaded operator() for comparing maps of maps std::pair&lt;std::pair&lt;Int,Real&gt;,Real&gt;. If flag is false the second argument of the outer map is selected. The output is an ascending order. If the order flag is true, the first argument of the inner class is selected to get a descending oder. </p>
 
117
 
 
118
</div>
 
119
</div>
 
120
<a class="anchor" id="a41a09dd2e9375b9816c28893156bfd28"></a>
 
121
<div class="memitem">
 
122
<div class="memproto">
 
123
<table class="mlabels">
 
124
  <tr>
 
125
  <td class="mlabels-left">
 
126
      <table class="memname">
 
127
        <tr>
 
128
          <td class="memname">bool operator() </td>
 
129
          <td>(</td>
 
130
          <td class="paramtype">const std::pair&lt; <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a>, <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a> &gt; &amp;&#160;</td>
 
131
          <td class="paramname"><em>c1</em>, </td>
 
132
        </tr>
 
133
        <tr>
 
134
          <td class="paramkey"></td>
 
135
          <td></td>
 
136
          <td class="paramtype">const std::pair&lt; <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a>, <a class="el" href="group__Concept.html#gab685845059e8a2c92743427d9a698c70">Real</a> &gt; &amp;&#160;</td>
 
137
          <td class="paramname"><em>c2</em>&#160;</td>
 
138
        </tr>
 
139
        <tr>
 
140
          <td></td>
 
141
          <td>)</td>
 
142
          <td></td><td></td>
 
143
        </tr>
 
144
      </table>
 
145
  </td>
 
146
  <td class="mlabels-right">
 
147
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
148
  </tr>
 
149
</table>
 
150
</div><div class="memdoc">
 
151
 
 
152
<p>overloaded operator() for comparing pairs of Real, Real std::pair&lt;Real,Real&gt;. If the order flag is false, an ascending order are returned else a descending. The comparison is done by the first argument of the map. </p>
 
153
 
 
154
</div>
 
155
</div>
 
156
<h2 class="groupheader">Member Data Documentation</h2>
 
157
<a class="anchor" id="a8b3ab54ed3e81c69863d65e4e6c424a0"></a>
 
158
<div class="memitem">
 
159
<div class="memproto">
 
160
<table class="mlabels">
 
161
  <tr>
 
162
  <td class="mlabels-left">
 
163
      <table class="memname">
 
164
        <tr>
 
165
          <td class="memname">bool flag</td>
 
166
        </tr>
 
167
      </table>
 
168
  </td>
 
169
  <td class="mlabels-right">
 
170
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
171
  </tr>
 
172
</table>
 
173
</div><div class="memdoc">
 
174
 
 
175
</div>
 
176
</div>
 
177
</div><!-- contents -->
 
178
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
179
<TABLE width="100%" border="0">
 
180
<TR>
 
181
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
182
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:26 using doxygen 1.8.5</font></TD>
 
183
</TR>
 
184
</TABLE>
 
185
</BODY>
 
186
</HTML>